4.4.6.3. JSON¶

JSON export callbacks.

class axonius_api_client.api.asset_callbacks.base_json.Json(apiobj, store, state=None, getargs=None)[source]¶

Bases: ExportMixins

Callbacks for formatting asset data and exporting it in JSON format.

Examples

Create a client using axonius_api_client.connect.Connect and assume apiobj is either client.devices or client.users

>>> apiobj = client.devices  # or client.users

args_map() for callback generic arguments to format assets.
args_map_custom() for callback specific arguments to format and export data.

Parameters:

store (dict) –
state (typing.Optional[dict]) –
getargs (typing.Optional[dict]) –

classmethod args_map_custom()[source]¶

Get the custom argument names and their defaults for this callbacks object. :rtype: dict

Examples

Export the output to STDOUT. If export_file is not supplied, the default is to print the output to STDOUT.

>>> assets = apiobj.get(export="json")

Export the output to a file in the default path axonius_api_client.setup_env.DEFAULT_PATH.

>>> assets = apiobj.get(export="json", export_file="test.json")

Export the output to an absolute path file (ignoring export_path) and overwrite the file if it exists.

>>> assets = apiobj.get(
...     export="json",
...     export_file="/tmp/output.json",
...     export_overwrite=True,
... )

Export the output to a file in a specific dir.

>>> assets = apiobj.get(export="json", export_file="output.json", export_path="/tmp")

Return each asset as one dictionary per line (with no indenting) instead of a list of dictionaries.

>>> assets = apiobj.get(export="json", export_file="test.json", json_flat=True)

See also

args_map() for callback generic arguments to format assets.

Notes

These arguments can be supplied as extra kwargs passed to axonius_api_client.api.assets.users.Users.get() or axonius_api_client.api.assets.devices.Devices.get()

start(**kwargs)[source]¶: Start this callbacks object.

stop(**kwargs)[source]¶: Stop this callbacks object.

process_row(row)[source]¶

Process the callbacks for current row.

Parameters:: row (typing.Union[typing.List[dict], dict]) – row to process
Return type:: typing.List[dict]

write_rows(rows)[source]¶

Write rows to the file descriptor.

Parameters:: rows (typing.Union[typing.List[dict], dict]) – rows to process

do_export_schema()[source]¶: Add schema rows to the output.

ALL_SCHEMAS: dict = None¶: Map of adapter -> field schemas.

APIOBJ = None¶

assets object.

Type:: axonius_api_client.api.assets.asset_mixin.AssetMixin

CB_NAME: str = 'json'¶: name for this callback

CURRENT_ROWS: t.Optional[t.List[dict]] = None¶: current rows being processed

CUSTOM_CB_EXC: List[dict] = None¶: tracker of custom callbacks that have been executed by do_custom_cbs()

FIND_KEYS: List[str] = ['name', 'name_qual', 'column_title']¶: field schema keys to use when finding a fields schema

GETARGS: dict = None¶: original kwargs supplied to get assets method.

STATE: dict = None¶: state dict used by get assets method to track paging.

STORE: dict = None¶: store dict used by get assets method to track arguments.

TAG_ROWS_ADD: List[dict] = None¶: tracker of assets to add tags to in do_tagging().

TAG_ROWS_REMOVE: List[dict] = None¶: tracker of assets to remove tags from in do_tagging().

__init__(apiobj, store, state=None, getargs=None)¶

Callbacks base class for assets.

Parameters:

apiobj (axonius_api_client.api.assets.asset_mixin.AssetMixin) – Asset object that created this callback
store (dict) – store tracker of get method that created this callback
state (typing.Optional[dict]) – state tracker of get method that created this callback
getargs (typing.Optional[dict]) – kwargs passed to assets get method that created this callback

__repr__()¶

Show info for this object.

Return type:: str

__str__()¶

Show info for this object.

Return type:: str

_add_report_adapters_missing(row)¶

Process report: Missing adapters.

Parameters:: row (dict) – row being processed

_add_report_software_whitelist(row)¶

Process report: Software whitelist.

Parameters:: row (dict) – row being processed

_do_add_null_values(row, schema, key='name_qual')¶

Null out missing fields.

Parameters:

row (dict) – row being processed
schema (dict) – field schema to add null values for
key (str) – key of field schema to add null value for in row

_do_change_field_titles(row)¶

Asset callback to change qual name to title.

Parameters:: row (dict) – row being processed

_do_excludes(row)¶

Asset callback to remove fields from row.

Parameters:: row (dict) – row being processed

