2.2.2. Optional Variables¶
2.2.2.1. AX_DOTENV¶
Have the bot use a specific .env file. You can also supply this using the --env
argument to the bot.
Default value: “/current_working_directory/.env”
$ export AX_DOTENV="/path/to/custom.env"
# or...
$ axonbot_slack --env "/path/to/custom.env"
2.2.2.2. Proxies¶
Proxies can be supplied in a few different ways (courtesy of requests proxy support):
- Simple Proxy: “https://10.10.1.10:3128”
- Basic Auth Proxy: “https://user:pass@10.10.1.10:3128”
- Socks Proxy: “socks5://user:pass@10.10.1.10:3128”
2.2.2.2.2. AX_HTTPS_PROXY¶
Proxy to use for the Connection to the Axonius instance.
Default value: “”
2.2.2.3. Object Fields¶
You can always add or remove fields by sending commands to the bot, but this allows you to change the default set of fields that the bot starts with for user and device objects.
These variables need to have an adapter followed by a colon then followed by a comma seperated list of fields.
- Fields can be considered the “columns” to return in response objects.
- The generic adapter relates to the correlated fields as displayed in the General Data tab of an object in the Axonius GUI.
- Fields from multiple adapters can be defined by seperating them with a semi-colon.
The adapter must be either generic or the name of a valid adapter in the Axonius instance.
- If an invalid adapter name is supplied, the bot will print a list of valid adapter names and exit.
Each field in the comma seperated list of fields must be a valid field for the adapter.
- If an invalid field name is supplied, the bot will print a list of valid fields for the adapter and exit.
Example for specifying a set of fields for just the generic adapter:
"generic:labels,hostname,network_interfaces,last_seen"
Example for specifying a set of fields for just one non-generic adapter :
"aws:aws_device_type,aws_source"
Example for specifying a set of fields for the generic adapter and for one non-generic adapter:
"generic:labels,hostname,network_interfaces,last_seen;aws:aws_device_type,aws_source"
2.2.2.3.1. AX_DEVICE_FIELDS¶
Default fields to return in device responses.
Default value: “generic:labels,hostname,network_interfaces,last_seen”
2.2.2.3.2. AX_USER_FIELDS¶
Default fields to return in user responses
Default value: “generic:labels,username,last_seen,mail”