-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Project import generated by Copybara.
GitOrigin-RevId: 2608c134d1bd8b8752b186fdca9da392d77b9939
- Loading branch information
Showing
15 changed files
with
1,006 additions
and
577 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,96 +1,115 @@ | ||
# nbictl -- NBI command-line tool | ||
<!-- | ||
This file is autogenerated! Do not edit by hand! | ||
Run `nbictl readme > README.md` to update it. | ||
--> | ||
|
||
`nbctl` allows you to interact with the Spacetime NBI APIs from the command-line. | ||
# NAME | ||
|
||
## Usage: | ||
nbictl - Interact with the Spacetime NBI service from the command line. | ||
|
||
```sh | ||
$ nbictl <action> [--operation-specific-flags] | ||
``` | ||
|
||
### Configuration actions | ||
# SYNOPSIS | ||
|
||
#### generate-keys | ||
``` | ||
Usage of nbictl generate-key: | ||
-country string | ||
country of certificate | ||
-dir string | ||
directory where you want your RSA keys to be stored. Default: ~/.nbictl/ | ||
-location string | ||
location of certificate | ||
-org string | ||
[REQUIRED] organization of certificate | ||
-state string | ||
state of certificate | ||
nbictl [--context=value] [--help] [-h] <command> [COMMAND OPTIONS] [ARGUMENTS...] | ||
``` | ||
|
||
> **Note** | ||
> After creating the Private-Public keypair, you will need to request API access by | ||
> sharing the `.crt` file (a self-signed x509 certificate containing the public key) with | ||
> Aalyria to receive the `USER_ID` and a `KEY_ID` needed to complete the `nbictl` configuration. | ||
# GLOBAL OPTIONS | ||
|
||
> **Warning** | ||
> Only share the public certificate (`.crt`) with Aalyria or third-parties. | ||
> The private key (`.key`) must be protected and should never be sent by email | ||
> or communicated to others in any. | ||
**--context**="": Context (configuration profile) to reference for connection settings. | ||
|
||
#### set-context | ||
**--help, -h**: show help | ||
|
||
You can create multiple contexts by specifying a name of context using `--context` flag. | ||
If context name is not specified, the context will have name `DEFAULT`. | ||
# COMMANDS | ||
|
||
``` | ||
Usage of nbictl set-context: | ||
-context string | ||
context of NBI API environment (default "DEFAULT") | ||
-key_id string | ||
key id associated with the provate key provided by Aalyria | ||
-priv_key string | ||
path to your private key for authentication to NBI API | ||
-transport_security string | ||
transport security to use when connecting to NBI. Values: insecure, system_cert_pool | ||
-url string | ||
url of NBI endpoint | ||
-user_id string | ||
user id address associated with the private key provided by Aalyria | ||
``` | ||
## create | ||
|
||
### NBI actions | ||
Create one or more entities described in textproto files. | ||
|
||
**--files, -f**="": [REQUIRED] Glob of textproto files that represent one or more Entity messages. | ||
|
||
## update | ||
|
||
Updates one or more entities described in textproto files. | ||
|
||
**--files, -f**="": [REQUIRED] Glob of textproto files that represent one or more Entity messages. | ||
|
||
## list | ||
|
||
Lists all entities of a given type. | ||
|
||
**--type, -t**="": [REQUIRED] Type of entities to query. Allowed values: [ANTENNA_PATTERN, BAND_PROFILE, CDPI_STREAM_INFO, COMPUTED_MOTION, DEVICES_IN_REGION, DRAIN_PROVISION, INTENT, INTERFACE_LINK_REPORT, INTERFERENCE_CONSTRAINT, MOTION_DEFINITION, NETWORK_NODE, NETWORK_STATS_REPORT, PLATFORM_DEFINITION, PROPAGATION_WEATHER, SERVICE_REQUEST, STATION_SET, SURFACE_REGION, TRANSCEIVER_LINK_REPORT] | ||
|
||
## delete | ||
|
||
Deletes the entity with the given type and ID. | ||
|
||
**--id**="": [REQUIRED] ID of entity to delete. | ||
|
||
**--timestamp, --commit_time**="": [REQUIRED] Commit timestamp of entity to delete. (default: 0) | ||
|
||
**--type, -t**="": [REQUIRED] Type of entity to delete. Allowed values: [ANTENNA_PATTERN, BAND_PROFILE, CDPI_STREAM_INFO, COMPUTED_MOTION, DEVICES_IN_REGION, DRAIN_PROVISION, INTENT, INTERFACE_LINK_REPORT, INTERFERENCE_CONSTRAINT, MOTION_DEFINITION, NETWORK_NODE, NETWORK_STATS_REPORT, PLATFORM_DEFINITION, PROPAGATION_WEATHER, SERVICE_REQUEST, STATION_SET, SURFACE_REGION, TRANSCEIVER_LINK_REPORT] | ||
|
||
## get-link-budget | ||
|
||
Gets link budget details | ||
|
||
**--analysis_end_timestamp**="": An RFC3339 formatted timestamp for the end of the interval to evaluate the signal propagation. If unset, the signal propagation is evaluated at the instant of the `analysis_start_timestamp.` | ||
|
||
**--analysis_start_timestamp**="": An RFC3339 formatted timestamp for the beginning of the interval to evaluate the signal propagation. Defaults to the current local timestamp. | ||
|
||
**--band_profile_id**="": The Entity ID of the BandProfile used for this link. | ||
|
||
**--explain_inaccessibility**: If true, the server will spend additional computational time determining the specific set of access constraints that were not satisfied and including these reasons in the response. | ||
|
||
**--input_file**="": A path to a textproto file containing a SignalPropagationRequest message. If set, it will be used as the request to the SignalPropagation service. If unset, the request will be built from the other flags. | ||
|
||
**--output_file**="": Path to a textproto file to write the response. If unset, defaults to stdout. (default: /dev/stdout) | ||
|
||
**--reference_data_timestamp**="": An RFC3339 formatted timestamp for the instant at which to reference the versions of the platforms. Defaults to `analysis_start_timestamp`. (default: analysis_start_timestamp) | ||
|
||
**--spatial_propagation_step_size**="": The analysis step size for spatial propagation metrics. (default: 1m) | ||
|
||
**--step_size**="": The analysis step size and the temporal resolution of the response. (default: 1m) | ||
|
||
**--target_platform_id**="": The Entity ID of the PlatformDefinition that represents the target. Leave unset if the antenna is fixed or non-steerable, in which case coverage calculations will be returned. | ||
|
||
**--target_transceiver_model_id**="": The ID of the transceiver model on the target.Leave unset if the antenna is fixed or non-steerable, in which case coverage calculations will be returned. | ||
|
||
**--tx_platform_id**="": The Entity ID of the PlatformDefinition that represents the transmitter. | ||
|
||
**--tx_transceiver_model_id**="": The ID of the transceiver model on the transmitter. | ||
|
||
## generate-keys | ||
|
||
Generate RSA keys to use for authentication with the Spacetime APIs. | ||
|
||
>After creating the Private-Public keypair, you will need to request API access by sharing the `.crt` file (a self-signed x509 certificate containing the public key) with Aalyria to receive the `USER_ID` and a `KEY_ID` needed to complete the nbictl configuration. Only share the public certificate (`.crt`) with Aalyria or third-parties. The private key (`.key`) must be protected and should never be sent by email or communicated to others. | ||
**--country**="": Country of certificate. | ||
|
||
**--dir, --directory**="": Directory to store the generated RSA keys in. (default: ~/.config/nbictl/keys) | ||
|
||
**--location**="": Location of certificate. | ||
|
||
**--org, --organization**="": [REQUIRED] Organization of certificate. | ||
|
||
**--state**="": State of certificate. | ||
|
||
## set-config | ||
|
||
Sets or updates a configuration profile that contains NBI connection settings. You can create multiple configs by specifying the name of the configuration using the `--context` flag (defaults to "DEFAULT"). | ||
|
||
**--key_id**="": Key ID associated with the private key provided by Aalyria. | ||
|
||
**--priv_key**="": Path to the private key to use for authentication. | ||
|
||
**--transport_security**="": Transport security to use when connecting to the NBI service. Allowed values: [insecure, system_cert_pool] | ||
|
||
**--url**="": URL of the NBI endpoint. | ||
|
||
**--user_id**="": User ID associated with the private key provided by Aalyria. | ||
|
||
## help, h | ||
|
||
Shows a list of commands or help for one command | ||
|
||
#### create | ||
``` | ||
Usage of nbictl create: | ||
-context string | ||
name of context you want to use | ||
-files path | ||
[REQUIRED] a path to the textproto file containing information of the entity you want to create | ||
``` | ||
#### update | ||
``` | ||
Usage of nbictl update: | ||
-context string | ||
name of context you want to use | ||
-files path | ||
[REQUIRED] a path to the textproto file containing information of the entity you want to update | ||
``` | ||
#### delete | ||
``` | ||
Usage of nbictl delete: | ||
-commit_time int | ||
[REQUIRED] commit timestamp of the entity you want to delete (default -1) | ||
-context string | ||
name of context you want to use | ||
-id string | ||
[REQUIRED] the id of the entity you want to delete | ||
-type string | ||
[REQUIRED] type of entities you want to delete. list of possible types: [STATION_SET NETWORK_NODE CDPI_STREAM_INFO DRAIN_PROVISION INTENT INTERFACE_LINK_REPORT MOTION_DEFINITION NETWORK_STATS_REPORT BAND_PROFILE COMPUTED_MOTION TRANSCEIVER_LINK_REPORT ANTENNA_PATTERN PLATFORM_DEFINITION INTERFERENCE_CONSTRAINT PROPAGATION_WEATHER SERVICE_REQUEST DEVICES_IN_REGION SURFACE_REGION] | ||
``` | ||
#### list | ||
``` | ||
Usage of nbictl list: | ||
-context string | ||
name of context you want to use | ||
-type string | ||
[REQUIRED] type of entities you want to query. list of possible types: [DEVICES_IN_REGION NETWORK_STATS_REPORT PLATFORM_DEFINITION PROPAGATION_WEATHER SERVICE_REQUEST COMPUTED_MOTION ANTENNA_PATTERN BAND_PROFILE INTENT NETWORK_NODE TRANSCEIVER_LINK_REPORT CDPI_STREAM_INFO STATION_SET SURFACE_REGION DRAIN_PROVISION INTERFACE_LINK_REPORT INTERFERENCE_CONSTRAINT MOTION_DEFINITION] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.