tools system
system
+ aaa
+ authentication
+ force-all-user-password-change
+ session id number
+ disconnect
+ user username string
+ force-password-change
+ unlock
+ authorization
+ authz-policy
+ clear
+ probe
+ rpc string
+ user string
+ remove
+ rotate
+ created-on number
+ policy string
+ version string
+ app-management
+ application name string
+ kill
+ quit
+ reload
+ restart
+ cold
+ warm
+ start
+ statistics
+ clear
+ stop
+ boot
+ golden-image
+ clear
+ image string
+ cgroup
+ configuration
+ candidate name string
+ clear
+ checkpoint id (number | checkpoint-name)
+ clear
+ load
+ revert
+ confirmed-accept
+ persist-id string
+ confirmed-reject
+ persist-id string
+ 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
+ validation-check keyword
+ dhcp-relay
+ update-dns-entries
+ dhcp-server
+ network-instance name string
+ dhcpv4
+ statistics
+ clear
+ dhcpv6
+ statistics
+ clear
+ event-handler
+ instance name string
+ reload
+ statistics
+ clear
+ gnoi
+ healthz
+ chassis
+ clear
+ clear
+ control
+ clear
+ slot string
+ fabric
+ clear
+ slot number
+ fan-tray
+ clear
+ id number
+ linecard
+ clear
+ slot number
+ power-supply
+ clear
+ id number
+ transceiver
+ clear
+ interface string
+ grpc-server name string
+ client id number
+ disconnect
+ gnoi
+ healthz
+ chassis
+ clear
+ clear
+ control
+ clear
+ slot string
+ fabric
+ clear
+ slot number
+ fan-tray
+ clear
+ id number
+ linecard
+ clear
+ slot number
+ power-supply
+ clear
+ id number
+ transceiver
+ clear
+ interface string
+ statistics
+ clear
+ l2cp-transparency
+ dot1x
+ clear
+ l2cp-total-statistics
+ clear
+ lacp
+ clear
+ lldp
+ clear
+ ptp
+ clear
+ xstp
+ clear
+ lldp
+ interface name string
+ statistics
+ clear
+ statistics
+ clear
+ mirroring
+ mirroring-instance name string
+ mirror-destination
+ statistics
+ clear
+ packet-trace-base64
+ interface string
+ packet binary
+ sync
+ ptp
+ instance instance-index number
+ clear-statistics
+ default-ds
+ statistics
+ clear
+ time-recovery-engine
+ statistics
+ clear
+ inactive-peers
+ clear
+ port-ds-configured-peer port-index number
+ statistics
+ clear
+ port-ds-discovered-peer port-index number
+ statistics
+ clear
+ port-ds-interface port-index number
+ statistics
+ clear
+ tls
+ generate-csr
+ common-name string
+ country string
+ domain-names string
+ email string
+ ip-addresses (ipv4-address | ipv6-address)
+ key-size number
+ key-type keyword
+ locality string
+ organization string
+ organization-unit string
+ spiffe-id string
+ state string
+ type keyword
+ generate-self-signed
+ common-name string
+ country string
+ domain-names string
+ duration number
+ email string
+ ip-addresses (ipv4-address | ipv6-address)
+ key-size number
+ key-type keyword
+ locality string
+ organization string
+ organization-unit string
+ spiffe-id string
+ state string
+ type keyword
+ server-profile name string
+ certz
+ remove
+ rotate
+ certificate string
+ created-on number
+ crl string
+ key string
+ trust-anchor string
+ version string
system Descriptions
system
aaa
authentication
| Description | Operational commands related to authentication | |
| Context | system aaa authentication | |
| Tree | authentication | |
| Configurable | True | |
| Platforms | Supported on all platforms |
force-all-user-password-change
| Description | Set change-on-first-login to true for all users This command will only take effect if the feature change-on-first-login is currently set to true. | |
| Context | system aaa authentication force-all-user-password-change | |
| Tree | force-all-user-password-change | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
session id number
id number
| Description | System generated session ID | |
| Context | system aaa authentication session id number | |
| Configurable | True | |
| Platforms | Supported on all platforms |
disconnect
| Description | Disconnect the cli session, requesting the cli to terminate | |
| Context | system aaa authentication session id number disconnect | |
| Tree | disconnect | |
| Configurable | True | |
| Platforms | Supported on all platforms |
user username string
username string
| Description | Enter the username context | |
| Context | system aaa authentication user username string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
force-password-change
| Description | Set change-on-first-login to true for this user This command will only take effect if the feature change-on-first-login is currently set to true. | |
| Context | system aaa authentication user username string force-password-change | |
| Tree | force-password-change | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
unlock
authorization
| Description | Operational commands relating to authorization | |
| Context | system aaa authorization | |
| Tree | authorization | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
authz-policy
| Description | Top-level container for operational commands relating to Authz gRPC policies | |
| Context | system aaa authorization authz-policy | |
| Tree | authz-policy | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear Authz authorization policy counters | |
| Context | system aaa authorization authz-policy clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
probe
| Description | Perform a test against the current policy Both a user and rpc must be provided. | |
| Context | system aaa authorization authz-policy probe | |
| Tree | probe | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
rpc string
| Description | The RPC to test access to as the provided user This follows the gNSI gRPC path format, in that it is /<pkg>.<service>/<rpc>, for example /gnmi.gNMI/Get. | |
| Context | system aaa authorization authz-policy probe rpc string | |
| Tree | rpc | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
user string
| Description | The user to test the current policy with This can be either a SPIFFE URI or username. | |
| Context | system aaa authorization authz-policy probe user string | |
| Tree | user | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
remove
| Description | Remove Authz authorization policy from the system Since there is only a single system-wide gRPC authorization policy, it will revert its contents to the factory default authorization policy which authorizes any gRPC calls for every user. | |
| Context | system aaa authorization authz-policy remove | |
| Tree | remove | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
rotate
| Description | Perform a rotation of the Authz gRPC policy | |
| Context | system aaa authorization authz-policy rotate | |
| Tree | rotate | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
created-on number
| Description | Sets the created on value for the new policy Value is the number of seconds since the epoch. For reference the current time from the epoch in most Linux distributions can be retrieved via 'date +%s'. You can also select a specific date via 'date -d "2023-03-31" +%s'. If no value is provided the systems current date and time is used. | |
| Context | system aaa authorization authz-policy rotate created-on number | |
| Tree | created-on | |
| Units | seconds | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
policy string
| Description | Contains the gRPC authorization policy as a JSON-formatted string For example: { "name": "Default policy", "allow_rules": [{ "name": "admin-access", "source": { "principals": [ "admin" ] }, "request": { "paths": [ "/*" ] } }] } | |
| Context | system aaa authorization authz-policy rotate policy string | |
| Tree | policy | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
version string
| Description | A version string to store with the policy No constraints are applied other than the value must be a string. If no value is provided no default is used. | |
| Context | system aaa authorization authz-policy rotate version string | |
| Tree | version | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
app-management
| Description | Operational commands related to app-management | |
| Context | system app-management | |
| Tree | app-management | |
| Configurable | True | |
| Platforms | Supported on all platforms |
application name string
| Description | List of all applications managed by the application manager | |
| Context | system app-management application name string | |
| Tree | application | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name string
| Description | Unique name of this application instance | |
| Context | system app-management application name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
kill
| Description | Terminate the application instance ungracefully | |
| Context | system app-management application name string kill | |
| Tree | kill | |
| Configurable | True | |
| Platforms | Supported on all platforms |
quit
| Description | Terminate the application instance, requesting it to core dump | |
| Context | system app-management application name string quit | |
| Tree | quit | |
| Configurable | True | |
| Platforms | Supported on all platforms |
reload
| Description | Reload the configuration of the application instance | |
| Context | system app-management application name string reload | |
| Tree | reload | |
| Configurable | True | |
| Platforms | Supported on all platforms |
restart
| Description | Restart the application instance The best restart that is supported by the application is used if neither 'warm' or 'cold' is specified. If 'warm' restart is supported that will be used, or 'cold' if 'warm' is unavailable. A 'warm' restart will result in the application leaving its state in IDB during the restart, and recovering it post restart. This restart type results in less disruption to surrounding applications that would depend on the restarting applications state. A 'cold' restart will result in a normal stop/start of the application, including the purging of its state in IDB. | |
| Context | system app-management application name string restart | |
| Tree | restart | |
| Configurable | True | |
| Platforms | Supported on all platforms |
cold
| Description | Perform a cold restart of the application instance | |
| Context | system app-management application name string restart cold | |
| Tree | cold | |
| Configurable | True | |
| Platforms | Supported on all platforms |
warm
| Description | Perform a warm restart of the application instance | |
| Context | system app-management application name string restart warm | |
| Tree | warm | |
| Configurable | True | |
| Platforms | Supported on all platforms |
start
| Description | Start the application instance | |
| Context | system app-management application name string start | |
| Tree | start | |
| Configurable | True | |
| Platforms | Supported on all platforms |
statistics
| Description | Top-level grouping of operational commands related to application statistics | |
| Context | system app-management application name string statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | Supported on all platforms |
clear
| Description | Clear statistics for this application instance | |
| Context | system app-management application name string statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | Supported on all platforms |
stop
| Description | Terminate the application instance gracefully | |
| Context | system app-management application name string stop | |
| Tree | stop | |
| Configurable | True | |
| Platforms | Supported on all platforms |
boot
golden-image
| Description | Container for operational commands related to golden image | |
| Context | system boot golden-image | |
| Tree | golden-image | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Unset the golden-image | |
| Context | system boot golden-image clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
image string
| Description | Sets the golden image the system uses This command selects an image to act as a golden-image to which the system reverts when a factory reset operation is requested. | |
| Context | system boot golden-image image string | |
| Tree | image | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
cgroup
configuration
| Description | Top-level container for operational commands related to the system configuration | |
| Context | system configuration | |
| Tree | configuration | |
| Configurable | True | |
| Platforms | Supported on all platforms |
candidate name string
| Description | List of configuration candidates currently active | |
| Context | system configuration candidate name string | |
| Tree | candidate | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name string
| Description | The name of the candidate | |
| Context | system configuration candidate name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
clear
| Description | Clear the checkpoint from the system | |
| Context | system configuration checkpoint id (number | checkpoint-name) clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | Supported on all platforms |
load
| Description | Load candidate from saved checkpoint configuration | |
| Context | system configuration checkpoint id (number | checkpoint-name) load | |
| Tree | load | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
confirmed-accept
| Description | Accepts an in progress commit and stops the confirmation timer | |
| Context | system configuration confirmed-accept | |
| Tree | confirmed-accept | |
| Configurable | True | |
| Platforms | Supported on all platforms |
persist-id string
| Description | Specifies the persist-id to which the commit confirmed accept applies | |
| Context | system configuration confirmed-accept persist-id string | |
| Tree | persist-id | |
| Configurable | True | |
| Platforms | Supported on all platforms |
confirmed-reject
| Description | Rejects an in progress commit and stops the confirmation timer | |
| Context | system configuration confirmed-reject | |
| Tree | confirmed-reject | |
| Configurable | True | |
| Platforms | Supported on all platforms |
persist-id string
| Description | Specifies the persist-id to which the commit confirmed reject applies | |
| Context | system configuration confirmed-reject persist-id string | |
| Tree | persist-id | |
| Configurable | True | |
| Platforms | Supported on all platforms |
generate-checkpoint
| Description | Generate a checkpoint point based on the current running configuration | |
| Context | system configuration generate-checkpoint | |
| Tree | generate-checkpoint | |
| Configurable | True | |
| Platforms | Supported on all platforms |
comment string
| Description | User provided comment to associate with the checkpoint | |
| Context | system configuration generate-checkpoint comment string | |
| Tree | comment | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name string
| Description | User provided name of the checkpoint | |
| Context | system configuration generate-checkpoint name string | |
| Tree | name | |
| Configurable | True | |
| Platforms | Supported on all platforms |
rescue-clear
| Description | Remove rescue configuration | |
| Context | system configuration rescue-clear | |
| Tree | rescue-clear | |
| Configurable | True | |
| Platforms | Supported on all platforms |
rescue-save
| Description | Save current running configuration as rescue configuration - rescue-config.json | |
| Context | system configuration rescue-save | |
| Tree | rescue-save | |
| Configurable | True | |
| Platforms | Supported on all platforms |
save
| Description | Save current running configuration as initial (startup) configuration - config.json | |
| Context | system configuration save | |
| Tree | save | |
| Configurable | True | |
| Platforms | Supported on all platforms |
session id number
| Description | List of configuration sessions currently active | |
| Context | system configuration session id number | |
| Tree | session | |
| Configurable | True | |
| Platforms | Supported on all platforms |
id number
| Description | System generated ID for the configuration session | |
| Context | system configuration session id number | |
| Configurable | True | |
| Platforms | Supported on all platforms |
clear
upgrade
| Description | Operational commands related to configuration upgrade | |
| Context | system configuration upgrade | |
| Tree | upgrade | |
| Configurable | True | |
| Platforms | Supported on all platforms |
checkpoint id (number | checkpoint-name)
| Description | List of configuration checkpoints | |
| Context | system configuration upgrade checkpoint id (number | checkpoint-name) | |
| Tree | checkpoint | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
file string
| Description | System file path to a json configuration file | |
| Context | system configuration upgrade file string | |
| Tree | file | |
| Configurable | True | |
| Platforms | Supported on all platforms |
rescue
| Description | Rescue configuration | |
| Context | system configuration upgrade rescue | |
| Tree | rescue | |
| Configurable | True | |
| Platforms | Supported on all platforms |
startup
| Description | Startup (initial) configuration | |
| Context | system configuration upgrade startup | |
| Tree | startup | |
| Configurable | True | |
| Platforms | Supported on all platforms |
validation-check keyword
| Description | Specifies the kind of validation that will be executed after the content is upgraded If the validation fails the upgraded content will not be persisted. | |
| Context | system configuration upgrade validation-check keyword | |
| Tree | validation-check | |
| Default | replace | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
dhcp-relay
| Description | Enable the dhcp-relay context | |
| Context | system dhcp-relay | |
| Tree | dhcp-relay | |
| Configurable | True | |
| Platforms | Supported on all platforms |
update-dns-entries
| Description | Update all dhcp-relay server domain name resolutions A server host entry that cannot be resolved will be unavailable until it can be successfully resolved. | |
| Context | system dhcp-relay update-dns-entries | |
| Tree | update-dns-entries | |
| Configurable | True | |
| Platforms | Supported on all platforms |
dhcp-server
| Description | Enable the dhcp-server context | |
| Context | system dhcp-server | |
| Tree | dhcp-server | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
name string
| Description | Network Instance | |
| Context | system dhcp-server network-instance name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
dhcpv4
| Description | Enter the dhcpv4 context | |
| Context | system dhcp-server network-instance name string dhcpv4 | |
| Tree | dhcpv4 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
statistics
| Description | Enter the statistics context | |
| Context | system dhcp-server network-instance name string dhcpv4 statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | Supported on all platforms |
clear
| Description | Enter the clear context | |
| Context | system dhcp-server network-instance name string dhcpv4 statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | Supported on all platforms |
dhcpv6
| Description | Enter the dhcpv6 context | |
| Context | system dhcp-server network-instance name string dhcpv6 | |
| Tree | dhcpv6 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
statistics
| Description | Enter the statistics context | |
| Context | system dhcp-server network-instance name string dhcpv6 statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | Supported on all platforms |
clear
| Description | Enter the clear context | |
| Context | system dhcp-server network-instance name string dhcpv6 statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | Supported on all platforms |
event-handler
| Description | Top-level container for operational commands on event handler and event handling instances | |
| Context | system event-handler | |
| Tree | event-handler | |
| Configurable | True | |
| Platforms | Supported on all platforms |
instance name string
| Description | List of all event handler instances | |
| Context | system event-handler instance name string | |
| Tree | instance | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 20 |
name string
| Description | A user-defined name for this event handler instance | |
| Context | system event-handler instance name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
reload
statistics
| Description | Top-level container for operational commands on event handler statistics | |
| Context | system event-handler instance name string statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | Supported on all platforms |
clear
| Description | Clear statistics for this event handler instance | |
| Context | system event-handler instance name string statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | Supported on all platforms |
gnoi
| Description | Top-level container for operational commands related to gNOI | |
| Context | system gnoi | |
| Tree | gnoi | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
healthz
chassis
clear
| Description | Clear healthz events for this component | |
| Context | system gnoi healthz chassis clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
control
clear
| Description | Clear healthz events for this component | |
| Context | system gnoi healthz control clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
slot string
| Description | Slot identifier for the control module | |
| Context | system gnoi healthz control slot string | |
| Tree | slot | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
fabric
clear
| Description | Clear healthz events for this component | |
| Context | system gnoi healthz fabric clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
slot number
| Description | Numeric identifier for the fabric module | |
| Context | system gnoi healthz fabric slot number | |
| Tree | slot | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
fan-tray
clear
| Description | Clear healthz events for this component | |
| Context | system gnoi healthz fan-tray clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
id number
| Description | Numeric identifier for the fan module | |
| Context | system gnoi healthz fan-tray id number | |
| Tree | id | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
linecard
clear
| Description | Clear healthz events for this component | |
| Context | system gnoi healthz linecard clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
slot number
| Description | Numeric identifier for the line card | |
| Context | system gnoi healthz linecard slot number | |
| Tree | slot | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
power-supply
| Description | Power supply component | |
| Context | system gnoi healthz power-supply | |
| Tree | power-supply | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system gnoi healthz power-supply clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
id number
| Description | Numeric identifier for the power supply module | |
| Context | system gnoi healthz power-supply id number | |
| Tree | id | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
transceiver
| Description | Transceiver component | |
| Context | system gnoi healthz transceiver | |
| Tree | transceiver | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system gnoi healthz transceiver clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
interface string
| Description | Interface name for the transceiver module | |
| Context | system gnoi healthz transceiver interface string | |
| Tree | interface | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
grpc-server name string
| Description | List of configured gRPC server instances | |
| Context | system grpc-server name string | |
| Tree | grpc-server | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
name string
| Description | User-provided name of this server instance | |
| Context | system grpc-server name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
client id number
| Description | List of active gRIBI client sessions | |
| Context | system grpc-server name string client id number | |
| Tree | client | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
id number
| Description | System generated ID for for the client | |
| Context | system grpc-server name string client id number | |
| Range | 0 to 4294967295 | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
disconnect
| Description | Disconnect this client from the server | |
| Context | system grpc-server name string client id number disconnect | |
| Tree | disconnect | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
gnoi
| Description | Top-level container for operational commands related to gNOI | |
| Context | system grpc-server name string gnoi | |
| Tree | gnoi | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
healthz
| Description | gNOI Healthz tools commands | |
| Context | system grpc-server name string gnoi healthz | |
| Tree | healthz | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
chassis
| Description | Chassis component | |
| Context | system grpc-server name string gnoi healthz chassis | |
| Tree | chassis | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system grpc-server name string gnoi healthz chassis clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear all healthz events | |
| Context | system grpc-server name string gnoi healthz clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
control
| Description | Control module component | |
| Context | system grpc-server name string gnoi healthz control | |
| Tree | control | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system grpc-server name string gnoi healthz control clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
slot string
| Description | Slot identifier for the control module | |
| Context | system grpc-server name string gnoi healthz control slot string | |
| Tree | slot | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
fabric
| Description | Fabric module component | |
| Context | system grpc-server name string gnoi healthz fabric | |
| Tree | fabric | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system grpc-server name string gnoi healthz fabric clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
slot number
| Description | Numeric identifier for the fabric module | |
| Context | system grpc-server name string gnoi healthz fabric slot number | |
| Tree | slot | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
fan-tray
| Description | Fan component | |
| Context | system grpc-server name string gnoi healthz fan-tray | |
| Tree | fan-tray | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system grpc-server name string gnoi healthz fan-tray clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
id number
| Description | Numeric identifier for the fan module | |
| Context | system grpc-server name string gnoi healthz fan-tray id number | |
| Tree | id | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
linecard
| Description | Line card component | |
| Context | system grpc-server name string gnoi healthz linecard | |
| Tree | linecard | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system grpc-server name string gnoi healthz linecard clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
slot number
| Description | Numeric identifier for the line card | |
| Context | system grpc-server name string gnoi healthz linecard slot number | |
| Tree | slot | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
power-supply
| Description | Power supply component | |
| Context | system grpc-server name string gnoi healthz power-supply | |
| Tree | power-supply | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system grpc-server name string gnoi healthz power-supply clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
id number
| Description | Numeric identifier for the power supply module | |
| Context | system grpc-server name string gnoi healthz power-supply id number | |
| Tree | id | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
transceiver
| Description | Transceiver component | |
| Context | system grpc-server name string gnoi healthz transceiver | |
| Tree | transceiver | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear healthz events for this component | |
| Context | system grpc-server name string gnoi healthz transceiver clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
interface string
| Description | Interface name for the transceiver module | |
| Context | system grpc-server name string gnoi healthz transceiver interface string | |
| Tree | interface | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
statistics
| Description | A collection of counters that were collected by the gRPC during the authentication process. | |
| Context | system grpc-server name string statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
clear
| Description | Clear gNMI network instance authentication counters | |
| Context | system grpc-server name string statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
l2cp-transparency
| Description | Enable the l2cp-transparency context | |
| Context | system l2cp-transparency | |
| Tree | l2cp-transparency | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
dot1x
| Description | Enter the dot1x context | |
| Context | system l2cp-transparency dot1x | |
| Tree | dot1x | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
clear
| Description | Clears the statistics for the 802.1x Port based Network Access Control protocol. | |
| Context | system l2cp-transparency dot1x clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
l2cp-total-statistics
| Description | Enter the l2cp-total-statistics context | |
| Context | system l2cp-transparency l2cp-total-statistics | |
| Tree | l2cp-total-statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
clear
| Description | Clears the global statistics for the L2CP protocols. | |
| Context | system l2cp-transparency l2cp-total-statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
lacp
| Description | Enter the lacp context | |
| Context | system l2cp-transparency lacp | |
| Tree | lacp | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
clear
| Description | Clears the statistics for Link Aggregation Control Protocol. | |
| Context | system l2cp-transparency lacp clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
lldp
| Description | Enter the lldp context | |
| Context | system l2cp-transparency lldp | |
| Tree | lldp | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
clear
| Description | Clears the statistics for Link Layer Discovery Protocol. | |
| Context | system l2cp-transparency lldp clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
ptp
| Description | Enter the ptp context | |
| Context | system l2cp-transparency ptp | |
| Tree | ptp | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
clear
| Description | Clears the statistics for the Precision Time Protocol . | |
| Context | system l2cp-transparency ptp clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
xstp
| Description | Enter the xstp context | |
| Context | system l2cp-transparency xstp | |
| Tree | xstp | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
clear
| Description | Clears the statistics for all the Spanning Tree Protocols. | |
| Context | system l2cp-transparency xstp clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5 |
lldp
interface name string
name string
statistics
| Description | LLDP interface statistics tools commands | |
| Context | system lldp interface name string statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | Supported on all platforms |
clear
statistics
| Description | LLDP global statistics tools commands | |
| Context | system lldp statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | Supported on all platforms |
clear
| Description | Clear global LLDP statistics | |
| Context | system lldp statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | Supported on all platforms |
mirroring
mirroring-instance name string
| Description | Enter the mirroring-instance list instance | |
| Context | system mirroring mirroring-instance name string | |
| Tree | mirroring-instance | |
| Configurable | True | |
| Platforms | 7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10e, 7250 IXR-6e |
name string
| Description | A unique name identifying the mirroring instance | |
| Context | system mirroring mirroring-instance name string | |
| Configurable | True | |
| Platforms | 7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10e, 7250 IXR-6e |
mirror-destination
| Description | Configure mirror destination | |
| Context | system mirroring mirroring-instance name string mirror-destination | |
| Tree | mirror-destination | |
| Configurable | True | |
| Platforms | 7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10e, 7250 IXR-6e |
statistics
| Description | Enter the statistics context | |
| Context | system mirroring mirroring-instance name string mirror-destination statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10e, 7250 IXR-6e |
clear
| Description | Enter the clear context | |
| Context | system mirroring mirroring-instance name string mirror-destination statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10e, 7250 IXR-6e |
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 | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
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 | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
packet binary
| Description | Packet content encoded in base64 string format | |
| Context | system packet-trace-base64 packet binary | |
| Tree | packet | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
sync
ptp
instance instance-index number
instance-index number
| Description | Enter the instance-index context | |
| Context | system sync ptp instance instance-index number | |
| Range | 1 to 10 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
clear-statistics
| Description | Clears all PTP statistics for PTP | |
| Context | system sync ptp instance instance-index number clear-statistics | |
| Tree | clear-statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
default-ds
| Description | The default data set of the PTP Instance In the context of the protocol, this data set is required for an Ordinary Clock or Boundary Clock | |
| Context | system sync ptp instance instance-index number default-ds | |
| Tree | default-ds | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
statistics
| Description | Enter the statistics context | |
| Context | system sync ptp instance instance-index number default-ds statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
clear
| Description | Clears PTP statistics and event counters in the default-ds | |
| Context | system sync ptp instance instance-index number default-ds statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
time-recovery-engine
| Description | Enter the time-recovery-engine context | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine | |
| Tree | time-recovery-engine | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
statistics
| Description | Enter the statistics context | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
clear
| Description | Clears all PTP statistics for PTP time recovery engine | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
inactive-peers
| Description | Enter the inactive-peers context | |
| Context | system sync ptp instance instance-index number inactive-peers | |
| Tree | inactive-peers | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
clear
| Description | Clears information related to inactive PTP peers | |
| Context | system sync ptp instance instance-index number inactive-peers clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
port-ds-configured-peer port-index number
| Description | Grouping for PTP Port DS for configured IP peers operational commands | |
| Context | system sync ptp instance instance-index number port-ds-configured-peer port-index number | |
| Tree | port-ds-configured-peer | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
port-index number
| Description | Enter the port-index context | |
| Context | system sync ptp instance instance-index number port-ds-configured-peer port-index number | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
statistics
| Description | Enter the statistics context | |
| Context | system sync ptp instance instance-index number port-ds-configured-peer port-index number statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
clear
| Description | Clears all PTP statistics for this PTP Port DS | |
| Context | system sync ptp instance instance-index number port-ds-configured-peer port-index number statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
port-ds-discovered-peer port-index number
| Description | Grouping for PTP Port DS for discovered IP peers operational commands | |
| Context | system sync ptp instance instance-index number port-ds-discovered-peer port-index number | |
| Tree | port-ds-discovered-peer | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
port-index number
| Description | Enter the port-index context | |
| Context | system sync ptp instance instance-index number port-ds-discovered-peer port-index number | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
statistics
| Description | Enter the statistics context | |
| Context | system sync ptp instance instance-index number port-ds-discovered-peer port-index number statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
clear
| Description | Clears all PTP statistics for this PTP Port DS | |
| Context | system sync ptp instance instance-index number port-ds-discovered-peer port-index number statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
port-ds-interface port-index number
| Description | Grouping for PTP Port DS for interfaces operational commands | |
| Context | system sync ptp instance instance-index number port-ds-interface port-index number | |
| Tree | port-ds-interface | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
port-index number
| Description | Enter the port-index context | |
| Context | system sync ptp instance instance-index number port-ds-interface port-index number | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
statistics
| Description | Enter the statistics context | |
| Context | system sync ptp instance instance-index number port-ds-interface port-index number statistics | |
| Tree | statistics | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
clear
| Description | Clears all PTP statistics for this PTP Port DS | |
| Context | system sync ptp instance instance-index number port-ds-interface port-index number statistics clear | |
| Tree | clear | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
domain-names string
| Description | Domain names to add to the SubjectAlternativeName field within the certificate signing request These names are encoeded as DNS:<name> within the certificate SAN. | |
| Context | system tls generate-csr domain-names string | |
| Tree | domain-names | |
| String Length | 1 to 253 | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 32 |
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 | |
| Platforms | Supported on all platforms |
ip-addresses (ipv4-address | ipv6-address)
| Description | IP addresses to add to the SubjectAlternativeName field within the certificate signing request These addresses are encoded as IP:<ip> within the certificate SAN. | |
| Context | system tls generate-csr ip-addresses (ipv4-address | ipv6-address) | |
| Tree | ip-addresses | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 32 |
key-size number
| Description | The size of the private key to generate for the certificate signing request | |
| Context | system tls generate-csr key-size number | |
| Tree | key-size | |
| Range | 1024 to 16384 | |
| Default | 4096 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
key-type keyword
| Description | The type of private key to generate for the certificate signing request | |
| Context | system tls generate-csr key-type keyword | |
| Tree | key-type | |
| Default | rsa | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
spiffe-id string
| Description | A SPIFFE ID to use for the certificate signing request This ID is in URI form, including the leading 'spiffe://', for example 'spiffe://srlinux.dev/sa/user'. | |
| Context | system tls generate-csr spiffe-id string | |
| Tree | spiffe-id | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
type keyword
| Description | The type of certificate to use for the certificate signing request | |
| Context | system tls generate-csr type keyword | |
| Tree | type | |
| Default | x509 | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
domain-names string
| Description | Domain names to add to the SubjectAlternativeName field within the certificate signing request These names are encoeded as DNS:<name> within the certificate SAN. | |
| Context | system tls generate-self-signed domain-names string | |
| Tree | domain-names | |
| String Length | 1 to 253 | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 32 |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
ip-addresses (ipv4-address | ipv6-address)
| Description | IP addresses to add to the SubjectAlternativeName field within the certificate signing request These addresses are encoded as IP:<ip> within the certificate SAN. | |
| Context | system tls generate-self-signed ip-addresses (ipv4-address | ipv6-address) | |
| Tree | ip-addresses | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 32 |
key-size number
| Description | The size of the private key to generate for the certificate signing request | |
| Context | system tls generate-self-signed key-size number | |
| Tree | key-size | |
| Range | 1024 to 16384 | |
| Default | 4096 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
key-type keyword
| Description | The type of private key to generate for the certificate signing request | |
| Context | system tls generate-self-signed key-type keyword | |
| Tree | key-type | |
| Default | rsa | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
spiffe-id string
| Description | A SPIFFE ID to use for the certificate signing request This ID is in URI form, including the leading 'spiffe://', for example 'spiffe://srlinux.dev/sa/user'. | |
| Context | system tls generate-self-signed spiffe-id string | |
| Tree | spiffe-id | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Platforms | Supported on all platforms |
type keyword
| Description | The type of certificate to use for the certificate signing request | |
| Context | system tls generate-self-signed type keyword | |
| Tree | type | |
| Default | x509 | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
server-profile name string
| Description | Enter the server-profile list instance | |
| Context | system tls server-profile name string | |
| Tree | server-profile | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name string
| Description | Name of the TLS server-profile | |
| Context | system tls server-profile name string | |
| String Length | 1 to 247 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
certz
| Description | Information relating to the active certificates and bundles as provided via Certz State is provided by the gNSI Certz service, and can be changed using the gNSI.Certz.Rotate RPC | |
| Context | system tls server-profile name string certz | |
| Tree | certz | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
remove
| Description | Remove Certz SSL profile from the system. | |
| Context | system tls server-profile name string certz remove | |
| Tree | remove | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
rotate
| Description | Perform a rotation of a certificate, trust anchor, or certificate revocation list within Certz SSL profile. | |
| Context | system tls server-profile name string certz rotate | |
| Tree | rotate | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
certificate string
| Description | Base64 encoded certificate to use with the provided or existing private key This includes the '-----BEGIN CERTIFICATE-----' and '-----END CERTIFICATE-----' header and footer | |
| Context | system tls server-profile name string certz rotate certificate string | |
| Tree | certificate | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
created-on number
| Description | Sets the created on value for the new policy Value is the number of seconds since the epoch. For reference the current time from the epoch in most Linux distributions can be retrieved via 'date +%s'. You can also select a specific date via 'date -d "2023-03-31" +%s'. If no value is provided the systems current date and time is used. | |
| Context | system tls server-profile name string certz rotate created-on number | |
| Tree | created-on | |
| Units | seconds | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
crl string
| Description | Base64 encoded bundle of certificates to add to the certificate revocation list | |
| Context | system tls server-profile name string certz rotate crl string | |
| Tree | crl | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
key string
| Description | Base64 encoded key to use with the server certificate This includes the '-----BEGIN PRIVATE KEY-----', and '-----END PRIVATE KEY-----' header and footer The value is hashed, and only the hashed value is kept | |
| Context | system tls server-profile name string certz rotate key string | |
| Tree | key | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
trust-anchor string
| Description | Base64 encoded certificate chain to use as a trust anchor | |
| Context | system tls server-profile name string certz rotate trust-anchor string | |
| Tree | trust-anchor | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |
version string
| Description | A version string to store with the policy No constraints are applied other than the value must be a string. If no value is provided no default is used. | |
| Context | system tls server-profile name string certz rotate version string | |
| Tree | version | |
| Configurable | True | |
| Platforms | 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e |