3.2.15. adapters cnx add¶
This command will add a new connection for an adapter on a node.
3.2.15.1. Common Options¶
Connection Options for examples of supplying the Axonius credentials and URL.
Export Options for examples of exporting data in different formats and outputs.
3.2.15.2. Examples¶
3.2.15.3. Help Page¶
3.2.15.3.1. axonshell adapters cnx add¶
Add a connection from prompts or arguments.
axonshell adapters cnx add [OPTIONS]
Options
- -u, --url <URL>¶
Required URL of an Axonius instance
- -k, --key <KEY>¶
Required API Key (or username if credentials=True) of user in an Axonius instance
- -s, --secret <SECRET>¶
Required API Secret (or password if credentials=True) of user in an Axonius instance
- -tn, --tunnel <tunnel>¶
Tunnel ID or Name
- -nn, --node-name <adapter_node>¶
Node name (will default to core instance if not supplied)
- -n, --name <adapter_name>¶
Required Adapter name
- --active, --inactive¶
Set connection as active / inactive.
- Default
True
- -saf, --save-and-fetch, -nsaf, --no-save-and-fetch¶
Fetch assets after saving.
- Default
True
- --show-schemas, --no-show-schemas¶
Print the schemas and exit.
- Default
False
- --show-defaults, --no-show-defaults¶
Print the schema defaults and sane defaults and exit.
- Default
False
- -po, --prompt-optional, -npo, --no-prompt-optional¶
Prompt for optional items that are not supplied.
- Default
True
- -pd, --prompt-default, -npd, --no-prompt-default¶
Prompt for items that have a default.
- Default
True
- -usd, --use-sane-defaults, -nusd, --no-use-sane-defaults¶
Use sane defaults from API Client (will use False as default for boolean types).
- Default
True
- -iu, --ignore-unknowns, -niu, --no-ignore-unknowns¶
Do not error if unknown config keys supplied.
- Default
False
- -cl, --connection-label <connection_label>¶
Connection label to assign
- -c, --config <config>¶
Configuration in the form of key=value (value as USE_DEFAULT to use the default value) (multiples)
- -xf, --export-format <export_format>¶
Format of to export data in
- Default
table- Options
json-full | json-config | json | table | table-schemas | str | str-args