Command Line Reference
This reference is better understood if you know the basics of how to operate the PCLI. If you have not used the PCLI before, it is beneficial to first read the basics about the PCLI and the basics of the configuration management.
clear arp
Clear the entire ARP cache or a subset if arguments are provided.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | The device interface on which to clear the ARP cache (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
ip | The IP address for which to clear an ARP entry (must be specified after 'device-interface') [type: IP address] |
node | The name of the node |
router | The name of the router |
vlan | The VLAN on which to clear the ARP cache (must be specified after 'device-interface') [type: int] |
See Also
command | description |
---|---|
show arp | Shows the contents of the ARP table on the specified node. |
Description
The clear arp
command is typically used during troubleshooting, to remove ARP (Address Resolution Protocol) entries from a 128T router or node's ARP cache. The command has multiple filters, allowing administrators to specify which specific entry to remove. The PCLI will auto-complete typed entries for improved accuracy.
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
clear bgp
Clear routes associated with one or all BGP neighbors.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
in | Soft reset received BGP updates |
out | Soft reset transmitted BGP updates |
router | The name of the router for which to clear BGP neighbors |
soft | Soft reset received and transmitted BGP updates |
Positional Arguments
name | description |
---|---|
neighbor | neighbor ip-address [type: IP address or 'all'] |
See Also
command | description |
---|---|
show bgp | Displays information about the state of the BGP process on the 128T router. |
clear context router
Usage
Description
Clear both the router context and node context.
Version History
Release | Modification |
---|---|
5.0.0 | This feature has been removed |
See Also
- clear context node Clear only the node context
- set context router Set the context to a different router
- set context stats start-time Set the start time for show stats commands
clear context stats start-time
Usage
Description
Clears the start time for show stats commands.
Version History
Release | Modification |
---|---|
5.0.0 | This feature has been removed |
clear events admin
Usage
Description
Clears admin event records.
Version History
Release | Modification |
---|---|
4.5.0 | This feature has been removed |
clear events alarm
Usage
Description
Clears alarm event records.
Version History
Release | Modification |
---|---|
4.5.0 | This feature has been removed |
clear events all
Usage
Description
Clears all event records.
Version History
Release | Modification |
---|---|
4.5.0 | This feature has been removed |
clear events system
Usage
Description
Clears system event records.
Version History
Release | Modification |
---|---|
4.5.0 | This feature has been removed |
clear events traffic
Usage
Description
Clears traffic event records.
Version History
Release | Modification |
---|---|
4.5.0 | This feature has been removed |
clear history
Clear the PCLI's command history for this user.
Usage
See Also
command | description |
---|---|
show history | Show PCLI command history for the current user. |
clone
Clone the configuration of one router to create a new router with a new name and identical contents.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
Positional Arguments
name | description |
---|---|
name | An identifier for the router |
new-name | The new value for the router name |
Example
Description
The clone command duplicates the configuration data from the existing Boston
router into a new router with the name NewYork
, and stages it to the candidate configuration.
Version History
Release | Modification |
---|---|
5.0.0 | This feature was introduced |
commit
Commit the candidate config as the new running config.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
validate-local | Only validate the configuration on the Conductor |
Description
The commit
command causes the 128T router to validate the candidate configuration, and then replace the running configuration with the candidate configuration (assuming it passes the validation step). It is used once a series of configuration changes have been made, and an administrator wishes to "activate" those configuration changes.
When run from a 128T conductor, the conductor will first validate the configuration itself before distributing configuration to all of its managed routers for each of them to validate the configuration. After the managed routers have all reported the results of their validation, the commit activity takes place (assuming a successful validation). This distributed validation can be skipped by using the validate-local keyword argument.
The commit
command will prompt a user for confirmation, as this is a (potentially) service affecting command. By supplying the optional force
keyword, the confirmation step is skipped:
If the validation step fails, the administrator will be notified, the commit step is not executed, and the existing running configuration will remain in place. The validator will get a list of all errors that must be addressed before the commit can be completed. There may also be warnings displayed in the event that the candidate configuration contains elements that are deprecated.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | force feature was added |
compare config
Display the differences between two configurations.
Usage
Positional Arguments
name | description |
---|---|
old | The original configuration against which differences should be computed (default: running) |
new | The updated configuration for which differences should be computed |
See Also
command | description |
---|---|
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
The compare
command presents a list of differences between the two configurations specified as arguments on the command line. The one listed first influences the output in a very important way: the 128T router will return a list of configuration commands that will cause the configuration to be listed first to be brought to parity with the one listed second. (Note: since the only editable configuration is the "candidate" configuration, the changes outlined by the compare command cannot be directly applied to the "running" configuration.)
In the example below, the candidate and running configurations are identical save for a single service-route that has been added to the candidate configuration.
This shows that the running configuration is missing the candidate's service-route. By reversing the order of the arguments, the output changes:
Note here that the output shows that the running configuration has deleted the candidate configuration's service-route via the delete service-route force myRoute
statement. Cutting and pasting this configuration into the PCLI will affect the candidate configuration – and make it match the running configuration.
When two configurations are identical, comparing them will return that there are no changes to display:
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
configure
Usage
Description
The configure
command places administrators into the configuration tree (hierarchy), where they will be making changes to the candidate configuration. When entered as a standalone command (i.e., configure
by itself), the administrator is placed at the top of the configuration tree.
Alternatively, administrators may execute the configure
command with optional arguments to enter into configuration mode "deeper" in the configuration tree. For example:
By supplying optional arguments to the configure command as in the above example, the administrator has entered into the configuration tree at the "router" tier, within the router element named "Fabric128". Not only can administrators enter into the configuration tree at any point through this technique, but new configuration can also applied directly in this same way.
Required Fields
Some arguments and subcommands contain required fields for configuration. The configure
help text now identifies required fields. For example:
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
2.0.0 | Command was renamed to configure from config |
connect
Connect to a Managed Router. For more information, read Connecting to 128T Routers from Conductor.
Usage
Keyword Arguments
name | description |
---|---|
node | The node to connect to |
router | The router to connect to |
username | Username to use for login to the Managed Router (default: <current user>) |
create capture-filter
Creates a capture-filter using BPF syntax (as used in wireshark) on the target interface.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | The device interface on which to create the capture filter |
node | The node on which to create the capture filter |
router | The router on which to create the capture filter |
Positional Arguments
name | description |
---|---|
capture-filter | The capture-filter to create (Uses BPF syntax) |
See Also
command | description |
---|---|
delete capture-filter | Deletes a capture-filter created using create capture-filter. (It will not delete filters committed as part of the configuration.) |
show capture-filters | Show active capture-filters. |
show stats packet-capture | Stats pertaining to captured packets |
Example
Version History
Release | Modification |
---|---|
4.4.0 | This feature was introduced |
create certificate request webserver
Create a certificate signing request.
Usage
See Also
command | description |
---|---|
create certificate self-signed webserver | Create a self-signed certificate. |
delete certificate webserver | Delete the webserver certificate. |
import certificate webserver | Import a certificate to be used by the webserver. |
show certificate webserver | Display the webserver certificate |
Description
The create certificate request webserver
generates a certificate-request, which is then sent to a Certificate Authority. The 128T router will, through a series of interactive prompts, request information from the administrator to generate either the request or certificate, as appropriate.
The certificate created by the create certificate
command stores its output file at /etc/128technology/pki/
.
create certificate self-signed webserver
Create a self-signed certificate.
Usage
See Also
command | description |
---|---|
create certificate request webserver | Create a certificate signing request. |
delete certificate webserver | Delete the webserver certificate. |
import certificate webserver | Import a certificate to be used by the webserver. |
show certificate webserver | Display the webserver certificate |
Description
The create certificate self-signed webserver
generates a self-signed certificate which is used for the local webserver. The 128T router will, through a series of interactive prompts, request information from the administrator to generate either the request or certificate, as appropriate.
Example
create config autogenerated
Run configuration generation.
Usage
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
Force re-generation of all automatically generated configuration items. Both internal and plugin configuration generation is run when. Changes are staged into the candidate configuration.
Configuration generation is done automatically as part of a commit
. This command serves only to aid in debugging.
create session-capture
Creates a session capture at the specified node and service.
Usage
Keyword Arguments
name | description |
---|---|
destination-ip | The destination IP address/prefix to match [type: IP prefix] (default: 0.0.0.0/0) |
destination-port | The destination port to match (can be a range) [type: port or port-range] (default: 0-65535) |
local-only | Session capture is local to the node |
node | The ingress node on which to create the session capture |
packet-count | The number of packets to capture per session, in each direction [type: 'unlimited' or positive int] (default: 100) |
protocol | The protocol to match (in decimal or by name, eg 'tcp') [type: string or uint8] (default: all) |
router | The router on which to create the session capture |
service | The service on which to create the session capture |
session-count | The number of sessions to capture [type: 'unlimited' or positive int] (default: 100) |
source-ip | The source IP address/prefix to match [type: IP prefix] (default: 0.0.0.0/0) |
source-port | The source port to match (can be a range) [type: port or port-range] (default: 0-65535) |
See Also
command | description |
---|---|
delete session-capture | Deletes session capture from selected service. |
delete session-capture by-id | Deletes session-capture by capture-id from selected service. |
show session-captures | Show active session-captures. |
Description
When destination or source IPs are not specified, any IP will be matched.
When destination or source port is not provided, port range of 0-65535 is used.
When protocol is not provided, all protocols will be matched.
When session-count is not specified, default will be unlimited.
When packet-count is not specified, default is 100 packets in each direction for each session matched.
create user
Create a new user account interactively.
Usage
Positional Arguments
name | description |
---|---|
username | the name of the account to create |
See Also
command | description |
---|---|
delete user | Delete a user account |
edit prompt | Allows the user to specify a custom format for the PCLI prompt. |
edit user | Modify an existing user account |
restore prompt | Restore the PCLI prompt to the factory default. |
restore users factory-default | Restore the user configuration to factory defaults. |
set password | Change your password. |
show user | Display information for user accounts. |
Description
The create user
command allows administrators to create user accounts for user and/or administrative access to the 128T router's management port. Issuing the create user <username>
launches an interactive session that prompts for the new user's full name, password, whether they are an administrative or basic user, and the enabled/disabled state of that user account.
note
The password must be at least eight characters long, with at least one uppercase letter, one lowercase letter, one digit, and cannot contain any characters that repeat more than three times.
Example
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
delete capture-filter
Deletes a capture-filter created using create capture-filter. (It will not delete filters committed as part of the configuration.)
Usage
Keyword Arguments
name | description |
---|---|
device-interface | The device interface on which to delete the capture filter |
node | The node on which to remove the capture filter |
router | The router on which to remove the capture filter |
Positional Arguments
name | description |
---|---|
capture-filter | The capture-filter to remove (Uses BPF syntax) |
See Also
command | description |
---|---|
create capture-filter | Creates a capture-filter using BPF syntax (as used in wireshark) on the target interface. |
show capture-filters | Show active capture-filters. |
show stats packet-capture | Stats pertaining to captured packets |
Example
Version History
Release | Modification |
---|---|
4.4.0 | This feature was introduced |
delete (in config)
Usage
Description
The delete
command, when issued within the configuration hierarchy, lets administrators delete portions of the candidate configuration. This can be used to delete specific fields within a configuration element, or entire elements.
The command will prompt you for confirmation before deleting the configuration, unless the optional keyword force
is included.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
delete certificate webserver
Delete the webserver certificate.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
See Also
command | description |
---|---|
create certificate request webserver | Create a certificate signing request. |
create certificate self-signed webserver | Create a self-signed certificate. |
import certificate webserver | Import a certificate to be used by the webserver. |
show certificate webserver | Display the webserver certificate |
Description
The delete certificate webserver command allows administrators to delete certificates that are stored on the 128T router. Note that the 128T router will always prompt the administrator to confirm deletion (the "force" keyword is not allowed).
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
delete config exported
Delete an exported configuration from disk.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
Positional Arguments
name | description |
---|---|
name | Name of the exported configuration to delete |
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
The delete config command allows administrators to delete configurations from the 128T's filesystem that had previously been exported with the export config command. The force flag will skip the confirmation check without prompting the user.
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
delete flows
Clears all active flow data from this node.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
node | The node from which to delete flow entries |
router | The router from which to delete flow entries |
Description
The delete flows command clears all active flow data from this node. Administrators can specify which node to clear flow data from by adding the node name as an optional argument to the command.
This command has been maintained for backward compatibility to older versions of software. The delete sessions command is preferred in versions newer than 3.2.0.
warning
This may be a service impacting operation.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
delete session-capture
Deletes session capture from selected service.
Usage
Keyword Arguments
name | description |
---|---|
destination-ip | The destination IP address/prefix to match [type: IP prefix] (default: 0.0.0.0/0) |
destination-port | The destination port to match (can be a range) [type: port or port-range] (default: 0-65535) |
local-only | Session capture is local to the node |
node | The node on which to remove the session-capture filter |
packet-count | The number of packets to capture per session, in each direction [type: 'unlimited' or positive int] (default: 100) |
protocol | The protocol to match (in decimal or by name, eg 'tcp') [type: string or uint8] (default: all) |
router | The router on which to remove the session-capture filter |
service | The service on which to create the session capture |
session-count | The number of sessions to capture [type: 'unlimited' or positive int] (default: 100) |
source-ip | The source IP address/prefix to match [type: IP prefix] (default: 0.0.0.0/0) |
source-port | The source port to match (can be a range) [type: port or port-range] (default: 0-65535) |
Subcommands
name | description |
---|---|
by-id | Deletes session-capture by capture-id from selected service. |
See Also
command | description |
---|---|
create session-capture | Creates a session capture at the specified node and service. |
delete session-capture by-id | Deletes session-capture by capture-id from selected service. |
show session-captures | Show active session-captures. |
delete session-capture by-id
Deletes session-capture by capture-id from selected service.
Usage
Keyword Arguments
name | description |
---|---|
node | The node on which to remove the session-capture filter |
router | The router on which to remove the session-capture filter |
service | The service on which to create the session capture |
Positional Arguments
name | description |
---|---|
capture-id | The session-capture to remove. [type: int] |
See Also
command | description |
---|---|
create session-capture | Creates a session capture at the specified node and service. |
delete session-capture | Deletes session capture from selected service. |
show session-captures | Show active session-captures. |
delete sessions
Delete all current sessions or a subset if arguments are provided.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
node | The node from which to delete sessions |
router | The router from which to delete sessions |
service-name | The name of the service for which to delete all sessions |
session-id | The identifier of the session to be deleted |
Description
The delete sessions command removes all current sessions or a subset if arguments are provided.
warning
This may be a service impacting operation.
delete user
Delete a user account
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
Positional Arguments
name | description |
---|---|
username | the name of the account to delete |
See Also
command | description |
---|---|
create user | Create a new user account interactively. |
edit prompt | Allows the user to specify a custom format for the PCLI prompt. |
edit user | Modify an existing user account |
restore prompt | Restore the PCLI prompt to the factory default. |
restore users factory-default | Restore the user configuration to factory defaults. |
set password | Change your password. |
show user | Display information for user accounts. |
Example
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
edit prompt
Allows the user to specify a custom format for the PCLI prompt.
Usage
Positional Arguments
name | description |
---|---|
format | Format string for the prompt display |
See Also
command | description |
---|---|
create user | Create a new user account interactively. |
delete user | Delete a user account |
edit user | Modify an existing user account |
restore prompt | Restore the PCLI prompt to the factory default. |
restore users factory-default | Restore the user configuration to factory defaults. |
set password | Change your password. |
show user | Display information for user accounts. |
Description
The edit prompt command lets administrators change the display of the PCLI prompt, and includes a flexible array of options for customizability. In addition to various variables, the prompt string can include conditional statements, to affect the display of the prompt under different operating modes. All of this is accomplished by supplying a format string, which contains the syntax of the desired PCLI prompt.
Version History
Release | Modification |
---|---|
3.1.0 | This feature was introduced |
edit user
Modify an existing user account
Usage
Positional Arguments
name | description |
---|---|
username | The name of the account to modify (default: <current user>) |
See Also
command | description |
---|---|
create user | Create a new user account interactively. |
delete user | Delete a user account |
edit prompt | Allows the user to specify a custom format for the PCLI prompt. |
restore prompt | Restore the PCLI prompt to the factory default. |
restore users factory-default | Restore the user configuration to factory defaults. |
set password | Change your password. |
show user | Display information for user accounts. |
Description
The edit user command enters a configuration subtree specific to administering user accounts. From within this subtree, administrators can change any of the attributes associated with a user account (full name, password, role, and enabled state). This is done in a "configuration-like" way, where commands are issued as attribute value.
As with standard configuration, using the "?" command will list the options available for editing.
Example
Modifying these attributes is done as follows:
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
exit (in config)
The exit command moves your focus to the PCLI home.
Usage
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
export config
Export a copy of the current running or candidate config.
Usage
Positional Arguments
name | description |
---|---|
datastore | running | candidate |
export-name | A name consisting of alphanumeric characters or any of the following: . - _ |
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
The export command takes a configuration from a previously created backup (via create config backup), from the candidate configuration, or from the 128T router's running configuration, and stores it as a file on the local filesystem. It can then be taken off, moved onto other systems, archived, etc.
Exported files are stored in /etc/128technology/config-backups/ and are stored as GZIP compressed files.
The export command's complement, import is used to reverse the process, taking a configuration archive and restoring it onto a system.
Example
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
3.1.0 | The location of the exported configuration changed |
import certificate webserver
Import a certificate to be used by the webserver.
Usage
See Also
command | description |
---|---|
create certificate request webserver | Create a certificate signing request. |
create certificate self-signed webserver | Create a self-signed certificate. |
delete certificate webserver | Delete the webserver certificate. |
show certificate webserver | Display the webserver certificate |
Description
This command allows administrators to load certificates into their 128T router by pasting them into their active PCLI session. By issuing the import certificate
command, the PCLI prompts the user for the name of the certificate they plan to import, then asks whether it is a CA (certificate authority) certificate or not. Once these questions are answered, administrators can paste the certificate, and is reminded to press CTRL-D once the pasting is complete. Pressing CTRL-D causes the 128T router to validate the configuration to ensure it is a valid X.509 certificate before loading it into persistent storage. If the X.509 validation fails, the user is informed as follows:
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
import config
Import a configuration as the candidate config.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
Positional Arguments
name | description |
---|---|
name | Name of the configuration file to import |
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
This command takes a backup configuration (one that has been stored with the export
command) and overwrites the current candidate configuration with its contents. Inclusion of the optional "force" keyword will skip the prompt for confirmation.
Example
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
import iso
Import 128T ISO to the local repository
Usage
Keyword Arguments
name | description |
---|---|
filepath | The absolute filepath to the ISO |
force | Skip confirmation prompt |
hunt | Find and import all ISOs from the filesystem |
verbose | Increase log level verbosity |
Example
Version History
Release | Modification |
---|---|
4.4.0 | This feature was introduced |
manage plugin install
Install a plugin on conductor.
Usage
Keyword Arguments
name | description |
---|---|
node | Node to install on (default: all) |
Positional Arguments
name | description |
---|---|
name | Name of plugin to install |
version | Version of plugin to install (default: latest) |
See Also
command | description |
---|---|
manage plugin remove | Remove an installed plugin. |
show plugins available | Shows latest verison of plugins available for install. |
show plugins installed | Shows installed plugins. |
manage plugin remove
Remove an installed plugin.
Usage
Keyword Arguments
name | description |
---|---|
node | Node to remove on (default: all) |
Positional Arguments
name | description |
---|---|
name | Name of plugin to be removed |
See Also
command | description |
---|---|
manage plugin install | Install a plugin on conductor. |
show plugins available | Shows latest verison of plugins available for install. |
show plugins installed | Shows installed plugins. |
migrate
Migrate a 128T router to a new conductor. For more details on the 128T rotuer migration read the How to: Conductor Migration.
Usage
Keyword Arguments
name | description |
---|---|
conductor | The address(es) of the conductor node(s) to migrate to |
force | Skip confirmation prompt |
router | The router to migrate |
skip-validation | Attempt to migrate the router without checking if migration is possible |
See Also
command | description |
---|---|
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
ping
Send an ICMP request through a network interface.
Usage
Keyword Arguments
name | description |
---|---|
count | Number of ping requests to send [type: int] (default: 4) |
egress-interface | Network interface from which to ping |
gateway-ip | Gateway IP address from which to ping [type: IP address] |
node | The node from which to send the ping request |
router | The router from which to send the ping request |
set-df-bit | Set the IPv4 'Don't Fragment' bit on the request packet |
size | Number of data bytes to send [type: int] (default: 56) |
timeout | Time to wait for a response, in seconds [max: 10 seconds][type: int] (default: 1) |
Positional Arguments
name | description |
---|---|
destination-ip | Destination IP of the ping request [type: IP address] |
Description
This issues ICMP requests to the specified destination-ip merely as a connectivity test, and bypasses the typical packet processing logic that would potentially restrict access to various tenants and destined for service addresses. The count modifier will affect the number of pings that are issued. The interface modifier lets administrators specify the egress interface for issuing the pings. The timeout modifier will set the waiting period for a reply before declaring the ping as a failure. The set-df-bit and record-route options enable the respective flags in the outgoing ICMP request.
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced. The previous behavior of the ping command is now realized as service-ping |
quit
Quit the PCLI.
Usage
Description
This command logs the user out, and quits the PCLI.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
refresh dns resolutions
Refreshes all DNS resolutions configured on the platform.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
hostname | The DNS hostname belonging to a node |
router | The name of the router (default: <current router>) |
See Also
command | description |
---|---|
set dns resolution | Sets a hostname resolution temporarily until the next time the node processes config |
show dns resolutions | Shows all DNS resolutions |
release dhcp lease
Releases an active DHCP lease.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
network-interface | The network interface on which to release the current DHCP lease |
router | The name of the router |
See Also
command | description |
---|---|
show dhcp mappings | Show each DHCP mapping from an interface to mapping/IP family/config types. |
show dhcp prefix-delegation | Show the prefix learned for prefix-delegation. |
show dhcp v4 | Display dhcp lease info for network-interfaces. |
show dhcp v6 | Display dhcp lease info for network-interfaces. |
repeat
Repeat any command multiple times.
Usage
Keyword Arguments
name | description |
---|---|
beep | Beep if the command fails to execute |
exit-on-failure | Exit if the command fails to execute |
interval | Seconds to wait between updates [type: int] (default: 2) |
Positional Arguments
name | description |
---|---|
command | Command to repeat |
Description
This command can be used to "watch" statistics over a specified period. In order to stop the repeat command, the user must issue a CTRL-C
.
Example
replace config
Search for and replace configuration data that matches a specified pattern.
Usage
Keyword Arguments
name | description |
---|---|
force | Replace all matching data without prompts |
Positional Arguments
name | description |
---|---|
find | The text to find in the candidate configuration |
replace | The new value to replace 'find' with |
Description
The replace command is a powerful tool for making sweeping configuration changes, similar to a "find and replace" operation in a word processor. The replace command has several optional arguments that affect how the replacement occurs; case-sensitive will only match elements within the configuration that match the case supplied with the query string. The regex argument treats the query string as a regular expression. The whole-word argument requires that the match be an entire word, rather than just a substring or partial match.
The user-supplied query string and replacement string are the matching text, and the replacement text, respectively.
Example
Version History
Release | Modification |
---|---|
3.1.0 | This feature was introduced |
restore config factory-default
Restore the candidate config to the factory defaults.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
This command removes all administrator-added configuration, and restores the basic configuration to all of the 128T router's factory default settings. The PCLI will prompt for confirmation before resetting the configuration, unless the optional force modifier is added.
Example
Version History
Release | Modification |
---|---|
1.1.0 | This feature was introduced. Replaces the deprecated reset-factory-default-config |
restore config running
Discard uncommitted changes from the candidate config.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
This command removes all administrator-added configuration since the last commit, effectively bringing the running configuration and the candidate configuration back to parity. The PCLI will prompt for confirmation before resetting the configuration, unless the optional force modifier is added.
Example
Version History
Release | Modification |
---|---|
1.1.0 | This feature was introduced |
2.0.0 | Previously named restore config candidate |
restore prompt
Restore the PCLI prompt to the factory default.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
See Also
command | description |
---|---|
create user | Create a new user account interactively. |
delete user | Delete a user account |
edit prompt | Allows the user to specify a custom format for the PCLI prompt. |
edit user | Modify an existing user account |
restore users factory-default | Restore the user configuration to factory defaults. |
set password | Change your password. |
show user | Display information for user accounts. |
Description
The restore prompt command returns the PCLI's prompt to its factory default, in the event that an administrator has modified it.
Example
Version History
Release | Modification |
---|---|
3.1.0 | This feature was introduced |
restore users factory-default
Restore the user configuration to factory defaults.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
See Also
command | description |
---|---|
create user | Create a new user account interactively. |
delete user | Delete a user account |
edit prompt | Allows the user to specify a custom format for the PCLI prompt. |
edit user | Modify an existing user account |
restore prompt | Restore the PCLI prompt to the factory default. |
set password | Change your password. |
show user | Display information for user accounts. |
Description
The restore users factory-default command deletes all administratively created user accounts (i.e., all but the ones that are installed with the 128T routing software natively) and leaves the system with just the admin and user accounts.
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
rotate log
Rotate log files.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to rotate logfiles |
router | The router for which to rotate logfiles (default: <current router>) |
Positional Arguments
name | description |
---|---|
process-name | The process for which to rotate logfiles (default: all) |
See Also
command | description |
---|---|
set log level | Set the log level of a process. |
write log message | Write a message to the log. |
write log snapshot | Write a snapshot to the log. |
Description
This command is used to rotate log files (i.e., close the current log file and open a new one) generated by the various processes that comprise the 128T router to rotate. The 128T router's log files, stored in /var/log/128technology
, keep 25 prior logs for each process, space permitting. Files are rotated such that, for instance, pcli.log becomes pcli.1.log while pcli.1.log becomes pcli.2.log, and so on. The oldest log file for each process is removed.
The rotate log command is useful prior to engaging in troubleshooting exercises, to help narrow down which files may contain items of interest. It is particularly useful when used in conjunction with the write command, described elsewhere in this document.
Without any arguments, the rotate log command will rotate all log files on all nodes.
For more information about 128T logging read Understanding Logs on the 128T
Example
The optional arguments process-name and node-name let administrators specify which processes should rotate their logs, and on which nodes.
In this example you can see that what was previously named highwayManager.4.log has been rotated to highwayManager.5.log; likewise, all other logs were incremented. What was highwayManager.log is now highwayManager.1.log, and a new highwayManager.log file has been created, and is empty.
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
save runtime-stats
Gathers runtime process stats and stores it in a logfile.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | Target node from which to gather runtime stats |
router | Target router from which to gather runtime stats (default: <current router>) |
Positional Arguments
name | description |
---|---|
filename | Custom filename to store system information |
process-name | Target process from which to gather runtime stats (default: all) |
Example
save tech-support-info
Gather system information for technical support.
Usage
Positional Arguments
name | description |
---|---|
prefix | Custom file prefix to add the archive file |
Description
This command packages statistics, logs and other diagnostic data, to exchange with 128 Technology's support team. The tech-support-info command echoes the location where it stores the file when complete (/var/log/128technology/tech-support-info.tar.gz
).
note
This command collect a lot of data, and may take some time to complete.
Example
search
Search for any PCLI command or configuration data from the current location in the command tree.
Usage
Positional Arguments
name | description |
---|---|
find | Find all the matching text |
Subcommands
name | description |
---|---|
config | Search all configuration data |
commands | Search PCLI commands |
config-attributes | Search configuration attributes |
Description
The search command and its various subcommands let users search through the 128T router's PCLI command tree, the configuration tree, and user-supplied configuration data to locate the information specified by the supplied find string.
When omitting the optional filter, the search command will return results for all of the types of information it can locate: commands, configuration attributes, and configuration data.
Example
search commands
Search PCLI commands
Usage
Positional Arguments
name | description |
---|---|
find | Find all the matching text |
search config
Search all configuration data
Usage
Positional Arguments
name | description |
---|---|
find | Find all the matching text |
Subcommands
name | description |
---|---|
running | Search running configuration data |
candidate | Search candidate configuration data |
Description
The output of search can be filtered by explicitly specifying commands configuration.
Example
search config candidate
Search candidate configuration data
Usage
Positional Arguments
name | description |
---|---|
find | Find all the matching text |
Example
search config running
Search running configuration data
Usage
Keyword Arguments
name | description |
---|---|
case-sensitive | Interpret the search query as case-sensitive |
regex | Process the query as a regular expression |
whole-word | Don't allow partial matches of words |
Positional Arguments
name | description |
---|---|
find | Find all the matching text |
Example
search config-attributes
Search configuration attributes
Usage
Positional Arguments
name | description |
---|---|
find | Find all the matching text |
Description
The output of search can be filtered by explicitly specifying config-attributes configuration.
Example
send command download
Download 128T software on a router
Usage
Keyword Arguments
name | description |
---|---|
dry-run | View version changes without command execution |
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router on which to download software |
Positional Arguments
name | description |
---|---|
version | The version of 128T as semantic version and optionally a release identifier (e.g. "3.0.0" or "3.0.1-snapshot1"); if not provided, the latest is assumed |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
Description
send command is only available within the PCLI of a 128T Conductor.
send command reconnect
Attempt to reconnect an asset
Usage
Keyword Arguments
name | description |
---|---|
node | The name of the node |
router | The name of the router (default: <current router>) |
Subcommands
name | description |
---|---|
disconnected | Attempt to reconnect all disconnected assets. |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
send command reconnect disconnected
Attempt to reconnect all disconnected assets.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
send command restart
Restart a 128T node
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
node | The node to restart |
router | The router to restart |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
Description
send command is only available within the PCLI of a 128T Conductor.
send command rollback
Rollback a 128T router to the previously installed version
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router to rollback |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
Description
send command is only available within the PCLI of a 128T Conductor.
send command start
Start a 128T node
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
node | The node to start |
router | The router to start |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
Description
send command is only available within the PCLI of a 128T Conductor.
send command stop
Stop a 128T node
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
node | The node to stop |
router | The router to stop |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
Description
send command is only available within the PCLI of a 128T Conductor.
send command upgrade
Upgrade a 128T node
Usage
Keyword Arguments
name | description |
---|---|
dry-run | View version changes without command execution |
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router to upgrade |
Positional Arguments
name | description |
---|---|
version | The version of 128T as semantic version and optionally a release identifier (e.g. "3.0.0" or "3.0.1-snapshot1"); if not provided, the latest is assumed |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
Description
send command is only available within the PCLI of a 128T Conductor.
send command yum-cache-refresh
Refresh the yum cache as well as the 128T software versions available for download and upgrade.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router to refresh |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
service-ping
Send an ICMP request using a service or tenant
Usage
Keyword Arguments
name | description |
---|---|
count | Number of ping requests to send [type: int] (default: 4) |
node | The node from which to send the ping request |
router | The router from which to send the ping request |
service-name | Name of service which includes the destination trying to be reached; only required if service is ambiguous |
set-df-bit | Set the IPv4 'Don't Fragment' bit on the request packet |
size | Number of data bytes to send [type: int] (default: 56) |
source-ip | IP from which to test whether traffic is allowed [type: IP address] |
tenant | Name of source tenant for ICMP request (default is the global tenant) |
timeout | Time to wait for a response, in seconds [max: 10 seconds][type: int] (default: 1) |
Positional Arguments
name | description |
---|---|
destination-ip | Destination IP of the ping request [type: IP address] |
Description
This issues ICMP requests to the specified destination-ip, and offers the administrators a variety of ways to formulate the request. The tenant and service-name modifiers specify which "source tenant" to use for the request, and the name of the service for which the destination-ip applies. The count modifier will affect the number of pings that are issued. The interface modifier lets administrators specify the egress interface for issuing the pings. The timeout modifier will set the waiting period for a reply before declaring the ping as a failure. The set-df-bit and record-route options enable the respective flags in the outgoing ICMP request.
Example
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
3.0.0 | Included tenant, service, and node information |
3.2.0 | Previously named ping |
set config encryption
Sets the encryption key for the 128T configuration
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
node | The node on which to disable config encryption (default: all) |
router | The router on which to set config encryption (default: <current router>) |
Subcommands
name | description |
---|---|
disabled | Disables the encryption for the 128T configuration |
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Example
Version History
Release | Modification |
---|---|
4.5.0 | This feature was introduced |
set config encryption disabled
Disables the encryption for the 128T configuration
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt |
node | The node on which to disable config encryption (default: all) |
router | The router on which to disable config encryption (default: <current router>) |
Example
Version History
Release | Modification |
---|---|
4.5.0 | This feature was introduced |
set context node
Usage
Positional Arguments
- node the name of the node
Description
The set context node command puts the PCLI into a mode where every subsequent command that is issued that can take a node (in the case of a 128T router) as an argument will default to the context's values.
Version History
Release | Modification |
---|---|
5.0.0 | This feature was removed |
set context router
Usage
Description
The set context router command can be used to set the PCLI into a mode where every subsequent command that is issued that can take a router (in the case of the 128T Conductor) or a node (in the case of a 128T router) as an argument will default to the context's values.
note
This does not "remote shell" into the router/node specified by the context's values, it merely uses these as default values for commands that (generally) display value. E.g., show stats, show flows, etc.
When a context is set, the prompt changes to indicate the context as a parenthetical label at the beginning of each PCLI command.
Setting the context to a router is only available within the PCLI of a 128T Conductor.
Positional Arguments
name | description |
---|---|
router | The name of the router |
Example
See Also
- clear context node Clear only the node context
- clear context router Clear both the router context and node context
- set context stats start-time Set the start time for show stats commands
Version History
Release | Modification |
---|---|
5.0.0 | This feature was removed |
set context stats start-time
Usage
Positional Arguments
name | description |
---|---|
start-time | A timestamp string that can include date, time, or both. Special value "now" sets the start time point to the current time [type: timestamp or 'now'] (default: now) |
Description
set context stats start-time lets administrators set a "zero time" for all statistics that the 128T has accumulated. While this stats start-time context is set, all of the output for show stats commands will reflect the accumulation of statistics since that time. This is very useful when troubleshooting issues, or after making configuration changes, to only show data relevant to the exercise at hand.
The set context stats start-time has a flexible parser and can accept many different forms of "time" strings that include date information, time information, or both. There's also a keyword "now" that sets the stats start-time to the current 128T system clock. (The "now" behavior is the default, and thus the 128T will set the stats start-time to the current clock time when no argument is supplied.)
Example
See Also
- clear context node Clear only the node context
- clear context router Clear both the router context and node context
- set context router Set the context to a different router
Version History
Release | Modification |
---|---|
5.0.0 | This feature was removed |
set dns resolution
Sets a hostname resolution temporarily until the next time the node processes config
Usage
Keyword Arguments
name | description |
---|---|
router | The router on which to set the hostname resolution (default: <current router>) |
Positional Arguments
name | description |
---|---|
hostname | The hostname to set the resolution for |
ip-address | The ip-address the hostname should resolve to [type: IP address] |
See Also
command | description |
---|---|
refresh dns resolutions | Refreshes all DNS resolutions configured on the platform. |
show dns resolutions | Shows all DNS resolutions |
Example
Version History
Release | Modification |
---|---|
4.5.0 | This feature was introduced |
set log level
Set the log level of a process.
Usage
Keyword Arguments
name | description |
---|---|
category | The log category for which to set the level (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node on which to set the corresponding process log level |
router | The router on which to set the corresponding process log level (default: <current router>) |
Positional Arguments
name | description |
---|---|
level | The log level |
process-name | The process for which to set the log level (the log level will change for all processes when no process is specified) (default: all) |
Subcommands
name | description |
---|---|
configured | Reset the process log level to the configured system log level. |
See Also
command | description |
---|---|
rotate log | Rotate log files. |
write log message | Write a message to the log. |
write log snapshot | Write a snapshot to the log. |
Description
The set log level command adjusts the degree to which the 128T router writes information into its log files. This is used to selectively turn up and down log verbosity for troubleshooting purposes.
The optional <process-name> and <node-name> arguments, can selectively change only a specific 128T router's software process on a given node.
The level must be one of: fatal, error, warning, info, debug, and trace. These are listed in order of increasing verbosity. 128 Technology, Inc. generally recommends that systems be set to info level by default under normal operating circumstances.
As of software version 3.1, a new subcommand set log level category, allows administrators to collectively adjust groups of related functionality for specific troubleshooting exercises – instead of blindly adjusting the entire system's log level and potentially impacting performance.
The category can be any of the following:
Category Name | Long Name | Description |
---|---|---|
ATCS | Analytics | Components related to the 128T Analytics Engine |
PLAT | Platform | Components related to the underlying platform management. |
RDB | Redundancy Database | The subsystem responsible for synchronizing data between nodes. |
IPC | Interprocess Communications | The subsystem responsible for messaging between components within the 128T product. |
DATA | Metadata Database | Components related to the configuration and state databases. |
RTG | Routing | Components related to the routing engine. |
HWMC | "HighwayManager Control" | Control system for packet processing. |
FLC | "FastLane Control" | Control system for packet forwarding. |
FPP | First Packet Processing | System for processing the initial packet of each new session. |
DISC | Discovery | Discovery-based components (except BFD). Today this is DHCP and ARP. |
LINK | Internode Link Detection | The subsystem for inter-node communication (today, BFD). |
USER | User | User-created log messages, generated via the write command. |
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
3.1.0 | Log categories introduced |
set log level configured
Reset the process log level to the configured system log level.
Usage
Keyword Arguments
name | description |
---|---|
category | The log category for which to reset the level. (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node on which to set the corresponding process log level |
router | The router on which to set the corresponding process log level (default: <current router>) |
Positional Arguments
name | description |
---|---|
process-name | The process for which to set the log level (default: all) |
Description
Will return the 128T router's logging behavior to the verbosity specified within the configuration, located at: authority > router > system > log-level
. Alternatively, administrators can specify a log level to dynamically change all system processes to use.
set password
Change your password.
Usage
See Also
command | description |
---|---|
create user | Create a new user account interactively. |
delete user | Delete a user account |
edit prompt | Allows the user to specify a custom format for the PCLI prompt. |
edit user | Modify an existing user account |
restore prompt | Restore the PCLI prompt to the factory default. |
restore users factory-default | Restore the user configuration to factory defaults. |
show user | Display information for user accounts. |
Description
The set password command allows a PCLI user to change their password. As is typical with most password changing routines, as a security precaution the user must enter their current password before they're permitted to change it.
note
If a password is lost or forgotten and the account is inaccessible, the account cannot be recovered. Please keep password records accessible and secure.
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
set provisional-status
Set the provisional status of a specific interface to down, or returning it to the "up" state after taking it down.
Usage
Keyword Arguments
name | description |
---|---|
node | Identify the node where the device is located. |
device | Device on which the interface is located. |
Subcommands
name | description |
---|---|
Up/Down | Set the interface status to up or down. |
See Also
command | description |
---|---|
show device-interface | Display detailed device interface information. |
Description
The set provisional-status
command allows a specific interface to be brought down without a configuration change. This is useful in situations where you need to temporarily bring down a just device interface (i.e., to trigger an interface failover).
Example
Version History
Release | Modification |
---|---|
4.5.3 | This feature was introduced |
shell
Execute a Unix shell command.
Usage
Positional Arguments
name | description |
---|---|
command | Shell command to execute |
Description
The shell command allows administrators to execute a bash shell, or to execute a command within the context of a bash shell (specified as a series of optional parameters to the shell command).
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
show alarms
Display currently active or shelved alarms
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
id | ID for which to display alarm information |
router | The router for which to display alarms (default: all) |
shelved | Display shelved alarms |
See Also
command | description |
---|---|
show events alarm | Show alarm events from the historical events database. |
Description
The show alarms subcommand shows all of the active alarms on your 128T router.
A list of all alarms your 128T router is capable of generating and details about them can be found in the Alarm Guide.
Example
Version History
Release | Modification |
---|---|
1.1.0 | This feature was introduced |
3.1.0 | Previously allowed filtering by node, now the command shows all alarms. |
show application names
Display application name entries.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The name of the node |
router | The name of the router |
rows | The number of application name entries to display at once [type: int or 'all'] (default: 50) |
Description
The show application names subcommand shows all of the "application" names that the 128T has learned, or been configured to recognize, as part of its Application Classification feature.
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
show arp
Shows the contents of the ARP table on the specified node.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node from which to retrieve arp entries |
router | The router from which to retrieve arp entries |
rows | The number of arps to display at once [type: int or 'all'] (default: 50) |
Subcommands
name | description |
---|---|
proxy | Display proxy ARP info for network-interfaces. |
See Also
command | description |
---|---|
clear arp | Clear the entire ARP cache or a subset if arguments are provided. |
Description
The show arp subcommand displays the ARP table (MAC address to IP address binding) for a given node. The number of lines of output may be controlled through the use of the optional rows attribute. When not present, the 128T router will default to displaying the first 50 rows of the specified node's ARP table.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
2.0.0 | Added requirement for use of 'node' keyword when specifying a node name. |
show arp proxy
Display proxy ARP info for network-interfaces.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
name | Network interface for which to display proxy ARP info (default: all) |
node | The node for which to display proxy ARP info |
router | The router for which to display proxy ARP info (default: all) |
Description
Displays a list of all configured proxies, grouped by network interface.
Example
show assets
Shows the automated provisioning status of 128T nodes.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display assets |
router | The router for which to display assets (default: all) |
Positional Arguments
name | description |
---|---|
id | The asset id of the 128T node from which to retrieve the status |
Subcommands
name | description |
---|---|
software | Shows assets software information. |
summary | A summary of assets connected to the Conductor. |
errors | Shows the 128T nodes that have errors. |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets software | Shows assets software information. |
show assets summary | A summary of assets connected to the Conductor. |
Description
The show assets command displays the automated provisioning status of the 128T nodes within an Authority. With 128T's automated provisioning feature set, each "asset" represents a platform into which the 128T software is installed, updated, managed, etc. The show assets command allows administrators to see, at a glance, the state of all assets – including which software versions have been installed on which nodes, what their router and node identifiers are, etc.
Example
The optional id argument allows administrators to retrieve more detailed information about a specific asset:
Version History
Release | Modification |
---|---|
3.1.0 | This feature was introduced |
show assets errors
Shows the 128T nodes that have errors.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router for which to display assets summary (default: all) |
Positional Arguments
name | description |
---|---|
id | The asset id of the 128T node from which to retrieve the status |
Description
show assets errors will display all assets with at least one automated provisioner related error.
Example
Version History
Release | Modification |
---|---|
4.4.0 | This feature was introduced |
show assets software
Shows assets software information.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display available software |
router | The router for which to display available software (default: all) |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets summary | A summary of assets connected to the Conductor. |
Description
Displays software related information for each managed asset. The following information is provided:
- Current running version of software.
- Versions available for download and the repository where they are located.
- Software versions currently being downloaded.
- Previously downloaded versions that can be used to upgrade the platform.
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
show assets summary
A summary of assets connected to the Conductor.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router for which to display assets summary (default: all) |
See Also
command | description |
---|---|
migrate | Migrate a 128T router to a new conductor |
send command download | Download 128T software on a router |
send command reconnect | Attempt to reconnect an asset |
send command reconnect disconnected | Attempt to reconnect all disconnected assets. |
send command restart | Restart a 128T node |
send command rollback | Rollback a 128T router to the previously installed version |
send command start | Start a 128T node |
send command stop | Stop a 128T node |
send command upgrade | Upgrade a 128T node |
send command yum-cache-refresh | Refresh the yum cache as well as the 128T software versions available for download and upgrade. |
show assets | Shows the automated provisioning status of 128T nodes. |
show assets software | Shows assets software information. |
Description
show assets summary will display a total of all assets in each state.
Example
Version History
Release | Modification |
---|---|
4.4.0 | This feature was introduced |
show bgp
Displays information about the state of the BGP process on the 128T router.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display BGP routes |
rows | The number of bgp entries to display at once [type: int or 'all'] (default: 50) |
Positional Arguments
name | description |
---|---|
route | route ip-prefix [type: IP prefix] |
Subcommands
name | description |
---|---|
neighbors | Displays information about the state of the BGP neighbors on the 128T router. |
summary | Show the current BGP summary from the routing manager. |
See Also
command | description |
---|---|
clear bgp | Clear routes associated with one or all BGP neighbors. |
Description
The show bgp command and associated subcommands display information about the state of the BGP process on the 128T router. Each of these subcommands will be described in more detail in the sections that follow.
Example
When the show bgp command is issued with no command line arguments, the system returns the general status of the BGP process:
The <route> argument is given as an IP prefix (CIDR). The show bgp <route> command gives detailed information on the specified route, if it exists in the 128T router's Routing Information Base (RIB).
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
show bgp neighbors
Displays information about the state of the BGP neighbors on the 128T router.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display BGP neighbors |
rows | The number of bgp entries to display at once [type: int or 'all'] (default: 50) |
Positional Arguments
name | description |
---|---|
neighbor-ip | The IP address of the neighbor [type: IP address] |
option | advertised-routes | received-routes |
Description
The show bgp neighbors command displays detailed information about each of the 128T router's BGP peers. By specifying a specific peer (through the optional argument <neighbor-ip>), administrators can view state information about one peer at a time. When specifying a specific neighbor, the output may include the routes shared with that peer by appending advertised-route or received from that peer by appending received-routes.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
show bgp summary
Show the current BGP summary from the routing manager.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display the BGP summary |
rows | The number of bgp entries to display at once [type: int or 'all'] (default: 50) |
Description
The show bgp summary gives administrators a high-level summary table of the state of all of the 128T router's BGP peers.
It includes information on each BGP neighbor, including the version (V) of BGP that they are using (generally v4), the Autonomous System number (AS), the number of BGP messages sent and received (MsgSent, MsgRcvd), the table version (TblVer), etc.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
show capacity
Shows current fib/flow/arp/action usage and capacities at the specified node.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node from which to retrieve capacities |
router | The router from which to retrieve capacities |
Example
show capture-filters
Show active capture-filters.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | Device interface on which to show capture-filters (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node on which to show capture-filters |
router | The router on which to show capture-filters (default: all) |
See Also
command | description |
---|---|
create capture-filter | Creates a capture-filter using BPF syntax (as used in wireshark) on the target interface. |
delete capture-filter | Deletes a capture-filter created using create capture-filter. (It will not delete filters committed as part of the configuration.) |
show stats packet-capture | Stats pertaining to captured packets |
Description
Shows all configured capture-filters, including static capture-filters that exist as part of the configuration as well as dynamic capture-filters (i.e., those created using the create capture-filter command).
Example
Version History
Release | Modification |
---|---|
4.4.0 | This feature was introduced |
show certificate webserver
Display the webserver certificate
Usage
See Also
command | description |
---|---|
create certificate request webserver | Create a certificate signing request. |
create certificate self-signed webserver | Create a self-signed certificate. |
delete certificate webserver | Delete the webserver certificate. |
import certificate webserver | Import a certificate to be used by the webserver. |
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
show config candidate
Usage
Description
This command returns the current candidate configuration on the 128T router (i.e., the configuration that is currently being edited, not the configuration that is actively running). The output from show config candidate will only show fields and values within the configuration that are set to non-default values, for brevity.
The show config candidate command has two optional flags: verbose and flat. Adding the verbose flag will show the entire configuration, including items that are part of the system's default configuration (normally hidden when using show config candidate by itself). Adding the flat flag will output the configuration as a series of individual, fully qualified configuration statements, which can singularly affect each component of the configuration discretely. That is, any of the lines can be used without any context to configure a single attribute, object, etc.
Note that the output from show config candidate is formatted in such a way so as to allow the text to be cut and pasted into a CLI session to configure a separate 128T router.
The same configuration using the flat flag is displayed quite differently:
The show config candidate command also lets users show specific portions of the configuration by specifying the path to the areas of interest. For multiple instance items, such as node, service, etc., a keyword all will display all items of the specified type:
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced as "show candidate-config" |
2.0.0 | Renamed and reorganized as "show config candidate". flat, verbose, and configuration branch arguments added |
show config exports
Display configuration exports.
Usage
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config version | Display running configuration version. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
This command lists the set of exported configurations that are stored on your 128T router. (Exported configurations are created with the export config command, described in more detail later in this document.)
Example
Version History
Release | Modification |
---|---|
3.0.0 | This feature was introduced |
show config locally-modified
Display all routers with a locally modified config version
Usage
show config out-of-sync
Display all routers with a config version that is out of sync with the conductor
Usage
show config running
Usage
Description
This command returns the current running configuration on the 128T router (i.e., the configuration that is active and processing traffic). The output from show config running will only show fields and values within the configuration that are set to non-default values, for brevity.
The show config running command has two optional flags: verbose and flat. Adding the verbose flag will show the entire configuration, including items that are part of the system's default configuration (normally hidden when using show config running by itself). Adding the flat flag will output the configuration as a series of individual, fully qualified configuration statements, which can singularly affect each component of the configuration discretely. That is, any of the lines can be used without any context to configure a single attribute, object, etc.
Note that the output from show config running is formatted in such a way so as to allow the text to be cut and pasted into a CLI session to configure a separate 128T router.
The show config running command also lets users show specific portions of the configuration by specifying the path to the areas of interest. For multiple instance items, such as node, service, etc., a keyword all will display all items of the specified type:
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced as "show running-config" |
2.0.0 | Renamed and reorganized as "show config running" |
show config version
Display running configuration version.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router (default: <current router>) |
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show events config commit | Shows events related to running config change |
show stats config | Metrics pertaining to the get-config RPC |
Description
This command displays the version number of the running configuration on the 128T router. This version number is auto-generated, and is the UNIX timestamp when the configuration is committed. (As a consequence, you should expect that successive commits to the same configuration will increment the version by more than one. This is a change in behavior from pre-2.0 software, which used a monotonically incrementing integer to represent the configuration version.)
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
2.0.0 | The behavior changed as described in the Description text above |
3.0.0 | Updated to display the timestamp of the configuration change in human readable form |
show context stats start-time
Usage
Description
The show context stats start-time subcommand shows the stats start-time (if set), or indicates that there is no start-time currently set. For more information on setting stats start-time, please refer to set context in this manual.
Example
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
5.0.0 | This feature was removed |
show device-interface
Display detailed device interface information.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers. |
name | Device interface to display (if omitted, all will be displayed) (default: all) |
node | The node for which to display device interfaces |
router | The router for which to display device interfaces |
Positional Arguments
name | description |
---|---|
verbosity | detail |
Description
This command displays detailed information about device interface(s) (i.e., physical ports) on a 128T router node. The optional command line arguments allow a user to reduce the set of information to a specific set of interfaces on a given node, or a specific interface on a specific node.
Omitting all optional arguments will display detailed information on all device interfaces defined within the 128T router.
Example
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
3.0.0 | Added requirement for prepending keywords to the device-interface-id and node arguments to avoid command line ambiguity |
3.2.0 | Device-interface is keyed by name rather than id |
4.5.3 | Added support for Provisional Status |
show dhcp mappings
Show each DHCP mapping from an interface to mapping/IP family/config types.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node from which to identify DHCP mappings |
router | The name of the router to show |
rows | The number of mappings to display at once [type: int or 'all'] (default: 50) |
See Also
command | description |
---|---|
release dhcp lease | Releases an active DHCP lease. |
show dhcp prefix-delegation | Show the prefix learned for prefix-delegation. |
show dhcp v4 | Display dhcp lease info for network-interfaces. |
show dhcp v6 | Display dhcp lease info for network-interfaces. |
Example
show dhcp prefix-delegation
Show the prefix learned for prefix-delegation.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
group | Prefix-delegation group to display (if omitted, all will be displayed) |
router | The name of the router to show (default: <current router>) |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
See Also
command | description |
---|---|
release dhcp lease | Releases an active DHCP lease. |
show dhcp mappings | Show each DHCP mapping from an interface to mapping/IP family/config types. |
show dhcp v4 | Display dhcp lease info for network-interfaces. |
show dhcp v6 | Display dhcp lease info for network-interfaces. |
Example
show dhcp v4
Display dhcp lease info for network-interfaces.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
name | Network interface to display (default: all) |
node | The node for which to display dhcp lease info |
router | The router for which to display dhcp lease info |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
See Also
command | description |
---|---|
release dhcp lease | Releases an active DHCP lease. |
show dhcp mappings | Show each DHCP mapping from an interface to mapping/IP family/config types. |
show dhcp prefix-delegation | Show the prefix learned for prefix-delegation. |
show dhcp v6 | Display dhcp lease info for network-interfaces. |
Example
Specifying the argument detail provides additional information
show dhcp v6
Display dhcp lease info for network-interfaces.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
name | Network interface to display (default: all) |
node | The node for which to display dhcp lease info |
router | The router for which to display dhcp lease info |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
See Also
command | description |
---|---|
release dhcp lease | Releases an active DHCP lease. |
show dhcp mappings | Show each DHCP mapping from an interface to mapping/IP family/config types. |
show dhcp prefix-delegation | Show the prefix learned for prefix-delegation. |
show dhcp v4 | Display dhcp lease info for network-interfaces. |
Example
show dns resolutions
Shows all DNS resolutions
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
hostname | The DNS hostname belonging to a node |
router | The name of the router holding the node with the DNS resolutions (default: <current router>) |
rows | The number of dns resolutions to display at once [type: int or 'all'] (default: 50) |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
See Also
command | description |
---|---|
refresh dns resolutions | Refreshes all DNS resolutions configured on the platform. |
set dns resolution | Sets a hostname resolution temporarily until the next time the node processes config |
Description
Shows all hostnames that require DNS resolution. Hostnames can be specified throughout the configuration; commonly defined on the network-interface and within a service.
Example
Specifying the argument detail provides additional information
show domain-categories
Display app-id-v2 domain-name categories used by sessions
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display domain-name categories of active sessions |
router | The router for which to display domain-name categories of active sessions |
See Also
command | description |
---|---|
show domain-names | Display app-id-v2 domain-names used by sessions |
show domain-names
Display app-id-v2 domain-names used by sessions
Usage
Keyword Arguments
name | description |
---|---|
category | Category to show domain-names for |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node from which to retrieve app-id domain-names |
router | The router from which to retrieve app-id domain-names |
rows | The number of domain-names to display at once [type: int or 'all'] (default: 50) |
Positional Arguments
name | description |
---|---|
request-order | Get domains sorted by most-sessions or most-recent |
See Also
command | description |
---|---|
show domain-categories | Display app-id-v2 domain-name categories used by sessions |
show dynamic-peer-update
Display view of dynamic peer update on the conductor.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | Router for which to show dynamic peer update information (default: <current router>) |
Positional Arguments
name | description |
---|---|
table | Show the learned-hostnames of a router, or show the peer-hostnames of a router, or all (default: all) |
See Also
command | description |
---|---|
show stats dynamic-peer-update | Stats pertaining to dynamic peer update processes |
sync peer addresses | Synchronize dynamic addresses (DHCP and PPPoE) between routers and a conductor. |
show entitlement
Displays entitlement utilized.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display entitlement utilized. Conductor routers will show the entitlement utilized per project of all conducted routers. (default: <current router>) |
Description
The 128T Networking Platform calculates the Peak Router Bandwidth Capacity; this is the highest router bandwidth value of any 5 second interval over the specific license period. The Router Bandwidth is calculated based on the aggregate of sessions traversing the router.
Example
The asterisk next to the date indicates the current month and therefore a partial entitlement calcuation.
Version History
Release | Modification |
---|---|
1.1.0 | This feature was introduced |
show events alarm
Show alarm events from the historical events database.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
from | Only show events after the provided time. You can use the provided standard timestamps, such as 45m, 1d, or 1mo; or enter a value [type: timestamp] (default: 1970-01-01 00:00:00) |
router | The name of the router for which to display alarm events (default: <current router>) |
rows | The number of alarm events to display at once [type: int or 'all'] (default: 50) |
to | Only show events before the provided time. You can use the provided standard timestamps, such as 45m, 1d, or 1mo; or enter a value [type: timestamp] |
See Also
command | description |
---|---|
show alarms | Display currently active or shelved alarms |
Description
The show events alarm command displays various event records that the 128T collects during operation. As of software version 3.1, the only event type that is capable of being shown is the alarm history.
The output can be optionally restricted to specific time windows using the from
and to
qualifiers. Because this command can generate a lot of output, the rows
limiter is particularly useful on busy systems.
Example
Version History
Release | Modification |
---|---|
3.1.0 | This feature was introduced |
show events config commit
Shows events related to running config change
Usage
Keyword Arguments
name | description |
---|---|
flat | Display with full paths on each line instead of as a hierarchy |
force | Skip confirmation prompt. Only required when targeting all routers |
from | Only show events after the provided time. Can either be a timestamp or a delta, such as 45m, 1d, or 1mo. [type: timestamp] |
router | The router for which to display config commit events (default: <current router>) |
to | Only show events before the provided time. Can either be a timestamp or a delta, such as 45m, 1d, or 1mo [type: timestamp] |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: detail) |
See Also
command | description |
---|---|
compare config | Display the differences between two configurations. |
create config autogenerated | Run configuration generation. |
delete config exported | Delete an exported configuration from disk. |
export config | Export a copy of the current running or candidate config. |
import config | Import a configuration as the candidate config. |
restore config factory-default | Restore the candidate config to the factory defaults. |
restore config running | Discard uncommitted changes from the candidate config. |
set config encryption | Sets the encryption key for the 128T configuration |
show config exports | Display configuration exports. |
show config version | Display running configuration version. |
show stats config | Metrics pertaining to the get-config RPC |
Example
Version History
Release | Modification |
---|---|
4.5.0 | This feature was introduced |
show events config encryption
Shows events related to config encryption change
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
from | Only show events after the provided time. Can either be a timestamp or a delta, such as 45m, 1d, or 1mo [type: timestamp] |
router | The router for which to display config encryption events (default: <current router>) |
to | Only show events before the provided time. Can either be a timestamp or a delta, such as 45m, 1d, or 1mo [type: timestamp] |
Example
Version History
Release | Modification |
---|---|
4.5.0 | This feature was introduced |
show fib
Shows current fib entries at the specified node
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node from which to retrieve fib entries |
router | The router from which to retrieve fib entries |
rows | The number of fib nodes to display at once [type: int or 'all'] (default: 50) |
Description
This command shows the Forwarding Information Base (FIB) entries on the node that is specified by the <node-name> argument. The output may be limited to a specified number of rows by adding the optional <rows> modifier at the end of the command.
This command can generate a large quantity of output on a busy system, and it is advised that administrators exercise caution when issuing this command without the <rows> modifier.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword to enforce PCLI consistency |
show history
Show PCLI command history for the current user.
Usage
Keyword Arguments
name | description |
---|---|
rows | The number of recent commands to show [type: int or 'all'] |
See Also
command | description |
---|---|
clear history | Clear the PCLI's command history for this user. |
Example
show load-balancer
Shows current load balancer agent entries from the highway manager at the specified node.
Usage
Keyword Arguments
name | description |
---|---|
agent | Agent name to show. If unspecified, shows all agents. |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The name of the node |
router | The name of the router |
service | Service name to show. If unspecified, shows all services. |
Description
The show load-balancer command provides feedback on the 128T router's load balancing behavior, when configured to balance traffic (via a service-policy).
This command, when issued without any filters (agent, node, or service) will display all agents, nodes, and services that are subject to load balancing. (The output can be quite verbose.) These filters may be combined to "hone in" on specific agents/nodes/services selectively.
This command is extremely helpful for identifying why the 128T router selected specific destinations for its session-oriented traffic.
Example
Version History
Release | Modification |
---|---|
1.1.0 | This feature was introduced |
show lte
Display LTE summary.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
Subcommands
name | description |
---|---|
connection | Display LTE connection. |
detail | Display LTE detail. |
modem | Display LTE modem. |
network | Display LTE network. |
profile | Display LTE profile. |
signal | Display LTE signal. |
sim | Display LTE sim. |
show lte connection
Display LTE connection.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
Description
This command queries the LTE devices and displays the following state info:
- registration-status
- connection-status
- netstat (tx, rx, tx-error, rx-error, etc)
show lte detail
Display LTE detail.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
show lte firmware
Display lte firmware information.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
Description
This command queries the LTE devices and displays the following state info:
- carrier-name
- FW-version
- IMEI
- card-model
- bands-supported
- bands-enabled
show lte modem
Display LTE modem.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
show lte network
Display LTE network.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
show lte profile
Display LTE profile.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
show lte signal
Display LTE signal.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
Description
This command queries the LTE devices and displays the following state info:
- rating
- RSSI
- SNR
- carrier-name
show lte sim
Display LTE sim.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
Description
This command queries the LTE devices and displays the following state info:
- ICCID
- registration-status
- carrier-name
- carrier-mcc
- carrier-mnc
show lte summary
Display lte device summary.
Usage
Keyword Arguments
name | description |
---|---|
device-interface | LTE device interface (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display LTE data |
router | The router for which to display LTE data |
Description
This command queries the LTE devices and displays the following state info:
- device-name
- target-name
- registration-status
- connection-status (show IP if connected, otherwise, show previous error)
- signal-strength (rating, RSSI, and SNR)
show network-interface
Display network-interface data for network-interface.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
name | Network interface to display (if omitted, all will be displayed) |
node | The node for which to display network-interface data |
router | The router for which to display network-interface data |
Subcommands
name | description |
---|---|
application | Display application data info for network-interfaces. |
Description
The show network-interface, a counterpart to show device-interface, shows information and statistics relevant to the logical interfaces configured on your 128T networking platform.
The show network-interface command will show router, node, and device names, as well as the network-interface name and basic information about each interface.
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
show network-interface application
Display application data info for network-interfaces.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
name | Network interface to display (default: all) |
node | The node for which to display application data |
router | The router for which to display application data |
Description
The command show network-interface application can be used to display information regarding DHCP client reservations when running a DHCP server on the respective network-interface.
Example
show ntp
Display ntp status from the node monitor at the specified node.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node from which to retrieve ntp status |
router | The router from which to retrieve ntp status (default: <current router>) |
Description
The show ntp subcommand displays properties of the NTP (Network Time Protocol) process running on the local node, or on the node specified as the optional <node‑name> parameter passed on the command line.
Example
The "Ref. ID" field is a four letter ASCII string assigned to the reference clock, and refers to the identifiers defined in RFC 5905.
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
show ospf
Show general information about OSPF
Usage
Keyword Arguments
name | description |
---|---|
area | The area to filter OSPF information for |
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router to request OSPF information from |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Subcommands
name | description |
---|---|
border-routers | Show information about the OSPF border routers |
database | Show OSPF database information |
neighbors | Show information about OSPF neighbors |
interfaces | Show information about the OSPF interfaces |
routes | Show information about the OSPF routes |
Example
Specifying the argument detail provides additional information
show ospf border-routers
Show information about the OSPF border routers
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router to request OSPF information from |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Example
Specifying the argument detail provides additional information
show ospf database
Show OSPF database information
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router to request OSPF information from |
self-originate | Retrieve only self-originated LSA information |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Subcommands
name | description |
---|---|
max-age | Show OSPF LSAs which have reached maximum age |
lsa | Show OSPF database LSA information |
Example
Specifying the argument detail provides additional information
show ospf database lsa
Show OSPF database LSA information
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
lsa-id | The Link State ID to retrieve |
lsa-type | The LSA type to retrieve |
origin | Retrieve LSAs from this advertising router IP |
router | The router to request OSPF information from |
self-originate | Retrieve only self-originated LSA information |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Example
Specifying the argument detail provides additional information
show ospf database max-age
Show OSPF LSAs which have reached maximum age
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router to request OSPF information from (default: <current router>) |
Example
show ospf interfaces
Show information about the OSPF interfaces
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
network-interface | The network interface to fetch OSPF information for |
router | The router to request OSPF information from |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Example
Specifying the argument detail provides additional information
show ospf neighbors
Show information about OSPF neighbors
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
neighbor | The neighbor IP address for which to fetch OSPF information |
network-interface | The network interface to fetch OSPF neighbor information for |
router | The router to request OSPF information from |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Example
Specifying the argument detail provides additional information
show ospf routes
Show information about the OSPF routes
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router to request OSPF information from |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Example
Specifying the argument detail provides additional information
show peers
Display peer information.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
name | Peer to display (default: all) |
router | The router on which to display peers |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Subcommands
name | description |
---|---|
hostnames | Display resolved hostnames of peers |
Description
The show peers command displays properties of each of the "neighboring" 128T routers that the router in question has a peering association with.
This command shows information on peering associations between 128T routers, not peering associations with BGP peers. For information on BGP peering statistics, refer to "show bgp" in this document.
For each peer it shows which interface the peer is reachable via, the destination IP address for which the peer is reached, the VLAN to use to reach it, and whether the peer is currently "up", "down", or "initializing".
Example
The detail option will show peer path statistics (loss, latency, jitter, calculated MOS, uptime) for each peer path.
Version History
Release | Modification |
---|---|
3.0.0 | This feature was introduced |
show peers hostnames
Display resolved hostnames of peers
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router on which to display peer hostnames (default: all) |
Example
show platform
Display platform information of nodes.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which platform info will be displayed |
router | The router for which platform info will be displayed (default: <current router>) |
Positional Arguments
name | description |
---|---|
category | all | cpu | device-interfaces | disk | memory | operating-system | vendor (default: all) |
See Also
command | description |
---|---|
show stats cpu | CPU utilization information |
show stats disk | Disk usage information |
show stats memory | Memory usage information |
Description
The show platform command displays properties of the underlying platform upon which the 128T software is running. This can assist in finding PCI addresses and MAC addresses for the hardware in the system, as well as disk information, OS information, etc.
Example
Version History
Release | Modification |
---|---|
3.0.0 | This feature was introduced |
show plugins available
Shows latest verison of plugins available for install.
Usage
Keyword Arguments
name | description |
---|---|
node | The node for which to display available plugins (default: all) |
Positional Arguments
name | description |
---|---|
name | Name of plugin to show |
See Also
command | description |
---|---|
manage plugin install | Install a plugin on conductor. |
manage plugin remove | Remove an installed plugin. |
show plugins installed | Shows installed plugins. |
show plugins installed
Shows installed plugins.
Usage
Keyword Arguments
name | description |
---|---|
node | The node for which to display installed plugins (default: all) |
See Also
command | description |
---|---|
manage plugin install | Install a plugin on conductor. |
manage plugin remove | Remove an installed plugin. |
show plugins available | Shows latest verison of plugins available for install. |
show rib
Displays the contents of the 128T router's Routing Information Base (RIB)
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display RIB routes |
rows | The number of rib entries to display at once [type: int or 'all'] (default: 50) |
Positional Arguments
name | description |
---|---|
route | Route ip-prefix [type: IP prefix] |
Subcommands
name | description |
---|---|
summary | Displays a summary of the Routing Information Base (RIB) |
connected | Displays the contents of the Routing Information Base (RIB) filtered to show only connected routes |
static | Displays the contents of the Routing Information Base (RIB) filtered to show only static routes |
bgp | Displays the contents of the Routing Information Base (RIB) filtered to show only those learned from BGP |
ospf | Displays the contents of the Routing Information Base (RIB) filtered to show only those learned from OSPF |
Description
The show rib subcommand displays the contents of the 128T router's Routing Information Base (RIB). This is the complete list of connected, direct, and learned routes on the system. (Note that the output may be quite verbose.)
When issuing the command without any arguments, the entire RIB is displayed.
Example
When a specific route is given as an argument to the command, more detail is shown for that route:
show rib bgp
Displays the contents of the Routing Information Base (RIB) filtered to show only those learned from BGP
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display the RIB |
rows | The number of rib entries to display at once [type: int or 'all'] (default: 50) |
Description
The show rib bgp subcommand displays the contents of the 128T router's Routing Information Base (RIB) filtered to show only those learned from BGP.
Example
show rib connected
Displays the contents of the Routing Information Base (RIB) filtered to show only connected routes
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display the RIB |
rows | The number of rib entries to display at once [type: int or 'all'] (default: 50) |
Description
The show rib connected subcommand displays the contents of the 128T router's Routing Information Base (RIB) filtered to show only the connected routes.
Example
show rib ospf
Displays the contents of the Routing Information Base (RIB) filtered to show only those learned from OSPF
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display the RIB |
rows | The number of rib entries to display at once [type: int or 'all'] (default: 50) |
Description
The show rib ospf subcommand displays the contents of the 128T router's Routing Information Base (RIB) filtered to show only those learned from OSPF.
Example
show rib static
Displays the contents of the Routing Information Base (RIB) filtered to show only static routes
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display the RIB |
rows | The number of rib entries to display at once [type: int or 'all'] (default: 50) |
Description
The show rib static subcommand displays the contents of the 128T router's Routing Information Base (RIB) filtered to show only static routes.
Example
show rib summary
Displays a summary of the Routing Information Base (RIB)
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router for which to display the RIB summary |
rows | The number of rib entries to display at once [type: int or 'all'] (default: 50) |
Description
The show rib summary command outputs a concise table with statistics on the RIB.
Example
show security key-status
Display detailed security key status.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display security key status |
router | The router for which to display security key status (default: <current router>) |
Description
The show security key-status subcommand displays information and statistics related to the 128T's security rekeying feature. It will indicate the current key index (which will be common among all routers managed by a 128T conductor) and relevant statistics on when the last rekey event occurred, when the next will occur, etc.
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
show service-path
Displays service path information at the specified node.
Usage
Keyword Arguments
name | description |
---|---|
contains-service-name | The partial substring match to show service path for |
detail | Display detail info of service path |
hierarchy-service-name | The hierarchy root to show service path for |
node | The node for which to display service path |
router | The router for which to display service path |
rows | The number of service path to display at once [type: int or 'all'] (default: 50) |
service-name | The exact service name to show service path for |
Description
The show service-path command display active service paths passing through the 128T router. The output is useful for figuring out where sessions belonging to a particular service would egress, during troubleshooting. This command has multiple service filters allowing target to specific service or services. Output can be displayed in summary or in detail view with pagination support.
show session-captures
Show active session-captures.
Usage
Keyword Arguments
name | description |
---|---|
detail | Display session-captures in detail |
force | Skip confirmation prompt. Only required when targeting all routers |
id | The session-capture to show in detail [type: int] |
node | The node on which to show session-captures |
router | The router on which to show session-captures (default: all) |
service | Service for which to show session-captures (default: all) |
See Also
command | description |
---|---|
create session-capture | Creates a session capture at the specified node and service. |
delete session-capture | Deletes session capture from selected service. |
delete session-capture by-id | Deletes session-capture by capture-id from selected service. |
show sessions
Displays active sessions passing through the 128T router.
Usage
Keyword Arguments
name | description |
---|---|
contains-service-name | The partial substring match to show sessions for |
force | Skip confirmation prompt. Only required when targeting all routers |
hierarchy-service-name | The hierarchy root to show sessions for |
node | The node from which to retrieve session flows |
router | The router from which to retrieve session flows |
rows | The number of session flows to display at once [type: int or 'all'] (default: 50) |
service-name | The exact service name to show sessions for |
Subcommands
name | description |
---|---|
by-id | <session-id> |
top | <bandwidth> |
Description
The show sessions command displays active sessions passing through the 128T router. The output from the command shows the sessions internal ID (useful for searching through log files), the service, tenant, and source/destination IP information for each active session. Additionally, you can specify the node using the optional node-name argument, and the session-id using the by-id subcommand.
The NAT IP and Port fields will be populated whenever a session is subject to source NAT (see source-nat later in this reference guide for more information). It also shows the timeout value that will cause the session to expire if it remains idle for that number of seconds.
Various services and tenants may display with surrounding braces to indicate that these are internally-generated services and tenants. These internal services and tenants are created when peering between adjacent nodes, establishing BGP sessions, BFD sessions, etc.
info
The contents of the table will vary based upon the software version in use. This applies when, for example, a conductor running a new software version requests session table data from routers running older software versions.
Examples
show sessions
show sessions by-id
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword to enforce PCLI consistency |
3.1.0 | Was show flows - Substantially reformatted output |
4.5.3 | Added by-id subcommand |
show sessions top bandwidth
Display the top sessions ordered by bandwidth.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The router for which to display top sessions by bandwidth |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Description
The top bandwidth subcommand will list, in order, the top ten highest consumers of bandwidth among all active sessions. This is useful to understand the current utilization on your 128T network resources.
Example
show step lsdb
Show STEP link state database
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
originator | The STEP originating router |
router | The router to request STEP information from |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
show step routes
Show STEP routes
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
ip-prefix | STEP routes for this ip prefix [type: IP prefix] |
node | STEP routes on this node |
router | The router to request STEP information from |
service | STEP routes for this service |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
show system
Display detailed system state.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display system state |
router | The router for which to display system state (default: <current router>) |
Subcommands
name | description |
---|---|
connectivity | Display inter-node connection statuses. |
services | Display a table summarizing statuses of 128T systemd services. |
processes | Display a table summarizing the statuses of processes. |
registry | Shows registered services from the system services coordinator for the specified process, node or router. |
version | Show system version information. |
See Also
command | description |
---|---|
show alarms | Display currently active or shelved alarms |
Description
The show system subcommand displays overall system health for the nodes that comprise your 128T router. It includes the state of the node ("starting" is displayed when the node is in the process of starting up and is not yet ready for handling traffic, "running" means the node is active, "offline" means the node is configured but not currently present), its role, software version, and uptime.
Example
show system connectivity
Display inter-node connection statuses.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display connection statuses |
router | The router for which to display connection statuses (default: <current router>) |
Subcommands
name | description |
---|---|
internal | Displays inter-node secure communication connections. |
Description
The connectivity subcommand displays the state of all connected systems. On a 128T Conductor, this is a convenient way to display all of the nodes that are connected, disconnected, or "unconfigured". (Note: when a node appears as unconfigured, it means that it is attempting to connect to the 128T conductor, but that conductor does not have any supporting configuration to supply to it.)
Example
show system connectivity internal
Displays inter-node secure communication connections.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display internal connections |
router | The router for which to display internal connections (default: <current router>) |
Description
The internal subcommand of show system connectivity internal will report all interprocess connections that are currently available on the system, as well as connections between a router and conductor (if applicable).
Example
show system processes
Display a table summarizing the statuses of processes.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display statuses of processes |
router | The router for which to display statuses of processes (default: <current router>) |
See Also
command | description |
---|---|
show stats process | Metrics about 128T processes |
Description
The processes subcommand will list the processes for all nodes in the cluster, and which processes on which nodes are considered leaders (from a high availability standpoint).
Example
show system registry
Shows registered services from the system services coordinator for the specified process, node or router.
Usage
Positional Arguments
name | description |
---|---|
router-name | The router from which to retrieve registered services (default: all) |
node-name | The node from which to retrieve registered services (default: all) |
process-name | The process from which to retrieve registered services (default: all) |
See Also
command | description |
---|---|
show stats registered-services | Stats pertaining to Registered Services |
show stats ssc | Metrics pertaining to the SSC |
Description
The registry subcommand shows the processes/services that have registered with the local system's "SSC" (system services coordinator). On a 128T Conductor, this will show all of the connected routers_ registered system processes/services.
Example
show system services
Display a table summarizing statuses of 128T systemd services.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display statuses |
router | The router for which to display statuses (default: <current router>) |
Description
Most 128T processes are under the control of a process aptly named the processManager. Some services must exist outside of the control of the processManager and are instead goverened by Linux's systemd. show system services
displays a table summarizing statuses of 128T systemd services.
Example
show system version
Show system version information.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node to show version information for |
router | The router to show version information for (default: <current router>) |
Positional Arguments
name | description |
---|---|
verbosity | detail | summary (default: summary) |
Description
The version argument displays more detailed information about the software build (number, date) that is running on your system.
Example
show tenant members
Shows the prefix-to-tenant associations by network-interface on the specified node.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node from which to retrieve tenant members |
router | The router from which to retrieve tenant members |
rows | The number of tenant members to display at once [type: int or 'all'] (default: 50) |
Description
The show tenant subcommand displays the mapping logic that the 128T router uses for associating the source IP address of inbound requests to tenant definitions – whether they be interface-based (i.e., a tenant has been configured on a network-interface) or member based (i.e., a prefix has been configured within a neighborhood).
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
show top sources
Shows top sources (by source address) over the last 30 minutes at the specified node.
Usage
Keyword Arguments
name | description |
---|---|
by | total-data | session-count [type: metric] (default: total-data) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node from which to retrieve top sources |
router | The router from which to retrieve top sources |
rows | The number of top sources to display at once [type: int or 'all'] (default: 10) |
Description
The show top sources command will render a table displaying the highest consumers (by source address) of data or rote number of sessions.
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
show udp-transform
Display the status of UDP transform between peers.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node for which to display transform status |
router | The router for which to display transform status |
Description
A 128T router may need to transform TCP packets into UDP packets to enable SVR to traverse stateful firewalls. By default, the 128T router runs a firewall detector process over peer paths, and will dynamically enable UDP transform when necessary. (Administrators may also elect to enable UDP transform if they know there are stateful firewalls in the path.) This command shows whether a path has UDP transform enabled, and if so, which firewall detection tests triggered the feature to be enabled.
Example
show user
Display information for user accounts.
Usage
Positional Arguments
name | description |
---|---|
username | the name of the account to display (default: <current user>) |
See Also
command | description |
---|---|
create user | Create a new user account interactively. |
delete user | Delete a user account |
edit prompt | Allows the user to specify a custom format for the PCLI prompt. |
edit user | Modify an existing user account |
restore prompt | Restore the PCLI prompt to the factory default. |
restore users factory-default | Restore the user configuration to factory defaults. |
set password | Change your password. |
Description
The show user subcommand displays the attributes for the specified user account (i.e., whether the account is enabled, the user's full name, and their role).
Example
If the 128T is configured to obtain user accounts from LDAP, the connectivity status of the LDAP server is displayed at the end of the output.
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
4.4.0 | LDAP status was added to show user all |
sync peer addresses
Synchronize dynamic addresses (DHCP and PPPoE) between routers and a conductor.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
router | The name of the router to synchronize (default: <current router>) |
See Also
command | description |
---|---|
show dynamic-peer-update | Display view of dynamic peer update on the conductor. |
show stats dynamic-peer-update | Stats pertaining to dynamic peer update processes |
Description
This command will force a network element (or group of network elements) to synchronize any dynamically-learned IP addresses to its conductor. (The conductor will redistribute these dynamic addresses to other members of the Authority as necessary.)
Example
Version History
Release | Modification |
---|---|
3.2.0 | This feature was introduced |
time
Force another command to display its execution time.
Usage
Positional Arguments
name | description |
---|---|
command | Command to run and time |
Description
When time
preceeds another command, it will provide the total amount of wall clock time it takes for the operation to complete. Natively not all PCLI commands output the duration it takes to complete the operation. The time command, much like the Linux version, provides this information.
Example
top
Usage
Description
This command sets the focus of the PCLI prompt to the top level of the PCLI's hierarchy. It is used while in configuration mode to "jump" up out and back to the baseline prompt. It is only available within configuration mode.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
up
Usage
Description
This command moves the administrative focus of the PCLI "up" the specified number of levels. When the optional <levels> argument is left off, it moves the focus up one level.
note
This command is only available while in configuration mode.
Example
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
validate
Validate the candidate config.
Usage
Keyword Arguments
name | description |
---|---|
router | The name of the router (default: all) |
Description
This command validates the current candidate configuration to check for referential integrity among the various configuration objects, to check for the use of deprecated configuration elements, and to supply warnings when various configuration elements cannot be validated.
Many configuration elements within the 128T router refer to other configuration elements by their name. If an administrator mistypes a name, or a referenced object is deleted without updating the source of that reference, this candidate configuration is said to be invalid. By using the validate command, administrators can ensure their configuration is valid prior to committing it to be the running configuration.
note
validation occurs automatically whenever the commit command is run; this standalone command allows administrators to check for validity without requiring that the configuration is committed immediately.
The validate
command provides warnings when a configuration contains deprecated elements - elements that are scheduled for removal in a future release of the 128T software. This is to give administrators the opportunity to replace the impacted configuration stanzas with their replacement.
The validate
command will also provide warnings when a configuration cannot be validated and requires administrative oversight.
When validation fails, the administrator is notified via output to the CLI. The output from the validate
command will identify the configuration that is failing validation.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
where
Display the current location in the CLI hierarchy.
Usage
Description
This command returns the user's current position within the CLI hierarchy. When executed from the main CLI prompt, it returns nothing. When executed from within the configuration tree, it returns the user's current position within the tree.
Example
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
write log message
Write a message to the log.
Usage
Keyword Arguments
name | description |
---|---|
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node on which to log |
router | The router on which to log (default: <current router>) |
Positional Arguments
name | description |
---|---|
message | The message to write to the log (messages with a space must be surrounded with quotes) |
process-name | The process to which to write a log message (default: all) |
See Also
command | description |
---|---|
rotate log | Rotate log files. |
set log level | Set the log level of a process. |
write log snapshot | Write a snapshot to the log. |
Description
The write log message
command lets administrators write messages into log files; this is typically used as a marker during troubleshooting exercises, to insert a string that can later be located to reference the onset of a test.
Example
This message will appear in the log files with the category type "USER", as is demonstrated here:
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
write log snapshot
Write a snapshot to the log.
Usage
Keyword Arguments
name | description |
---|---|
category | The log category for which to write the snapshot. (default: all) |
force | Skip confirmation prompt. Only required when targeting all routers |
node | The node on which to log |
router | The router on which to log (default: <current router>) |
Positional Arguments
name | description |
---|---|
process-name | The process to write a snapshot (default: all) |
See Also
command | description |
---|---|
rotate log | Rotate log files. |
set log level | Set the log level of a process. |
write log message | Write a message to the log. |
Description
The write log snapshot
command is debugging tool that outputs zookeeper state information related information to each respective process that utilizes zookeeper.
Example
show stats
Syntax
Description
The show stats command, and its myriad of subcommands, retrieve statistical data from various functions within the 128T router and return them to the user. Used for troubleshooting, debugging configuration, or just to monitor the health and well-being of the 128T router, these show commands provide a wealth of information and insight to users of the software.
Below is a representative sample of one of the show stats commands.
note
The number and types of columns displayed may vary from software release to software release, as new statistics become available.
note
In this example the Port value of 255 represents packets that are being sent to the CPU on the receiving 128T for additional processing – namely, the first packet of a new session. Many of the show stats commands will reference port 255, and in all cases this value 255 represents an "internal" port created by the 128T router for interprocess communication purposes.
Each table of output can be displayed in three different modes of verbosity: debug, detail, and summary. The default is detail, which consolidates all traffic from various CPU cores that have been allocated to packet processing into a single value.
The value debug shows a breakdown of all statistics into their most granular constituent components. For the access-policy-table, this will show how many access-policy-table hits have occurred by CPU core.
The value summary, the least verbose, summarizes all of the statistics system-wide.
As of software version 3.1, the show stats command provides an additional feature, the ability to set a "zero point" for displaying statistical output using the since command. The since command takes either a timestamp as its argument (in ISO 8601 format), or the keyword launch, which shows statistics accumulated since the 128T routing software was launched. For more information on the zero point, refer to the section of this guide on set context stats.
Generally speaking, the statistical data available via the 128T router's PCLI is organized into a tree-like hierarchy, with each subcommand having (potentially) its own series of subcommands. By omitting the (optional) subcommands, the 128T router will summarize all data from all possible subcommands and present it in a summary table (this is new behavior as of our 1.1 software release); while this is very convenient to show a lot of potential data at a glance, it does incur additional processing overhead, and the retrieval of statistics may take an inordinately long time.
Each of the various show stats subcommands will be described in sections that follow.
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
1.1.0 | Made significant improvements to the ability to filter the data, summarize the data. Improved the output format for all stats tables. |
show stats aggregate-session
Syntax
Description
The show stats aggregate-session command and its various subcommands show aggregate data about session traffic traversing the 128T router, through a variety of different aggregation lenses. Each of the subcommands lets users show different "cuts" of the session data; e.g., the by-service-route subcommand will show all traffic associated with the configured service-route elements on a given system.
Each of the subcommands includes the following data:
Data Specifier | Description |
---|---|
bandwidth | The amount of bandwidth in bytes/second. |
rx-data | The amount of data received in bytes. |
rx-packets | The number of packets received. |
rx-tcp-data | The amount of data received over TCP. |
rx-tcp-packets | The number of TCP packets received. |
rx-tcp-retransmissions | The number of duplicate TCP packets received. |
rx-udp-data | The amount of data received over UDP. |
rx-udp-packets | The number of UDP packets received. |
session-arrival-rate | The arrival rate (in new sessions per second) for traffic. |
session-count | The number of active sessions. |
session-departure-rate | The number of sessions terminated per second. |
total-data | The total amount of data for all sessions. |
total-packets | The total number of packets received and sent. |
total-tcp-data | The total amount of data received and sent over TCP. |
total-tcp-packets | The total number of TCP packets sent and received. |
total-tcp-retransmissions | The total number of TCP retransmissions sent and received. |
total-udp-data | The total amount of data received and sent over UDP. |
total-udp-packets | The total number of UDP packets sent and received over UDP. |
tx-data | The total amount of data transmitted. |
tx-packets | The total number of packets transmitted. |
tx-tcp-data | The total amount of data transmitted over TCP. |
tx-tcp-packets | The total number of packets transmitted over TCP. |
tx-tcp-retransmissions | The total number of TCP retranmissions sent. |
tx-udp-data | The total amount of UDP data sent. |
tx-udp-packets | The total number of packets sent using UDP. |
Within each of the various lenses, the output can be filtered down to an constituent element of that type; for example, the show stats aggregate-session by-device-interface can filter the output to display the statistics for a single device-interface. This is done after the data specifier, as follows:
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
3.0.0 | This feature was introduced |
show stats arp
Syntax
Description
The show stats arp command has a variety of subcommands to display statistical information on various aspects of the 128T router's handling of sent and received ARP messages. Each of those will be described in the sections that follow.
Omitting the subcommand will cause the 128T router to aggregate statistics from all of the subcommands and present them in tabular view; as there are a lot of subcommands, this command may take a very long time to accumulate – particularly on a busy system.
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats arp encapsulation
Syntax
Description
The show stats arp encapsulation command has a variety of command-line modifiers that show statistics related to the transmission of Layer 2 encapsulation of IP packets.
When no subcommand is specified, the 128T router will return statistics on all subcommands and present them in a summary table:
Each of the two commands beneath show stats arp encapsulation display a similar table, one example of which is shown below:
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats arp entries
Syntax
Description
The show stats arp entries command displays tabular data regarding the number of ARP entries that the 128T router has in its ARP cache. Sample output is below:
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats arp queued
Syntax
Description
The show stats arp queued command has three modes, depending on the command line arguments used when it is invoked. The two failure modes (drop and queue full) will display counts for the number of packets that are dropped due to the failure to receive a response to an ARP request issued by the 128T router, and the number of packets that failed to enqueue due to a failed ARP request, respectively.
The show stats arp queued packets command shows the number of packets waiting in queues for a pending ARP transation.
All three of these commands will display tabular data such as the following:
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats arp received
Syntax
Description
The show stats arp received command has a variety of command line modifiers to show various sets of statistics regarding the ARP traffic that this system has received. The arp-reply and arp-request modifiers show the number of ARP replies and requests that the 128T router has received, respectively. Each of these commands outputs its data in a table that looks like the following:
The show stats arp received errors command has a list of modifiers to allow users to see the statistics regarding to the number of invalid or ignored ARP/ICMPv6 packets in various forms. These statistics are particularly useful during troubleshooting exercises; large numbers of ARP receive errors may be emblematic of larger network issues.
The ARP reply and ARP request modifiers show statistics related to the number of errors related to the receipt of ARP replies and requests. The neighbor-advertisement and neighbor-solicit modifiers show errors related to the receipt of ICMPv6 errors. When the 128T router has difficulties with processing ARP or ICMPv6 packets, they will increment the values in the processing table. Unclassified (or unclassifiable) ARP/ICMPv6 packets received will increment the values in the unknown-type table.
All of the modifiers (arp-reply, arp-request, neighbor-advertisement, neighbor-solicit, processing, unknown-type) show their data in a similar format:
The show stats arp received neighbor-advertisement and neighbor-solicit modifiers are used to show statistics regarding the number of ICMPv6 packets received. Note that at this time the 128T router can classify ICMPv6 packets, even in the absence of full IPv6 support.
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats arp sent
Syntax
Description
The show stats arp sent command has two modes: success and failure. Each of these modes shows tabular data relating to successful or failed ARP events, and outputs its counters in tabular format such as the following:
The success modifier tallies the number of ARP transmission events for requests, replies, and gratuitous ARPs. The failure modifier increments when various ARP transmission events occur; allocation shows the number of allocation failures when the 128T router fails to send an ARP packet, arp-request and arp-reply show the number of errors when sending requests and replies, and gratuitous-arp shows the number of failed gratuitous ARP transmission attempts. The various modifiers associated with ICMPv6 are not in use at this time.
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats bfd
Syntax
Description
The show stats bfd command is used for determining the health of the 128T router's (BFD) Bidirectional Forwarding Detection processing. The various modifiers associated with show stats bfd are enumerated in the sections that follow.
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added by-peer-path statistics, and verbosity modifier |
show stats bfd by-peer-path
Syntax
Description
The show stats bfd by-peer-path command shows the values for jitter, latency, and packet loss as measured and reported by the BFD processing between this 128T router and one of its configured peers. This is helpful for troubleshooting connectivity issues and/or understanding why a particular path has been deprioritized over another, when link quality measurements are factored into a routing decision.
The peer-path is displayed in the following format:
- peerName/adjacencyAddress/nodeName/nodeInterface/nodeVLAN
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
3.0.0 | This feature was introduced |
show stats bfd neighbor
Syntax
Description
The show stats bfd neighbor counts the number of times that a neighbor has had a failover (a switchover where a pair of devices has exchanged active control of packet processing) or a NAT address has changed, as detected by BFD.
Generally speaking, devices behind dynamic NATs will be accessible via a specific IP:port in perpetuity as long as the port is refreshed frequently enough to keep that NAT's binding alive. However, NATs can be rebooted and pinholes can close; this statistic will let you know if the 128T router detected its neighbor has changed NAT ports over time.
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
2.0.0 | This feature was introduced |
3.0.0 | added statistics to count failover events (via num-failover-events) |
show stats bfd received invalid
Syntax
Description
The show stats bfd received invalid command, with its modifiers, shows the administrator the count for all BFD packets that were deemed invalid, broken down into categories for which the 128T router failed to handle them. The authentication-field modifier counts the number of BFD packets that had an invalid authorization field, the detect-multiple packets had an invalid multiplier value, and the discriminator had an invalid discriminator. The various header- modifiers count whether or not the header of the BFD packet was too large, too small, or had the wrong version information within it. The length-packets modifier counts the number of packets marked invalid due to an incorrect length. Packets that arrive under the minimum size threshold for BFD packets are invalidated and shown in the payload-small counter. The total of all invalid packets is captured in the table shown by the packets modifier.
All of the modifiers will display a table similar to the following:
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats bfd received processed
Syntax
Description
The show stats bfd received processed command shows the current count of the number of BFD packets that the 128T router has received and successfully processed.
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats bfd received total
Syntax
Description
The show stats bfd received total counter displays the number of BFD packets that the 128T router has received (valid and invalid).
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |
show stats bfd received valid
Syntax
Description
The show stats bfd received valid counter shows the number of valid BFD packets that the 128T router has received.
Privileges Required
Available to admin and user.
Version History
Release | Modification |
---|---|
1.0.0 | This feature was introduced |
3.0.0 | Added node keyword and verbosity specifiers |