_do_explode_entities(row)¶

Explode a row into multiple rows for each asset entity.

Parameters:: row (dict) – row being processed
Return type:: typing.List[dict]

_do_explode_field(row)¶

Explode a field into multiple rows.

Parameters:: row (dict) – row being processed
Return type:: typing.List[dict]

_do_flatten_fields(row, schema)¶

Asset callback to flatten complex fields.

Parameters:

row (dict) – row being processed
schema (dict) – schema to use when flattening

_do_join_values(row)¶

Join values.

Parameters:: row (dict) – row being processed

_field_compress(key)¶

Parse fields into required format.

Parameters:: key (str) –
Return type:: str

_field_replace(key)¶

Parse fields into required format.

Parameters:: key (str) –
Return type:: str

_init()¶: Post init setup.

property adapter_map: dict¶: Build a map of adapters that have connections.

add_include_dates(rows)¶

Process report: Add dates (history and current)

Parameters:: rows (typing.Union[typing.List[dict], dict]) – rows to process
Return type:: typing.List[dict]

add_report_adapters_missing(rows)¶

Process report: Missing adapters.

Parameters:: rows (typing.Union[typing.List[dict], dict]) – rows to process
Return type:: typing.List[dict]

add_report_software_whitelist(rows)¶

Process report: Software whitelist.

Parameters:: rows (typing.Union[typing.List[dict], dict]) – rows to process
Return type:: typing.List[dict]

property arg_export_backup: bool¶: Pass.

property arg_export_fd: Optional[IO]¶: Pass.

property arg_export_fd_close: bool¶: Pass.

property arg_export_file: Optional[PathLike]¶: Pass.

property arg_export_overwrite: bool¶: Pass.

property arg_export_path: Path¶: Pass.

classmethod args_map()¶

Get all the argument names and their defaults for this callbacks object. :rtype: dict

Examples

Create a client using axonius_api_client.connect.Connect and assume apiobj is either client.devices or client.users

>>> import axonius_api_client as axonapi
>>> connect_args: dict = axonapi.get_env_connect()
>>> client: axonapi.Connect = axonapi.Connect(**connect_args)
>>> apiobj: axonapi.api.assets.AssetMixin = client.devices
>>>       # or client.users or client.vulnerabilities

Flatten complex fields - Will take all sub-fields of complex fields and put them on the root level with their values index correlated to each other.

>>> assets = apiobj.get(fields=["network_interfaces"], field_flatten=True)

Explode a single field - will take that field and create new rows for list item.

>>> assets = apiobj.get(field_explode="hostname")

Exclude fields - Will remove fields from the final output.

>>> assets = apiobj.get(field_excludes=["internal_axon_id", "adapter_list_length"])

Use field titles - Will change internal field names to their titles.

>>> assets = apiobj.get(field_titles=True)

Join fields - Will join multi value fields with carriage returns.

>>> assets = apiobj.get(field_join=True)

Join fields with no trim and custom join value - Will join multi value fields with ;; and do not trim the joined value to excels maximum cell length.

>>> assets = apiobj.get(field_join=True, field_join_value=";;", field_join_trim=0)

Add fields as empty values for fields that did not return.

>>> assets = apiobj.get(field_null=True)

Add fields as empty values for fields that did not return with a custom null value.

>>> assets = apiobj.get(
...     field_null=True,
...     field_null_value="EMPTY",
...     field_null_value_complex="EMPTY LIST",
... )

Add and remove tags to all assets returned.

>>> assets = apiobj.get(tags_add=["tag1", "tag2"], tags_remove=["tag3", "tag4"])

Generate a report of adapters that are missing from each asset.

>>> assets = apiobj.get(report_adapters_missing=True)

Generate a report of installed software that does not match a list of regex for each asset.

>>> assets = apiobj.get(report_software_whitelist=["chrome", "^adobe.*acrobat"])

Echo to STDERR progress messages.

>>> assets = apiobj.get(do_echo=True)

Change the amount of assets that echo page progress when do_echo is true.

>>> assets = apiobj.get(do_echo=True, page_progress=100)

Supply a set of custom callbacks to process each row before all builtin callbacks are run. Custom callbacks receive two arguments: self (the current callback object) and rows (the current rows being processed). Custom callbacks must return a list of rows.

>>> def custom_cb1(self, rows):
...     for row in rows:
...         row["internal_axon_id"] = row["internal_axon_id"].upper()
...     return rows
...
>>> assets = apiobj.get(custom_cbs=[custom_cb1])