3.2.21. adapters cnx test-by-id¶
Warning
This API is deprecated.
Axonius API v2 is now available, we recommend you move to API v2.
New features will no longer be added to this API. Axonius will only provide bug fixes.
This command will trigger a test_by_id (aka fetch) for a connection of an adapter on a node.
3.2.21.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.
Rows Option for examples of working with input feeds.
3.2.21.2. Examples¶
3.2.21.3. Help Page¶
3.2.21.3.1. axonshell adapters cnx test-by-id¶
Test reachability for an existing connection by ID.
axonshell adapters cnx test-by-id [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
- -i, --id <cnx_id>¶
Required ID of connection
- -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