3.2.26. 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.26.1. Common Options

3.2.26.3. Help Page

3.2.26.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
- axonapi: API Client package itself
- client/c: API Client connection object
- devices/d: Work with device assets
- users/u: Work with user assets
- adapters/a: Work with adapters and adapter connections
- system/s: Work with users, roles, global settings, and more
- dashboard/db: Work with dashboards and discovery cycle
- instances/i: Work with instances
- system_users/su: Work with system users
- system_roles/sr: Work with system roles
- meta/m: Work with instance metadata
- settings_global/sgl: Work with Global system settings
- settings_gui/sgu: Work with GUI system settings
- settings_lifecycle/sl: Work with Lifecyle system settings
- 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