3.2.17. adapters cnx delete-by-id¶
This command will delete a connection from an adapter on a node.
3.2.17.1. Input feeds¶
The input to this command as –rows must be from one of these commands:
adapters get: Supplying input from this command will delete ALL of the connections for ALL of the adapters returned from this command.
adapters cnx get: Supplying input from this command will delete all of the connections that have been returned by the supplied filters.
See also
adapters cnx get for examples of filtering connections using axonshell adapters get | axonshell adapters cnx get.
3.2.17.2. 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.17.3. Examples¶
3.2.17.4. Help Page¶
3.2.17.4.1. axonshell adapters cnx delete¶
Delete a connection by ID.
axonshell adapters cnx delete [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
- -de, --delete-entities, -nde, --no-delete-entities¶
When deleting connection, also remove all assets created by connection.
- Default:
False
- -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
- -i, --id <cnx_id>¶
Required ID of connection