10.19. Cli Command Reference¶
10.19.1. View commands¶
10.19.1.1. show¶
Show running system information
10.19.1.1.1. show agent¶
Show define agents
10.19.1.1.1.1. show agent <AGENT>¶
Show selected agent
10.19.1.1.1.1.1. show agent <AGENT> info¶
Show agent running internal data
10.19.1.1.2. show cluster¶
Show clusters
10.19.1.1.2.1. show cluster <CLUSTER>¶
Show selected cluster
10.19.1.1.3. show condition¶
Show conditions
10.19.1.1.3.1. show condition device¶
Show device's conditions
10.19.1.1.3.2. show condition filter¶
Show conditions with custom filters
10.19.1.1.3.2.1. show condition filter <LINE>¶
Show conditions with custom filters (es: title=prova node=localhost)
10.19.1.1.3.3. show condition id¶
Show conditions by UUID
10.19.1.1.3.4. show condition interface¶
Show interface's conditions
10.19.1.1.3.5. show condition node¶
10.19.1.1.3.5.1. show condition node <NODE>¶
Show node's conditions
10.19.1.1.3.6. show condition path¶
Show conditions by path
10.19.1.1.3.7. show condition primary¶
Show all primary conditions
10.19.1.1.3.7.1. show condition primary device¶
Show all primary conditions
10.19.1.1.3.7.2. show condition primary interface¶
Show all primary conditions
10.19.1.1.3.7.3. show condition primary node¶
Show all primary conditions
10.19.1.1.3.7.4. show condition primary service¶
Show all primary conditions
10.19.1.1.3.7.5. show condition primary storage¶
Show all primary conditions
10.19.1.1.3.8. show condition priority¶
Show conditions by priority
10.19.1.1.3.8.1. show condition priority level¶
Show conditions above minimum priority
Show conditions above minimum priority
10.19.1.1.3.8.2. show condition priority minimun¶
Show conditions above minimum priority
Show conditions above minimum priority
10.19.1.1.3.8.3. show condition priority undefined¶
Show conditions withou priority
10.19.1.1.3.9. show condition service¶
Show service's conditions
10.19.1.1.3.10. show condition status¶
10.19.1.1.3.10.1. show condition status down|failing|flapping|suspended|uncheckable|up¶
Show condition with the given status
10.19.1.1.3.11. show condition storage¶
Show storage's conditions
10.19.1.1.3.12. show condition tagtree¶
Show elements in tagtree/tag.
10.19.1.1.3.13. show condition template¶
Show conditions by datagroup template
10.19.1.1.4. show configuration¶
Show configuration
10.19.1.1.4.1. show configuration agent¶
Show agent settings
10.19.1.1.4.1.1. show configuration agent <AGENT>¶
Show agent settings
10.19.1.1.4.2. show configuration cluster¶
Show cluster configuration
10.19.1.1.4.2.1. show configuration cluster <CLUSTER>¶
Show cluster configuration
10.19.1.1.4.3. show configuration datagroup-template¶
Show datagroup template configuration
10.19.1.1.4.3.1. show configuration datagroup-template <datagroup template>¶
Show datagroup template configuration
Show datagroup template configuration from library
Show datagroup template configuration
10.19.1.1.4.4. show configuration device-template¶
Show device template configuration
10.19.1.1.4.4.1. show configuration device-template <element template>¶
Show device template configuration
Show device template configuration from library
Show device template configuration
10.19.1.1.4.5. show configuration event-reason¶
Show event-reason configuration
10.19.1.1.4.5.1. show configuration event-reason <EVENTREASON>¶
Show event-reason configuration
10.19.1.1.4.6. show configuration group¶
Show group configuration
10.19.1.1.4.6.1. show configuration group <GROUP>¶
Show group configuration
10.19.1.1.4.7. show configuration interface-template¶
Show interface template configuration
10.19.1.1.4.7.1. show configuration interface-template <element template>¶
Show interface template configuration
Show interface template configuration from library
Show interface template configuration
10.19.1.1.4.8. show configuration links¶
Show configured links
10.19.1.1.4.9. show configuration node¶
Show node configuration
10.19.1.1.4.9.1. show configuration node <NODE>¶
Show node configuration
Show device's configuration of the given node
Show interface's configuration of the given node
Show node's subelements configurations only
Show service's configuration of the given node
Show storage's configuration of the given node
Show node's subelements configurations only (verbose)
10.19.1.1.4.10. show configuration node-template¶
Show node template configuration
10.19.1.1.4.10.1. show configuration node-template <element template>¶
Show node template configuration
Show node template configuration from library
Show node template configuration
10.19.1.1.4.11. show configuration scheduling-group¶
Show scheduling group's configuration
10.19.1.1.4.11.1. show configuration scheduling-group <SCHEDULINGGROUP>¶
Show scheduling group's configuration
10.19.1.1.4.12. show configuration service-template¶
Show service template configuration
10.19.1.1.4.12.1. show configuration service-template <element template>¶
Show service template configuration
Show service template configuration from library
Show service template configuration
10.19.1.1.4.13. show configuration storage-template¶
Show storage template configuration
10.19.1.1.4.13.1. show configuration storage-template <element template>¶
Show storage template configuration
Show storage template configuration from library
Show storage template configuration
10.19.1.1.4.14. show configuration tagtree¶
show tag tree configuration
10.19.1.1.4.14.1. show configuration tagtree <tree>¶
show tag tree configuration
10.19.1.1.4.15. show configuration tenant¶
Show tenant configuration
10.19.1.1.4.15.1. show configuration tenant <TENANT>¶
Show tenant configuration
10.19.1.1.4.16. show configuration this¶
Show configuration for the current element
10.19.1.1.4.16.1. show configuration this parent¶
Show configuration for the current element
Show configuration for the current element (verbose)
10.19.1.1.4.16.2. show configuration this tagtree¶
Show configuration for this tagtree
10.19.1.1.4.16.3. show configuration this verbose¶
Show configuration for the current element (verbose)
10.19.1.1.4.17. show configuration user¶
Show user configuration
10.19.1.1.4.17.1. show configuration user <USER>¶
Show user configuration
10.19.1.1.4.18. show configuration xform-device¶
Show xform-device configuration
10.19.1.1.4.18.1. show configuration xform-device <XFORM>¶
Show xform-device configuration
10.19.1.1.4.19. show configuration xform-interface¶
Show xform-interface configuration
10.19.1.1.4.19.1. show configuration xform-interface <XFORM>¶
Show xform-interface configuration
10.19.1.1.5. show datagroup¶
Show configured datagroups
10.19.1.1.5.1. show datagroup columns¶
Show configured datagroups with selected columns
10.19.1.1.5.1.1. show datagroup columns <LINE>¶
Show configured datagroups with selected columns
10.19.1.1.5.2. show datagroup device¶
Show device's datagroups
10.19.1.1.5.3. show datagroup id¶
Show datagrop by UUID
10.19.1.1.5.4. show datagroup interface¶
Show interface's datagroups
10.19.1.1.5.5. show datagroup node¶
Show datagroup for the give node
10.19.1.1.5.5.1. show datagroup node <NODE>¶
Show node's datagroups
10.19.1.1.5.6. show datagroup path¶
Show datagrop
10.19.1.1.5.7. show datagroup scheduling-group¶
Show datagroup by scheduling group
10.19.1.1.5.7.1. show datagroup scheduling-group <SCHEDULINGGROUP>¶
Show datagroup by scheduling group
10.19.1.1.5.8. show datagroup service¶
Show service's datagroups
10.19.1.1.5.9. show datagroup storage¶
Show storage's datagroups
10.19.1.1.5.10. show datagroup tagtree¶
Show elements in tagtree/tag.
10.19.1.1.6. show datasource¶
Show configured datasources
10.19.1.1.6.1. show datasource device¶
Show device's datasources
10.19.1.1.6.1.1. show datasource device <NODE>¶
Show device's datasources
Show device's datasources
Exclude datasource belonging to suspended datagroups or with not verified dependson
Show datasources by state
Show datasources by state
Exclude datasource belonging to suspended datagroups or with not verified dependson
10.19.1.1.6.2. show datasource exclude-depending¶
Exclude datasource belonging to suspended datagroups or with not verified dependson
10.19.1.1.6.3. show datasource id¶
Show datasource by id
10.19.1.1.6.3.1. show datasource id <WORD>¶
Show datasource by id
Show atasource's data
Show datasource's data (last N samples)
Show datasource running state
Show datasource storage info
10.19.1.1.6.4. show datasource interface¶
Show interface's datasources
10.19.1.1.6.4.1. show datasource interface <NODE>¶
Show interface's datasources
Show interface's datasources
Exclude datasource belonging to suspended datagroups or with not verified dependson
Show datasources by state
Show datasources by state
Exclude datasource belonging to suspended datagroups or with not verified dependson
10.19.1.1.6.5. show datasource node¶
Show node's datasources
10.19.1.1.6.5.1. show datasource node <NODE>¶
Show node's datasources
Exclude datasource belonging to suspended datagroups or with not verified dependson
Show datasources by state
Show datasources by state
Exclude datasource belonging to suspended datagroups or with not verified dependson
10.19.1.1.6.6. show datasource path¶
Show configured datasource by path
10.19.1.1.6.6.1. show datasource path <PATH>¶
Show configured datasource by path
Show datasource's data (last N samples)
Show datasource's data (last N samples)
Show datasource running state
Show datasource storage info
10.19.1.1.6.7. show datasource service¶
Show service's datasources
10.19.1.1.6.7.1. show datasource service <NODE>¶
Show service's datasources
Show service's datasources
Exclude datasource belonging to suspended datagroups or with not verified dependson
Show datasources by state
Show datasources by state
Exclude datasource belonging to suspended datagroups or with not verified dependson
10.19.1.1.6.8. show datasource state¶
Show datasources by state
10.19.1.1.6.9. show datasource storage¶
Show storage's datasources
10.19.1.1.6.9.1. show datasource storage <NODE>¶
Show storage's datasources
Show storage's datasources
Exclude datasource belonging to suspended datagroups or with not verified dependson
Show datasources by state
Show datasources by state
Exclude datasource belonging to suspended datagroups or with not verified dependson
10.19.1.1.6.10. show datasource tagtree¶
Show elements in tagtree/tag.
10.19.1.1.6.11. show datasource template¶
Show datasources by datagroup template
10.19.1.1.6.11.1. show datasource template <datagroup template>¶
Show datasources by datagroup template
Show datasources by datagroup template
Exclude datasource belonging to suspended datagroups or with not verified dependson
Show datasources by state
Show datasources by state
Exclude datasource belonging to suspended datagroups or with not verified dependson
Exclude datasource belonging to suspended datagroups or with not verified dependson
Show datasources by state
Show datasources by state
Exclude datasource belonging to suspended datagroups or with not verified dependson
10.19.1.1.7. show device¶
Show devices
10.19.1.1.7.1. show device node¶
Show devices for the given node
10.19.1.1.8. show diff¶
Difference between nodes in tag configuration
10.19.1.1.9. show entables¶
Show entables data
10.19.1.1.9.1. show entables alarms¶
Show processed alarms
10.19.1.1.9.1.1. show entables alarms id¶
Show processed alarms by ID
10.19.1.1.10. show group¶
Show defined Groups
10.19.1.1.11. show info¶
Show global informations
10.19.1.1.11.1. show info full¶
Show global informations (full data)
10.19.1.1.12. show interface¶
Show interfaces
10.19.1.1.12.1. show interface node¶
Show interfaces for the given node
10.19.1.1.13. show ip¶
IPv4 and IPv6 addresses via DNS
10.19.1.1.13.1. show ip allnodes¶
Resolved IP addresses for all the node names
10.19.1.1.14. show link¶
Show links
10.19.1.1.15. show log¶
Show log
10.19.1.1.15.1. show log audit¶
Show auditlog
10.19.1.1.15.1.1. show log audit id¶
Show log entry by ID
Show log entry with the given ID
10.19.1.1.15.1.2. show log audit last¶
Show log entry by ID
Show last <n> logs of the given node
10.19.1.1.15.1.3. show log audit node¶
Show log entry by ID
10.19.1.1.15.1.4. show log audit type¶
Show log entry by ID
10.19.1.1.15.2. show log cluster¶
Show cluster
10.19.1.1.15.3. show log condition¶
Show condition
10.19.1.1.15.4. show log datagroup¶
Show datagrop
10.19.1.1.15.5. show log device¶
Show device's log
10.19.1.1.15.5.1. show log device <NODE>¶
Show device's log
10.19.1.1.15.6. show log id¶
Show log entry by ID
10.19.1.1.15.7. show log interface¶
Show interface's log
10.19.1.1.15.7.1. show log interface <NODE>¶
Show interface's log
10.19.1.1.15.8. show log last¶
Show last <n> logs
10.19.1.1.15.8.1. show log last <NUM>¶
Show last <n> logs
10.19.1.1.15.9. show log node¶
Show node's log
10.19.1.1.15.10. show log reason¶
Show logs by reason code
10.19.1.1.15.11. show log service¶
Show service's log
10.19.1.1.15.11.1. show log service <NODE>¶
Show service's log
10.19.1.1.15.12. show log status¶
10.19.1.1.15.12.1. show log status down|flapping|suspended|uncheckable|up¶
Show log with the given status
10.19.1.1.16. show log-reason¶
Show log reasons
10.19.1.1.17. show node¶
Show nodes
10.19.1.1.17.1. show node agent¶
Show nodes by agent
10.19.1.1.17.2. show node cluster¶
Show nodes by cluster
10.19.1.1.17.3. show node id¶
Show node by id
10.19.1.1.17.4. show node name¶
Show node informations
10.19.1.1.17.5. show node tagtree¶
Show elements in tagtree/tag.
10.19.1.1.18. show notes¶
Show notes
10.19.1.1.19. show priority-levels¶
Show priority levels range
10.19.1.1.20. show scheduling-group¶
Show scheduling groups
10.19.1.1.20.1. show scheduling-group all¶
Show scheduling groups (implicit groups too)
10.19.1.1.21. show search¶
Search elements
10.19.1.1.22. show service¶
Show services
10.19.1.1.22.1. show service node¶
Show interfaces for the given node
10.19.1.1.23. show storage¶
Show storages
10.19.1.1.23.1. show storage node¶
Show storages for the given node
10.19.1.1.24. show system¶
Show internal informations
10.19.1.1.24.1. show system cache¶
Show cache informations
10.19.1.1.24.1.1. show system cache info¶
Show cache informations
10.19.1.1.24.2. show system datasourcestore¶
Show datasourcestore informations
10.19.1.1.24.3. show system db¶
Show internal database informations
10.19.1.1.24.3.1. show system db occupation¶
Show internal database executed queries
10.19.1.1.24.3.2. show system db queries¶
Show internal database executed queries
10.19.1.1.24.3.3. show system db usage¶
Show internal database backends
10.19.1.1.24.4. show system passived¶
Show central passived server informations
10.19.1.1.24.4.1. show system passived <LINE>¶
Show central passived server informations
10.19.1.1.24.5. show system queues¶
Show internal queue system informations
10.19.1.1.25. show tag¶
Show tag informatinos
10.19.1.1.25.1. show tag device¶
Show tags assigned to device
10.19.1.1.25.2. show tag info¶
Show tag's informations
10.19.1.1.25.3. show tag interface¶
Show tags assigned to interface
10.19.1.1.25.4. show tag node¶
Show tags assigned to node
10.19.1.1.25.4.1. show tag node <NODE>¶
Show tags assigned to node
10.19.1.1.25.5. show tag service¶
Show tags assigned to service
10.19.1.1.25.6. show tag storage¶
Show tags assigned to storage
10.19.1.1.26. show tagtree¶
Show defined tag trees
10.19.1.1.27. show templates¶
Show configuration templates
10.19.1.1.27.1. show templates all¶
Show node templates
10.19.1.1.27.2. show templates datagroup¶
Show datagroup templates
10.19.1.1.27.2.1. show templates datagroup <datagroup template>¶
Show datagroup template informations
10.19.1.1.27.3. show templates device¶
Show device templates
10.19.1.1.27.3.1. show templates device <element template>¶
Show device template informations
10.19.1.1.27.4. show templates interface¶
Show interface templates
10.19.1.1.27.4.1. show templates interface <element template>¶
Show interface template informations
10.19.1.1.27.5. show templates node¶
Show node templates
10.19.1.1.27.5.1. show templates node <element template>¶
Show node template informations
10.19.1.1.27.6. show templates service¶
Show service templates
10.19.1.1.27.6.1. show templates service <element template>¶
Show service template informations
10.19.1.1.27.7. show templates storage¶
Show storage templates
10.19.1.1.27.7.1. show templates storage <element template>¶
Show storage template informations
10.19.1.1.27.8. show templates used¶
Show configuration templates with filters
10.19.1.1.28. show tenant¶
Show defined Tenants
10.19.1.1.29. show timegraph¶
Show timegraphs
10.19.1.1.29.1. show timegraph device¶
Show device's timegraphs
10.19.1.1.29.2. show timegraph id¶
Show timegraph
10.19.1.1.29.2.1. show timegraph id <WORD>¶
Show timegraph
10.19.1.1.29.3. show timegraph interface¶
Show interface's timegraphs
10.19.1.1.29.4. show timegraph node¶
Show timegraph by node
10.19.1.1.29.4.1. show timegraph node <NODE>¶
Show timegraph by node
10.19.1.1.29.5. show timegraph path¶
Show timegraph
10.19.1.1.29.5.1. show timegraph path <PATH>¶
Show timegraph
10.19.1.1.29.6. show timegraph service¶
Show service's timegraphs
10.19.1.1.29.7. show timegraph storage¶
Show storage's timegraphs
10.19.1.1.29.8. show timegraph tagtree¶
Show elements in tagtree/tag.
10.19.1.1.30. show timegraphserie¶
Show timegraph series
10.19.1.1.30.1. show timegraphserie datagroup¶
Show timegraph series by datagroup
10.19.1.1.30.1.1. show timegraphserie datagroup <PATH>¶
Show timegraph series by datagroup
10.19.1.1.30.2. show timegraphserie device¶
Show timegraph series
10.19.1.1.30.3. show timegraphserie interface¶
Show timegraph series
10.19.1.1.30.4. show timegraphserie node¶
Show timegraph series
10.19.1.1.30.4.1. show timegraphserie node <NODE>¶
Show timegraph series
10.19.1.1.30.5. show timegraphserie service¶
Show timegraph series
10.19.1.1.31. show user¶
Show defined Users
10.19.1.1.32. show xform-device¶
Show defined xform-device
10.19.1.1.32.1. show xform-device <XFORM>¶
Show defined xform-interface by name
10.19.1.1.33. show xform-interface¶
Show defined xform-interface
10.19.1.1.33.1. show xform-interface <XFORM>¶
Show defined xform-interface by name
10.19.2. Common commands¶
10.19.2.1. check¶
Force execution of datagroup by its agent
10.19.2.2. date¶
Print current time
10.19.2.4. env¶
Print shell environment settings (for debug)
10.19.2.5. execute¶
Test datagroups/timegraphs locally
10.19.2.5.1. execute datagroup¶
Test a datagroup
10.19.2.5.1.1. execute datagroup id¶
Test datagroup by id
10.19.2.5.1.1.1. execute datagroup id <WORD>¶
Execute datagroup by id
Execute datagroup by PATH (dependson ignored)
Execute datagroup by PATH with default verbosity
Execute datagroup by PATH verbosely
Execute datagroup by PATH verbosely (dependson ignored)
Execute datagroup by PATH with default verbosity (dependson ignored)
10.19.2.5.1.2. execute datagroup path¶
Specify by path
10.19.2.5.1.2.1. execute datagroup path <PATH>¶
Execute datagroup by PATH (element or condition path)
Execute datagroup by PATH (dependson ignored)
Execute datagroup by PATH with default verbosity
Execute datagroup by PATH verbosely
Execute datagroup by PATH verbosely (dependson ignored)
Execute datagroup by PATH with default verbosity (dependson ignored)
10.19.2.5.1.3. execute datagroup this¶
Test current datagroup
10.19.2.5.1.3.1. execute datagroup this no-dependson¶
Execute datagroup by PATH (dependson ignored)
10.19.2.5.1.3.2. execute datagroup this verbose¶
Execute datagroup by PATH with default verbosity
Execute datagroup by PATH verbosely
Execute datagroup by PATH verbosely (dependson ignored)
Execute datagroup by PATH with default verbosity (dependson ignored)
10.19.2.5.2. execute tag¶
Execute action on tag
10.19.2.6. help¶
Print help
10.19.2.7. history¶
View CLI history
10.19.2.9. set¶
Change shell working environemnt
10.19.2.9.1. set configuration¶
Set configuration's options
10.19.2.9.2. set errors¶
Error handling for the current section
10.19.2.9.2.1. set errors default¶
Do not ignore errors (exits when CLI is executed with -x option)
10.19.2.9.2.2. set errors ignore¶
Ignore all errors
10.19.2.9.3. set terminal¶
Set terminal properties for current session
10.19.2.9.3.1. set terminal colors¶
Enable/Disable colors
10.19.2.9.3.1.1. set terminal colors no|yes¶
Enable/Disable colors
10.19.2.9.3.2. set terminal exitwords¶
Words recognized as exit comands, for this level of the CLI
10.19.2.9.3.2.1. set terminal exitwords <LINE>¶
Space separated words, default: exit logout quit
10.19.2.9.3.3. set terminal format¶
Set output format
10.19.2.10. signal¶
Force execution of datagroup by its agent
10.19.2.11. sleep¶
Block terminal for N seconds
10.19.2.11.1. sleep <NUM>¶
Block terminal for N seconds
10.19.2.12. test¶
Test systems
10.19.2.12.1. test datagroup¶
Test a datagroup
10.19.2.12.1.1. test datagroup id¶
Test datagroup by id
10.19.2.12.1.1.1. test datagroup id <WORD>¶
Execute datagroup by id
Execute datagroup by PATH (dependson ignored)
Execute datagroup by PATH with default verbosity
Execute datagroup by PATH verbosely
Execute datagroup by PATH verbosely (dependson ignored)
Execute datagroup by PATH with default verbosity (dependson ignored)
10.19.2.12.1.2. test datagroup path¶
Specify by path
10.19.2.12.1.2.1. test datagroup path <PATH>¶
Execute datagroup by PATH (element or condition path)
Execute datagroup by PATH (dependson ignored)
Execute datagroup by PATH with default verbosity
Execute datagroup by PATH verbosely
Execute datagroup by PATH verbosely (dependson ignored)
Execute datagroup by PATH with default verbosity (dependson ignored)
10.19.2.12.1.3. test datagroup this¶
Test current datagroup
10.19.2.12.1.3.1. test datagroup this no-dependson¶
Execute datagroup by PATH (dependson ignored)
10.19.2.12.1.3.2. test datagroup this verbose¶
Execute datagroup by PATH with default verbosity
Execute datagroup by PATH verbosely
Execute datagroup by PATH verbosely (dependson ignored)
Execute datagroup by PATH with default verbosity (dependson ignored)