tools system
system
+ app-management
+ application name string
+ kill
+ quit
+ reload
+ restart
+ start
+ statistics
+ clear
+ stop
+ boot
+ cgroup
+ configuration
+ candidate name string
+ clear
+ checkpoint id (number | checkpoint-name)
+ clear
+ load
+ revert
+ confirmed-accept
+ confirmed-reject
+ generate-checkpoint
+ comment string
+ name string
+ rescue-clear
+ rescue-save
+ save
+ session id number
+ clear
+ upgrade
+ checkpoint id (number | checkpoint-name)
+ file string
+ rescue
+ startup
+ dhcp-server
+ network-instance name string
+ dhcpv4
+ statistics
+ clear
+ dhcpv6
+ statistics
+ clear
+ packet-trace-base64
+ interface string
+ packet binary
+ tls
+ generate-csr
+ common-name string
+ country string
+ email string
+ locality string
+ organization string
+ organization-unit string
+ state string
+ generate-self-signed
+ common-name string
+ country string
+ duration number
+ email string
+ locality string
+ organization string
+ organization-unit string
+ state string
system Descriptions
system
app-management
| Description | Operational commands related to app-management | |
| Context | system app-management | |
| Tree | app-management | |
| Configurable | True |
application name string
| Description | List of all applications managed by the application manager | |
| Context | system app-management application name string | |
| Tree | application | |
| Configurable | True |
name string
| Description | Unique name of this application instance | |
| Context | system app-management application name string | |
| Configurable | True |
kill
| Description | Terminate the application instance ungracefully | |
| Context | system app-management application name string kill | |
| Tree | kill | |
| Configurable | True |
quit
| Description | Terminate the application instance, requesting it to core dump | |
| Context | system app-management application name string quit | |
| Tree | quit | |
| Configurable | True |
reload
| Description | Reload the configuration of the application instance | |
| Context | system app-management application name string reload | |
| Tree | reload | |
| Configurable | True |
restart
| Description | Restart the application instance | |
| Context | system app-management application name string restart | |
| Tree | restart | |
| Configurable | True |
start
| Description | Start the application instance | |
| Context | system app-management application name string start | |
| Tree | start | |
| Configurable | True |
statistics
| Description | Top-level grouping of operational commands related to application statistics | |
| Context | system app-management application name string statistics | |
| Tree | statistics | |
| Configurable | True |
clear
| Description | Clear statistics for this application instance | |
| Context | system app-management application name string statistics clear | |
| Tree | clear | |
| Configurable | True |
stop
| Description | Terminate the application instance gracefully | |
| Context | system app-management application name string stop | |
| Tree | stop | |
| Configurable | True |
boot
cgroup
configuration
| Description | Top-level container for operational commands related to the system configuration | |
| Context | system configuration | |
| Tree | configuration | |
| Configurable | True |
candidate name string
| Description | List of configuration candidates currently active | |
| Context | system configuration candidate name string | |
| Tree | candidate | |
| Configurable | True |
name string
| Description | The name of the candidate | |
| Context | system configuration candidate name string | |
| String Length | 1 to 255 | |
| Configurable | True |
clear
checkpoint id (number | checkpoint-name)
| Description | List of current checkpoints present in the system | |
| Context | system configuration checkpoint id (number | checkpoint-name) | |
| Tree | checkpoint | |
| Configurable | True |
id (number | checkpoint-name)
| Description | System generated ID, or operator defined name for the checkpoint | |
| Context | system configuration checkpoint id (number | checkpoint-name) | |
| Configurable | True |
clear
| Description | Clear the checkpoint from the system | |
| Context | system configuration checkpoint id (number | checkpoint-name) clear | |
| Tree | clear | |
| Configurable | True |
load
| Description | Load candidate from saved checkpoint configuration | |
| Context | system configuration checkpoint id (number | checkpoint-name) load | |
| Tree | load | |
| Configurable | True |
revert
| Description | Revert running system configuration to the saved checkpoint configuration This functions as a load and commit action. | |
| Context | system configuration checkpoint id (number | checkpoint-name) revert | |
| Tree | revert | |
| Configurable | True |
confirmed-accept
| Description | Accepts an in progress commit and stops the confirmation timer | |
| Context | system configuration confirmed-accept | |
| Tree | confirmed-accept | |
| Configurable | True |
confirmed-reject
| Description | Rejects an in progress commit and stops the confirmation timer | |
| Context | system configuration confirmed-reject | |
| Tree | confirmed-reject | |
| Configurable | True |
generate-checkpoint
| Description | Generate a checkpoint point based on the current running configuration | |
| Context | system configuration generate-checkpoint | |
| Tree | generate-checkpoint | |
| Configurable | True |
comment string
| Description | User provided comment to associate with the checkpoint | |
| Context | system configuration generate-checkpoint comment string | |
| Tree | comment | |
| Configurable | True |
name string
| Description | User provided name of the checkpoint | |
| Context | system configuration generate-checkpoint name string | |
| Tree | name | |
| Configurable | True |
rescue-clear
| Description | Remove rescue configuration | |
| Context | system configuration rescue-clear | |
| Tree | rescue-clear | |
| Configurable | True |
rescue-save
| Description | Save current running configuration as rescue configuration - rescue-config.json | |
| Context | system configuration rescue-save | |
| Tree | rescue-save | |
| Configurable | True |
save
| Description | Save current running configuration as initial (startup) configuration - config.json | |
| Context | system configuration save | |
| Tree | save | |
| Configurable | True |
session id number
| Description | List of configuration sessions currently active | |
| Context | system configuration session id number | |
| Tree | session | |
| Configurable | True |
id number
| Description | System generated ID for the configuration session | |
| Context | system configuration session id number | |
| Configurable | True |
clear
upgrade
| Description | Operational commands related to configuration upgrade | |
| Context | system configuration upgrade | |
| Tree | upgrade | |
| Configurable | True |
checkpoint id (number | checkpoint-name)
| Description | List of configuration checkpoints | |
| Context | system configuration upgrade checkpoint id (number | checkpoint-name) | |
| Tree | checkpoint | |
| Configurable | True |
id (number | checkpoint-name)
| Description | System generated ID, or operator defined name for the checkpoint | |
| Context | system configuration upgrade checkpoint id (number | checkpoint-name) | |
| Configurable | True |
file string
| Description | System file path to a json configuration file | |
| Context | system configuration upgrade file string | |
| Tree | file | |
| Configurable | True |
rescue
| Description | Rescue configuration | |
| Context | system configuration upgrade rescue | |
| Tree | rescue | |
| Configurable | True |
startup
| Description | Startup (initial) configuration | |
| Context | system configuration upgrade startup | |
| Tree | startup | |
| Configurable | True |
dhcp-server
| Description | Enable the dhcp-server context | |
| Context | system dhcp-server | |
| Tree | dhcp-server | |
| Configurable | True |
network-instance name string
| Description | List of network instances to run a dhcp server in | |
| Context | system dhcp-server network-instance name string | |
| Tree | network-instance | |
| Configurable | True |
name string
| Description | Network Instance | |
| Context | system dhcp-server network-instance name string | |
| String Length | 1 to 255 | |
| Configurable | True |
dhcpv4
| Description | Enter the dhcpv4 context | |
| Context | system dhcp-server network-instance name string dhcpv4 | |
| Tree | dhcpv4 | |
| Configurable | True |
statistics
| Description | Enter the statistics context | |
| Context | system dhcp-server network-instance name string dhcpv4 statistics | |
| Tree | statistics | |
| Configurable | True |
clear
| Description | Enter the clear context | |
| Context | system dhcp-server network-instance name string dhcpv4 statistics clear | |
| Tree | clear | |
| Configurable | True |
dhcpv6
| Description | Enter the dhcpv6 context | |
| Context | system dhcp-server network-instance name string dhcpv6 | |
| Tree | dhcpv6 | |
| Configurable | True |
statistics
| Description | Enter the statistics context | |
| Context | system dhcp-server network-instance name string dhcpv6 statistics | |
| Tree | statistics | |
| Configurable | True |
clear
| Description | Enter the clear context | |
| Context | system dhcp-server network-instance name string dhcpv6 statistics clear | |
| Tree | clear | |
| Configurable | True |
packet-trace-base64
| Description | Tools command to report the forwarding behavior for a specified test packet (packet specified in base64 format) | |
| Context | system packet-trace-base64 | |
| Tree | packet-trace-base64 | |
| Configurable | True |
interface string
| Description | References the configured name of the interface in which to inject the probe packet | |
| Context | system packet-trace-base64 interface string | |
| Tree | interface | |
| Configurable | True |
packet binary
| Description | Packet content encoded in base64 string format | |
| Context | system packet-trace-base64 packet binary | |
| Tree | packet | |
| Configurable | True |
tls
generate-csr
| Description | Generates a certificate signing request and key pair Fields for the certificate are taken from OpenSSL defaults, with the exception of the common name, which is taken from the system host name and domain name combination. | |
| Context | system tls generate-csr | |
| Tree | generate-csr | |
| Configurable | True |
common-name string
| Description | The common name to use for the certificate signing request By default the common name is set to the system host name and domain name combination. | |
| Context | system tls generate-csr common-name string | |
| Tree | common-name | |
| String Length | 1 to 64 | |
| Configurable | True |
country string
| Description | The country name to use for the certificate signing request The expected format is two characters long, e.g. 'US'. | |
| Context | system tls generate-csr country string | |
| Tree | country | |
| String Length | 2 | |
| Default | US | |
| Configurable | True |
email string
| Description | The email address to use for the certificate signing request | |
| Context | system tls generate-csr email string | |
| Tree | ||
| String Length | 1 to 255 | |
| Configurable | True |
locality string
| Description | The city or locality to use for the certificate signing request | |
| Context | system tls generate-csr locality string | |
| Tree | locality | |
| String Length | 1 to 255 | |
| Configurable | True |
organization string
| Description | The organization to use for the certificate signing request | |
| Context | system tls generate-csr organization string | |
| Tree | organization | |
| String Length | 1 to 255 | |
| Configurable | True |
organization-unit string
| Description | The organization unit to use for the certificate signing request | |
| Context | system tls generate-csr organization-unit string | |
| Tree | organization-unit | |
| String Length | 1 to 255 | |
| Configurable | True |
state string
| Description | The state or province to use for the certificate signing request | |
| Context | system tls generate-csr state string | |
| Tree | state | |
| String Length | 1 to 255 | |
| Configurable | True |
generate-self-signed
| Description | Generates a self signed certificate and key pair Fields for the self signed certificate are taken from OpenSSL defaults, with the exception of the common name, which is taken from the system host name and domain name combination. | |
| Context | system tls generate-self-signed | |
| Tree | generate-self-signed | |
| Configurable | True |
common-name string
| Description | The common name to use for the certificate signing request By default the common name is set to the system host name and domain name combination. | |
| Context | system tls generate-self-signed common-name string | |
| Tree | common-name | |
| String Length | 1 to 64 | |
| Configurable | True |
country string
| Description | The country name to use for the certificate signing request The expected format is two characters long, e.g. 'US'. | |
| Context | system tls generate-self-signed country string | |
| Tree | country | |
| String Length | 2 | |
| Default | US | |
| Configurable | True |
duration number
| Description | The time in which the certificate is valid | |
| Context | system tls generate-self-signed duration number | |
| Tree | duration | |
| Range | 1 to 3650 | |
| Default | 365 | |
| Units | days | |
| Configurable | True |
email string
| Description | The email address to use for the certificate signing request | |
| Context | system tls generate-self-signed email string | |
| Tree | ||
| String Length | 1 to 255 | |
| Configurable | True |
locality string
| Description | The city or locality to use for the certificate signing request | |
| Context | system tls generate-self-signed locality string | |
| Tree | locality | |
| String Length | 1 to 255 | |
| Configurable | True |
organization string
| Description | The organization to use for the certificate signing request | |
| Context | system tls generate-self-signed organization string | |
| Tree | organization | |
| String Length | 1 to 255 | |
| Configurable | True |
organization-unit string
| Description | The organization unit to use for the certificate signing request | |
| Context | system tls generate-self-signed organization-unit string | |
| Tree | organization-unit | |
| String Length | 1 to 255 | |
| Configurable | True |
state string
| Description | The state or province to use for the certificate signing request | |
| Context | system tls generate-self-signed state string | |
| Tree | state | |
| String Length | 1 to 255 | |
| Configurable | True |