3.2.10. devices/users saved-query add

This command will add a saved query for users or devices.

3.2.10.1. Common Options

3.2.10.2. Common Examples

  • Selecting Fields Examples for examples of selecting which fields (columns) to include in the saved query for sort column, columns displayed, and column filters.

3.2.10.4. Help Page

3.2.10.4.1. axonshell devices/users saved-query add

Add a saved query.

axonshell devices/users saved-query add [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

-t, --tag <tags>

Tags to set for saved query

-sf, --sort-field <ADAPTER:FIELD>

Column to sort data on.

-sd, --sort-ascending

Sort –sort-field ascending.

-cf, --column-filter <ADAPTER:FIELD=value>

Columns to filter in the format of adapter:field=value.

-gps, --gui-page-size <gui_page_size>

Number of rows to show per page in GUI.

Default

25

Options

25 | 50 | 100

-d, --description <description>

Description to set on saved query

-xf, --export-format <export_format>

Format of to export data in

Default

str

Options

json | str | str-names

-q, --query <QUERY>

Query built from the Query wizard in the GUI

-qf, --query-file <QUERY_FILE>

Path to a file to override –query

-f, --field <ADAPTER:FIELD>

Fields to include in the format of adapter:field (multiples)

-fr, --field-regex <ADAPTER_REGEX:FIELD_REGEX>

Regular expressions of fields to include (multiples)

-ff, --field-fuzzy <ADAPTER:FIELD>

Fuzzy matching of fields to include (multiples)

-fro, --fields-root <ADAPTER>

Select all root fields for a given adapter (PERFORMANCE HIT!)

-fd, --fields-default, -nfd, --no-fields-default

Include the default fields defined in the API library

Default

True

-ow, --overwrite, -now, --no-overwrite

Overwrite pre-existing query.

Default

False

-wz, --wiz <TYPE "EXPRESSION">

Build a query using an expression (multiples, will override –query)

-n, --name <name>

Required Name of saved query

--help-detailed <help_detailed>

Show detailed help and exit

Options

auth | query | selectfields | wizard