4.3.2. Connections¶

API for working with adapter connections.

class axonius_api_client.api.adapters.cnx.Cnx(parent)[source]¶

Bases: axonius_api_client.api.mixins.ChildMixins

API model for working with adapter connections.

Examples

Create a client using axonius_api_client.connect.Connect

Add a connection: add()
Get all connections for an adapter: get_by_adapter()
Get a connection for an adapter by UUID: get_by_uuid()
Get a connection for an adapter by connection label: get_by_label()
Get a connection for an adapter by ID: get_by_id()
Update a connection for an adapter by ID: update_by_id()
Delete a connection for an adapter by ID: delete_by_id()
Test a connections parameters for an adapter without creating the connection: test()
Work with adapters axonius_api_client.api.adapters.adapters.Adapters

Notes

All methods use the Core instance by default, but you can work with another instance by passing the name of the instance to adapter_node.

Supplying unknown keys/values for configurations will throw an error showing the valid keys/values.

Parameters: parent (axonius_api_client.api.mixins.Model) –

add(adapter_name, adapter_node=None, save_and_fetch=True, active=True, connection_label=None, kwargs_config=None, **kwargs)[source]¶

Add a connection to an adapter on a node.

Examples

First, create a client using axonius_api_client.connect.Connect.

Establish a connection dictionary

>>> config = dict(
...     dc_name="192.168.1.10",
...     user="svc_user",
...     password="test",
...     do_not_fetch_users=False,
...     fetch_disabled_users=False,
...     fetch_disabled_devices=False,
...     is_ad_gc=False,
... )

Add a connection for an adapter to the Core instance

>>> cnx = client.adapters.cnx.add(adapter_name="active_directory", **config)

Parameters

adapter_name (str) – name of adapter
adapter_node (typing.Optional[str]) – name of node running adapter
**kwargs – configuration of new connection
save_and_fetch (bool) –
active (bool) –
connection_label (typing.Optional[str]) –
kwargs_config (typing.Optional[dict]) –

Raises

CnxAddError – when an error happens while adding the connection

Return type

dict

get_by_adapter(adapter_name, adapter_node=None)[source]¶

Get all connections of an adapter on a node.

Examples

First, create a client using axonius_api_client.connect.Connect.

Get all connections for an adapter on the Core instance

>>> cnxs = client.adapters.cnx.get_by_adapter(adapter_name="active_directory")

Parameters

adapter_name (str) – name of adapter
adapter_node (typing.Optional[str]) – name of node running adapter

Return type

typing.List[dict]

get_by_uuid(cnx_uuid, adapter_name, adapter_node=None, **kwargs)[source]¶

Get a connection for an adapter on a node by UUID.

Examples

First, create a client using axonius_api_client.connect.Connect.

Get a single connection by UUID

>>> cnx = client.adapters.cnx.get_by_uuid(
...     cnx_id='5f76735be4557d5cba94237f', adapter_name='aws'
... )

Notes

UUID of connections change when a connection configuration is updated, the more persistent way to get a connection is get_by_id().

Parameters

cnx_uuid (str) – UUID to search for
adapter_name (str) – name of adapter
adapter_node (typing.Optional[str]) – name of node running adapter
**kwargs – passed to get_by_key()

Return type

dict

get_by_label(value, adapter_name, adapter_node=None)[source]¶

Get a connection for an adapter on a node using a specific connection identifier key.

Examples

First, create a client using axonius_api_client.connect.Connect.

Get a single connection by connection label

>>> cnx = client.adapters.cnx.get_by_label(
...     value='test label', adapter_name='active_directory'
... )

Parameters

value (str) – value that connection_label must match for a connection
adapter_name (str) – name of adapter
adapter_node (typing.Optional[str]) – name of node running adapter

Raises

NotFoundError – when no connections found with supplied connection label

Return type

dict

get_by_id(cnx_id, adapter_name, adapter_node=None, **kwargs)[source]¶

Get a connection for an adapter on a node by ID.

Examples

First, create a client using axonius_api_client.connect.Connect.

Get a single connection by ID

>>> cnx = client.adapters.cnx.get_by_id(
...     cnx_id='192.168.1.10', adapter_name='active_directory'
... )

Notes

ID is constructed from some variance of connection keys, usually “domain” (i.e. for active_directory TestDomain.test)

