3.2.20. adapters cnx test

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.

Read about API v2

This command will trigger a test (aka fetch) for a connection of an adapter on a node.

3.2.20.1. Common Options

3.2.20.2. Examples

3.2.20.3. Help Page

3.2.20.3.1. axonshell adapters cnx test

Test reachability for an adapter from prompts or arguments.

axonshell adapters cnx test [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

--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

-c, --config <config>

Configuration in the form of key=value (value as USE_DEFAULT to use the default value) (multiples)