Overview
The EWB Network Server provides API access for operating on an EWB Network.
This document describes how to configure and run the EWB Network Server
Command Line Options
Configuration options for the EWB Network Server are provided as command line arguments.
| Usage | Description | Required | Default |
|---|---|---|---|
-auth, --patch-auth-header <AUTH_HEADER> | The HTTP auth header to use with the patch server | No | None |
-c, --current-date <DATE> | The date to use as the current date | No | Current Date |
-cors, --cors <CORS_DEFINITION> | Set the cors definition | No | 0 |
-cpi, --connection-point-identifier <IDENTIFIER> | Specifies the connection point identifier to use | No | NMI |
-dc,--disable-customers | Disables the loading of customers. | No | false |
-debug, --debug-routing <FILE> | Enable route debugging. Request bodies will be saved to the specified file | No | None |
-dsc,--days-to-search-customer <NUM_DAYS_CUSTOMER> | The number of days prior to the network database being loaded to search for a customers database in the EWB data root. | No | 0 |
-dsd,--days-to-search-diagram <NUM_DAYS_DIAGRAM> | The number of days prior to the network database being loaded to search for a diagrams database in the EWB data root. | No | 0 |
-dsn,--days-to-search-network <NUM_DAYS_NETWORK> | The number of days to search for a network database in the EWB data root. | No | 0 |
-e, --ewb-data-root <DIRECTORY> | The directory of the EWB data root | Yes | |
-ga, --grpc-auth <CLIENT_AUTH> <TRUST_PATH> | CLIENT_AUTH controls the client authentication requirements (OPTIONAL/REQUIRE). TRUST_PATH specifies the path to the trusted certificate for verifying the remote endpoint's certificate | No | None |
-gp, --grpc-port <PORT> | The port number for the gRPC server | Yes | |
-gt, --grpc-tls <CERT_PATH> <KEY_PATH> | CERT_PATH specifies the path to the certificate to use, and KEY_PATH specifies the path to the private key for the certificate. | No | None |
-h, --help | Shows the help message | No | |
-nd,--network-date <NETWORK_DATE> | Specify an exact network-model to load rather than using the newest model available. | No | Latest available model |
-o, --output <FILE> | The network build status file (including path) | No | ewb-network-server-status.json |
-p, --port <PORT> | The port number the REST API will listen on. | Yes | |
-pa, --patch-api <API_ENDPOINT> | The patch server end point (including server, port and url) | No | None |
-s3, --s3-bucket <BUCKET> | The AWS S3 bucket name to create the output in. If specified, the default S3 connection will be used | No | None |
-t, --timeout <SECONDS> | The timeout (in seconds) for receiving data from the patch API. Zero to disable | No | 60 |