Parameters

cnx_id (str) – connection ID to get
adapter_name (str) – name of adapter
adapter_node (typing.Optional[str]) – name of node running adapter
**kwargs – passed to get_by_key()

Return type

dict

update_by_id(cnx_id, adapter_name, adapter_node=None, **kwargs)[source]¶

Update a connection for an adapter on a node by ID.

Examples

First, create a client using axonius_api_client.connect.Connect.

Change the connection label for a connection

>>> cnx = client.adapters.cnx.update_by_id(
...     cnx_id='TestDomain.test',
...     adapter_name='active_directory',
...     connection_label="new label",
... )

Parameters

cnx_id (str) – connection ID to update
adapter_name (str) – name of adapter
adapter_node (typing.Optional[str]) – name of node running adapter
**kwargs – passed to update_cnx()

Return type

dict

delete_by_id(cnx_id, adapter_name, adapter_node=None, delete_entities=False)[source]¶

Delete a connection for an adapter on a node by connection ID.

Examples

First, create a client using axonius_api_client.connect.Connect.

Delete a connection by ID

>>> cnx = client.adapters.cnx.delete_by_id(
...     cnx_id='192.168.1.10', adapter_name='active_directory'
... )

Parameters

cnx_id (str) – connection ID to delete
adapter_name (str) – name of adapter
adapter_node (typing.Optional[str]) – name of node running adapter
delete_entities (bool) – delete all asset entities associated with this connection

Return type

str

test_by_id(**kwargs)[source]¶

Test a connection for an adapter on a node by ID.

Examples

First, create a client using axonius_api_client.connect.Connect.

Test the reachability of a connection by ID

>>> cnx = client.adapters.cnx.test_by_id(
...     cnx_id='192.168.1.10', adapter_name='active_directory'
... )

Parameters: **kwargs – passed to get_by_id()
Return type: bool

test(adapter_name, adapter_node=None, kwargs_config=None, **kwargs)[source]¶

Test a connection to an adapter on a node.

Examples

First, create a client using axonius_api_client.connect.Connect.

Test the reachability of a connection without creating the connection

>>> config = dict(dc_name="192.168.1.10", user="svc_user", password="test")
>>> cnx = client.adapters.cnx.test(adapter_name="active_directory", **config)

Notes

This can be used to test the configuration of a connection before creating the connection. Usually you need just whatever configuration keys are related to hostname/domain/ip address to test a connection.

Parameters

adapter_name (str) – name of adapter
adapter_node (typing.Optional[str]) – name of node running adapter
old_config – old connection configuration
**kwargs – configuration of connection to test
kwargs_config (typing.Optional[dict]) –

Raises

CnxTestError – When a connection test fails
ConfigRequired – When not enough arguments are supplied to test the connection

Return type

bool

test_cnx(cnx_test, **kwargs)[source]¶

Test a connection for an adapter on a node.

Parameters

cnx_test (dict) – connection fetched previously
**kwargs – passed to test()

Return type

bool

set_cnx_active(cnx, value, save_and_fetch=False)[source]¶

Pass.

Parameters

cnx (dict) –
value (bool) –
save_and_fetch (bool) –

set_cnx_label(cnx, value, save_and_fetch=False)[source]¶

Pass.

Parameters

cnx (dict) –
value (str) –
save_and_fetch (bool) –

update_cnx(cnx_update, save_and_fetch=True, kwargs_config=None, **kwargs)[source]¶

Update a connection for an adapter on a node.

Parameters

cnx_update (dict) – connection fetched previously
**kwargs – configuration of connection to update
save_and_fetch (bool) –
kwargs_config (typing.Optional[dict]) –

Raises

CnxUpdateError – When an error occurs while updating the connection

Return type

dict

delete_cnx(cnx_delete, delete_entities=False)[source]¶

Delete a connection for an adapter on a node.

Parameters

cnx_delete (dict) – connection fetched previously
delete_entities (bool) – delete all asset entities associated with this connection

Return type

str

build_config(cnx_schemas, new_config, source, adapter_name, adapter_node, old_config=None)[source]¶

Build and parse a configuration for a connection.

Parameters

cnx_schemas (typing.List[dict]) – configuration schemas for connection
new_config (dict) – new configuration for connection
source (str) – description of what called this method
adapter_name (str) – name of adapter
adapter_node (str) – name of node running adapter
old_config (typing.Optional[dict]) – configuration that is being updated

