3.2.7. devices/users get-fields¶
This command will produce a report of all fields for users or devices.
3.2.7.1. Common Options¶
Connection Options for examples of supplying the Axonius credentials and URL.
Export Options for examples of exporting data in different formats and outputs.
3.2.7.2. Examples¶
3.2.7.3. Help Page¶
3.2.7.3.1. axonshell devices/users get-fields¶
Get the available fields (columns) for assets.
axonshell devices/users get-fields [OPTIONS]
Options
- -u, --url <URL>¶
Required URL of an Axonius instance
- -k, --key <KEY>¶
Required API Key (or username if credentials=True) of user in an Axonius instance
- -s, --secret <SECRET>¶
Required API Secret (or password if credentials=True) of user in an Axonius instance
- -ar, --adapter-re <REGEX>¶
Only fetch fields for adapters matching this regex
- Default
.*
- -fr, --field-re <REGEX>¶
Only fetch fields matching this regex
- Default
.*
- -fk, --field-key <field_key>¶
Which field key to match against for –field-re
- Default
name_qual- Options
name_qual | name | name_base | column_title | column_name
- -ro, --root-only, -nro, --no-root-only¶
Only show root fields
- Default
False
- -is, --include-simple, -nis, --no-include-simple¶
Include simple fields
- Default
True
- -ic, --include-complex, -nic, --no-include-complex¶
Include complex fields
- Default
True
- -ia, --include-agg, -nia, --no-include-agg¶
Include aggregated fields
- Default
True
- -xf, --export-format <export_format>¶
Control how much schema information to return
- Default
str- Options
json | json-full | str | table