3.2.24. tools shell

This command launches a python interactive shell session.

The python session will establish a connection to the Axonius instance as a client object and instantiate the API objects for devices, users, and adapters.

3.2.24.1. Common Options

3.2.24.3. Help Page

3.2.24.3.1. axonshell tools shell

Start an interactive python shell.

The shell will authenticate to Axonius, setup autocompletion, enable history, and create the following objects:

- ctx: Click context object
- client/c: Instance of axonius_api_client.connect.Connect
- devices/d: Instance of axonius_api_client.api.Devices
- users/u: Instance of axonius_api_client.api.Users
- adapters/a: Instance of axonius_api_client.api.Adapters
- system/s: Instance of axonius_api_client.api.System
- axonapi: API Client package itself
- jdump/j: Helper function to pretty print python objects
axonshell tools shell [OPTIONS]

Options

-u, --url <URL>

Required URL of an Axonius instance

-k, --key <KEY>

Required API Key of user in an Axonius instance

-s, --secret <SECRET>

Required API Secret of user in an Axonius instance