Return type

dict

get_sane_defaults(adapter_name)[source]¶

Get the API client defined sane defaults for a specific adapter.

Parameters: adapter_name (str) – name of adapter
Return type: dict

cb_file_upload(value, schema, callbacks, source)[source]¶

Config parsing callback to upload a file for a connection.

Parameters

value (typing.Union[str, pathlib.Path, dict]) – file to upload
schema (dict) – connection configuration schema of type “file”
callbacks (dict) – callbacks supplied
source (str) – description of what called this method

Raises

ConfigInvalidValue – When value is a path that does not exist, or a dictionary that does not have ‘uuid’ and ‘filename’ keys’, or if value is not a file

Return type

dict

_get_gone_hook(cid, uuid, adapter, node)[source]¶

Check if the result of updating a connection shows that the connection is gone.

Parameters

cid (str) –
uuid (str) –
adapter (str) –
node (str) –

_get_test_hook(schemas, adapter, node, cid=None, uuid=None)[source]¶

Check if the result of testing a connection shows has various failures.

Parameters

schemas (typing.List[dict]) –
adapter (str) –
node (str) –
cid (typing.Optional[str]) –
uuid (typing.Optional[str]) –

_add(connection, instance_id, instance_name, adapter_name, connection_discovery=None, is_instances_mode=False, save_and_fetch=True, active=True, connection_label=None)[source]¶

Pass.

Parameters

connection (dict) –
instance_id (str) –
instance_name (str) –
adapter_name (str) –
connection_discovery (typing.Optional[dict]) –
is_instances_mode (bool) –
save_and_fetch (bool) –
active (bool) –
connection_label (typing.Optional[str]) –

Return type

axonius_api_client.api.json_api.adapters.CnxModifyResponse

_test(adapter_name, instance, connection, response_status_hook=None)[source]¶

Private API method to add a connection to an adapter.

Parameters

adapter_name_raw – raw name of the adapter i.e. aws_adapter
adapter_node_id – id of node running adapter
config – configuration to test
adapter_name (str) –
instance (str) –
connection (dict) –
response_status_hook (typing.Optional[typing.Callable]) –

Return type

dict

_get(adapter_name)[source]¶

Pass.

Parameters: adapter_name (str) –
Return type: axonius_api_client.api.json_api.adapters.Cnxs

_delete(uuid, adapter_name, instance_id, instance_name, delete_entities=False, is_instances_mode=False, response_status_hook=None)[source]¶

Private API method to delete a connection from an adapter.

Parameters

adapter_name_raw – raw name of the adapter i.e. aws_adapter
adapter_node_id – id of node running adapter
uuid (str) – uuid of connection to delete
delete_entities (bool) – delete all asset entities associated with this connection
adapter_name (str) –
instance_id (str) –
instance_name (str) –
is_instances_mode (bool) –
response_status_hook (typing.Optional[typing.Callable]) –

Return type

axonius_api_client.api.json_api.adapters.CnxDelete

_update(uuid, connection, instance_id, instance_name, adapter_name, instance_prev=None, instance_prev_name=None, connection_discovery=None, is_instances_mode=False, save_and_fetch=True, active=True, connection_label=None, response_status_hook=None)[source]¶

Pass.

Parameters

uuid (str) –
connection (dict) –
instance_id (str) –
instance_name (str) –
adapter_name (str) –
instance_prev (typing.Optional[str]) –
instance_prev_name (typing.Optional[str]) –
connection_discovery (typing.Optional[dict]) –
is_instances_mode (bool) –
save_and_fetch (bool) –
active (bool) –
connection_label (typing.Optional[str]) –
response_status_hook (typing.Optional[typing.Callable]) –

Return type

axonius_api_client.api.json_api.adapters.CnxModifyResponse

__init__(parent)¶

Mixins model for API child objects.

Parameters: parent (axonius_api_client.api.mixins.Model) – parent API model of this child

__repr__()¶

Show info for this model object.

Return type: str

__str__()¶

Show info for this model object.

Return type: str

_init(parent)¶

Post init method for subclasses to use for extra setup.

Parameters: parent (axonius_api_client.api.mixins.Model) – parent API model of this child