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
Usage
Keyword Arguments
- device-interface the device interface on which to clear the ARP cache
- force Skip confirmation prompt
- ip the IP address for which to clear an ARP entry (must specify '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 specify 'device-interface') [type: int]
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.
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
See Also
- show arp Shows current arps from the highway manager at the specified node
clear bgp
Usage
Keyword Arguments
- force Skip confirmation prompt
- 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
- neighbor neighbor ip-address [type: IP address or 'all']
Description
Clear routes associated with one or all BGP neighbors.
See Also
- show bgp Show the current BGP routes from the routing manager
clear context node
Usage
Description
Clear only the node context.
See Also
- clear context router Clear both the router context and 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 router
Usage
Description
Clear both the router context and node context.
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.
clear events admin
Usage
Description
Clears admin event records.
clear events alarm
Usage
Description
Clears alarm event records.
clear events all
Usage
Description
Clears all event records.
clear events system
Usage
Description
Clears system event records.
clear events traffic
Usage
Description
Clears traffic event records.
clear history
Usage
Description
Clear the PCLI's command history.
See Also
- show history Show PCLI command history for the current user
commit
Usage
Keyword Arguments
- 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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 3.0.0 | force feature was added |
compare
Usage
Positional Arguments
- old The original configuration against which differences should be computed
- new The updated configuration for which differences should be computed
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:
Privileges Required
Available to admin and user accounts.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
See Also
- delete config exported Deletes 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
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.
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | command was renamed to configure from config |
connect
Usage
Keyword Arguments
- force Skip confirmation prompt
- node node to connect to
- router router to connect to
- username Username to use for login to the Managed Router (default: <current user&rt;a)
Description
Connect to a Managed Router. For more information, read Connecting to 128T Routers from Conductor.
create capture-filter
Usage
Keyword Arguments
- device-interface The device interface on which to create 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
- capture-filter The capture-filter to remove (Uses BPF syntax)
Description
Creates a capture-filter using BPF syntax (as used in wireshark) on the target interface.
Example
Version History
| Release | Modification |
|---|---|
| 4.4.0 | This feature was introduced |
See Also
- delete capture-filter Deletes capture-filter from highway at the specified node
- show capture-filters Show active capture-filters
create certificate request webserver
Usage
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/.
See Also
- create certificate self-signed webserver Create a self-signed webserver certificate
- delete certificate webserver Delete the webserver certificate
- import certificate webserver Import the webserver certificate
- show certificate webserver Display the webserver certificate
create certificate self-signed webserver
Usage
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
See Also
- create certificate request webserver Create a signing request for the webserver
- delete certificate webserver Delete the webserver certificate
- import certificate webserver Import the webserver certificate
- show certificate webserver Display the webserver certificate
create user
Usage
Positional Arguments
- username the name of the account to create
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
See Also
- delete user Delete a user account
- edit prompt Allows the user to specify a custom format for the PCLI prompt
- edit user Command to edit an existing user account
- restore prompt Reset the PCLI prompt to the factory default
- restore users factory-default Restore the user configuration to factory defaults
- set password Command to change a user's own password
- show user Command to show user accounts
delete capture-filter
Usage
Keyword Arguments
- 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
- capture-filter The capture-filter to remove (Uses BPF syntax)
Description
Deletes a capture-filter created using create capture-filter. (It will not delete filters committed as part of the configuration.)
Example
Version History
| Release | Modification |
|---|---|
| 4.4.0 | This feature was introduced |
See Also
- create capture-filter Creates capture-filter from highway at the specified node
- show capture-filters Show active capture-filters
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
delete certificate webserver
Usage
Keyword Arguments
- force Skip confirmation prompt
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
See Also
- create certificate request webserver Create a signing request for the webserver
- create certificate self-signed webserver Create a self-signed webserver certificate
- import certificate webserver Import the webserver certificate
- show certificate webserver Display the webserver certificate
delete config exported
Usage
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
See Also
- compare config Commands for displaying the differences between configurations
- 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
delete flows
Syntax
Keyword Arguments
- 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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
delete sessions
Usage
Keyword Arguments
- 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.
Privileges Required
Available to admin only.
delete user
Syntax
Keyword Arguments
- force Skip confirmation prompt
Positional Arguments
- username the name of the account to delete
Description
The delete user command deletes a user account that had previously been created via the create user command.
Example
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
See Also
- create user Create a new user account interactively
- edit prompt Allows the user to specify a custom format for the PCLI prompt
- edit user Command to edit an existing user account
- restore prompt Reset the PCLI prompt to the factory default
- restore users factory-default Restore the user configuration to factory defaults
- set password Command to change a user's own password
- show user Command to show user accounts
edit prompt
Usage
Positional Arguments
- format format string for the prompt display
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.
The format string can accept the following special variables and patterns:
| Variable Name | Variable Contents |
|---|---|
| {user} | Name of the currently logged in user (e.g., "admin") |
| {address} | Full name (node.router) of the current system |
| {node} | The name of the current node |
| {router} | The name of the router |
| {context} | Currently set context if one is set; empty otherwise. See set context for more information. |
| {path} | Full path to the current PCLI menu, separated by '/' |
| {location} | Name of current PCLI menu |
| {privilege} | "#" if the current user has administrator privileges, else ">" |
The set prompt format also supports conditional content, by using a conditional statement with the following
The conditional is broken into three parts; the conditionalVariable is one of the following types, and will evaluate to true or false based on the current PCLI state. The trueFormat value is in "prompt format" syntax, and will be included in the prompt if the conditional variable evaluates to true; likewise, the falseFormat is included if the conditional variable evaluates to false.
| Conditional | Evaluation |
|---|---|
| {top-level} | Evaluates to true if the PCLI is at the top level, evaluates to false otherwise. |
For example:
The edit prompt format string also supports various timestamp codes as described by strftime format codes.2
For example:
Also, there are various special/reserved characters, as well as character that must be escaped if you use them in a format string. This includes:
| Character | Format String Representation |
|---|---|
| newline | \n |
| tab | \t |
| [ | [ |
| ] | ] |
| { | {{ |
| } | }} |
| % | %% |
| ! | ! |
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 3.1.0 | This feature was introduced |
See Also
- 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 Reset the PCLI prompt to the factory default
- restore users factory-default Restore the user configuration to factory defaults
- set password Command to change a user's own password
- show user Command to show user accounts
edit user
Usage
Positional Arguments
- username the name of the account to modify (default: <current user&rt;)
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:
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
See Also
- 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 Reset the PCLI prompt to the factory default
- restore users factory-default Restore the user configuration to factory defaults
- set password Command to change a user's own password
- show user Command to show user accounts
exit (in config)
Usage
Description
The exit command moves your focus to the PCLI home.
Example
Privileges Required
Available to admin only; exit is only available within configuration mode.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
export config
Usage
Positional Arguments
- datastore running | candidate
- export-name a name consisting of alphanumeric characters or any of the following: . - _
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
| 3.1.0 | The location of the exported configuration changed |
See Also
- compare config Commands for displaying the differences between configurations
- delete config exported Deletes 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
- show config exports Display configuration exports
- show config version Display running configuration version
- show events config commit Shows events related to running config change
import certificate webserver
Usage
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
See Also
- create certificate request webserver Create a signing request for the webserver
- create certificate self-signed webserver Create a self-signed webserver certificate
- delete certificate webserver Delete the webserver certificate
- show certificate webserver Display the webserver certificate
import config
Usage
Keyword Arguments
- force Skip confirmation prompt
Positional Arguments
- name name of the configuration file to import
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
See Also
- compare config Commands for displaying the differences between configurations
- delete config exported Deletes 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
- show config exports Display configuration exports
- show config version Display running configuration version
- show events config commit Shows events related to running config change
import iso
Usage
Keyword Arguments
- 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
Description
Imports a 128T ISO to the local repository.
Example
Version History
| Release | Modification |
|---|---|
| 4.4.0 | This feature was introduced |
migrate
Usage
Keyword Arguments
- conductor the address(es) of the conductor node(s) to migrate to
- force Skip confirmation prompt
- router router to migrate
- skip-validation attempt to migrate the router without checking if migration is possible
Description
Migrate a 128T router to a new conductor. For more details on the 128T rotuer migration read the How to: Conductor Migration.
See Also
- 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 automated provisioner
ping
Usage
Keyword Arguments
- count number of ping requests to send [type: int] (default: 4)
- egress-interface network interface from which to ping
- force Skip confirmation prompt
- 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
- 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
Privileges Required
Available to admin.
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
Usage
Description
This command logs the user out, and quits the PCLI.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
refresh dns resolutions
Usage
Description
Refreshes all DNS resolutions configured on the platform.
Keyword Arguments
- force Skip confirmation prompt
- hostname the DNS hostname belonging to a node
- router The name of the router
See Also
- set dns resolution Sets a hostname resolution temporarily until the next time the node processes config
- show dns resolutions show all entries in the DNS
release dhcp lease
Usage
Keyword Arguments
force Skip confirmation prompt network-interface the network interface on which to release the current DHCP lease node The name of the node (default: all) router The name of the router
Description
Releases the current DHCP lease for a specified network-interface.
See Also
- 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
Usage
Keyword Arguments
- 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
- command command to repeat
Description
Repeat any command multiple times. 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
Usage
Keyword Arguments
- all replace all matching data without prompts
- 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
- query a query string
- replacement a string with which to replace patterns that match the query; in regex mode, numbered group-matching variables can be used for more complex replacement
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 3.1.0 | This feature was introduced |
restore config factory-default
Usage
Keyword Arguments
- force Skip confirmation prompt
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced. Replaces the deprecated reset-factory-default-config |
See Also
- compare config Commands for displaying the differences between configurations
- delete config exported Deletes 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
restore config running
Usage
Keyword Arguments
- force Skip confirmation prompt
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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
| 2.0.0 | previously named restore config candidate |
See Also
- compare config Commands for displaying the differences between configurations
- delete config exported Deletes 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
restore prompt
Usage
Keyword Arguments
- force Skip confirmation prompt
Description
The restore prompt command returns the PCLI's prompt to its factory default, in the event that an administrator has modified it.
Example
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 3.1.0 | This feature was introduced |
See Also
- 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 Command to edit an existing user account
- restore users factory-default Restore the user configuration to factory defaults
- set password Command to change a user's own password
- show user Command to show user accounts
restore users factory-default
Usage
Keyword Arguments
- force Skip confirmation prompt
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.
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
See Also
- 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 Command to edit an existing user account
- restore prompt Reset the PCLI prompt to the factory default
- set password Command to change a user's own password
- show user Command to show user accounts
rotate log
Usage
Keyword Arguments
- force Skip confirmation prompt
- node the node for which to rotate logfiles
- router the router for which to rotate logfiles
Positional Arguments
- process-name the process for which to rotate logfiles (the logfiles for all processes will rotate when no process is specified) (default: all)
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.
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
See Also
- set log level Set the process log level
- write log message Write a message to the log
- write log snapshot Write a snapshot to the log
save runtime-stats
Usage
Keyword Arguments
- force Skip confirmation prompt
- node target node from which to gather runtime stats
- router target router from which to gather runtime stats
Positional Arguments
- filename custom filename to store system information
- process-name target process from which to gather runtime stats (default: all)
Description
Gathers runtime process stats and stores it in a logfile.
Example
save tech-support-info
Usage
Positional Arguments
- filename custom filename to store system information
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
Usage
Keyword Arguments
- 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
- query a query string
Subcommands
- config Search all configuration data
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 query 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
Usage
Keyword Arguments
- 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
- query a query string
Description
The output of search can be filtered by explicitly specifying commands configuration.
Example
search config
Usage
Keyword Arguments
- 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
- query a query string
Subcommands
- candidate Search candidate configuration data
- running Search running configuration data
Description
Searches all configuration data
Example
search config candidate
Usage
Keyword Arguments
- 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
- query a query string
Description
The output of search config can be filtered by explicitly specifying candidate configuration.
Example
search config running
Usage
Keyword Arguments
- 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
- query a query string
Description
The output of search config can be filtered by explicitly specifying running configuration.
Example
search config-attributes
Usage
Keyword Arguments
- 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
- query a query string
Description
The output of search can be filtered by explicitly specifying config-attributes configuration.
Example
send command download
Usage
Keyword Arguments
- dry-run view version changes without command execution
- force Skip confirmation prompt
- router router on which to download software
Positional Arguments
- 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
Description
Attempt to reconnect an asset
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
send command reconnect
Usage
Keyword Arguments
- force Skip confirmation prompt
- node The name of the node
- router The name of the router
Subcommands
- disconnected Attempt to reconnect all disconnected assets
Description
Attempt to reconnect an asset
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
send command reconnect disconnected
Usage
Keyword Arguments
- force Skip confirmation prompt
Description
Attempt to reconnect all disconnected assets.
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
send command restart
Usage
Keyword Arguments
- force Skip confirmation prompt
- node node to restart
- router router to restart
Description
Restart a 128T node.
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
send command rollback
Usage
Keyword Arguments
- force Skip confirmation prompt
- router router to rollback
Description
Rollback a 128T router to the previously installed version.
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
send command start
Usage
Keyword Arguments
- force Skip confirmation prompt
- node node to start
- router router to start
Description
Start a 128T node.
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
send command stop
Usage
Keyword Arguments
- force Skip confirmation prompt
- node node to stop
- router router to stop
Description
Stop a 128T node.
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
send command upgrade
Usage
Keyword Arguments
- dry-run view version changes without command execution
- force Skip confirmation prompt
- router router to upgrade
Positional Arguments
- 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
Description
Upgrade a 128T node.
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
send command yum-cache-refresh
Usage
Keyword Arguments
- force Skip confirmation prompt
- router router to refresh
Description
Refresh the yum cache as well as the 128T software versions available for download and upgrade.
send command is only available within the PCLI of a 128T Conductor.
See Also
- 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 automated provisioner
service-ping
Usage
Keyword Arguments
- count number of ping requests to send [type: int] (default: 4)
- force Skip confirmation prompt
- 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
- 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
Privileges Required
Available to admin.
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 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.
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
- 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
set context stats start-time
Usage
Positional Arguments
- 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
set log level
Usage
Keyword Arguments
- category The log category for which to set the level. Default is all categories.
- force Skip confirmation prompt
- node the node on which to set the corresponding process log level
- router the router on which to set the corresponding process log level
Positional Arguments
- 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
- configured Reset the process log level to the configured system log level
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 <processName> and <nodeName> 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:
| CategoryName | 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. |
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
| 3.1.0 | Log categories introduced |
See Also
- rotate log Rotate log files
- write log message Write a message to the log
- write log snapshot Write a snapshot to the log
set log level configured
Usage
Keyword Arguments
- category The log category for which to reset the level. Default is all categories.
- force Skip confirmation prompt
- node node on which to set the corresponding process log level
- router router on which to set the corresponding process log level
Positional Arguments
- 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)
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
Usage
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.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
See Also
- 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 Command to edit an existing user account
- restore prompt Reset the PCLI prompt to the factory default
- restore users factory-default Restore the user configuration to factory defaults
- show user Command to show user accounts
shell
Usage
Positional Arguments
- 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
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
show alarms
Usage
Keyword Arguments
- force Skip confirmation prompt
- id ID for which to display alarm information
- router router for which to display alarms (default: all)
- shelved Display shelved alarms
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
Privileges Required
Available to admin and user.
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. |
See Also
- show events alarm Show alarm events from the historical events database
show application names
Usage
Keyword Arguments
- force Skip confirmation prompt
- 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
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
show arp
Usage
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
Privileges Required
Available to admin and user.
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
Usage
Keyword Arguments
- force Skip confirmation prompt
- name Network interface to display (if omitted, all will be displayed)
- node node for which to display proxy ARP info
- router router for which to display proxy ARP info
Description
Displays a list of all configured proxies, grouped by network interface.
Example
show assets
Usage
Keyword Arguments
- force Skip confirmation prompt
- node node for which to display assets
- router router for which to display assets (default: all)
Positional Arguments
- id the asset id of the 128T node from which to retrieve the status
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:
Privileges Required
Available to admin only.
Version History
| Release | Modification |
|---|---|
| 3.1.0 | This feature was introduced |
See Also
- 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 automated provisioner
show assets errors
Usage
Keyword Arguments
- force Skip confirmation prompt. Only required when targeting all routers
- router router for which to display assets summary (default: all)
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
Usage
Keyword arguments:
- force Skip confirmation prompt. Only required when targeting all routers
- node node for which to display available software
- router router for which to display available software (default: all)
Description
Displays software related information for each managed asset. In particular, it displays the current running version of software, any versions available for download, software versions that are currently being downloaded and those that have been downloaded which can be used to upgrade the platform.
Example
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
See Also
- 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 automated provisioner
show assets summary
Usage
Keyword Arguments
- force Skip confirmation prompt. Only required when targeting all routers
- router router for which to display assets summary (default: all)
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 |
See Also
- 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
show bgp
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display BGP routes
Positional Arguments
- route route ip-prefix [type: IP prefix]
Subcommands
- neighbors Show the current BGP neighbors from the routing manager
- summary Show the current BGP summary from the routing manager
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).
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
show bgp neighbors
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display BGP neighbors
Positional Arguments
- 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.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
show bgp summary
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display the BGP summary
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
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
show capacity
Usage
Keyword Arguments
- force Skip confirmation prompt
- node the node from which to retrieve capacities
- router the router from which to retrieve capacities
Description
Shows current fib/flow/arp/action usage and capacities at the specified node
Example
show capture-filters
Usage
Keyword Arguments
- 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)
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 |
See Also
- create capture-filter Creates capture-filter from highway at the specified node
- delete capture-filter Deletes capture-filter from highway at the specified node
show certificate webserver
Usage
Description
This command displays the contents of the webserver certificate.
Example
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
See Also
- create certificate request webserver Create a signing request for the webserver
- create certificate self-signed webserver Create a self-signed webserver certificate
- delete certificate webserver Delete the webserver certificate
- import certificate webserver Import the webserver certificate
show config candidate
Syntax
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:
Privileges Required
Available to admin and user.
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
Usage
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
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.0.0 | This feature was introduced |
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:
Privileges Required
Available to admin and user.
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
Usage
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
Privileges Required
Available to admin and user.
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 |
show device-interface
Usage
Keyword Arguments
- force Skip confirmation prompt
- name device interface to display (if omitted, all will be displayed)
- node node for which to display device interfaces
- router router for which to display device interfaces
Positional Arguments
- verbosity detail | summary (default: 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
Privileges Required
Available to admin and user.
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 |
show dhcp mappings
Usage
Keyword Arguments
- force Skip confirmation prompt
- 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)
Description
Show each DHCP mapping from an interface to mapping/IP family/config types
Example
See Also
- release dhcp lease Release the current DHCP lease for a specified network-interface
- 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
show dhcp prefix-delegation
Usage
Keyword Arguments
- force Skip confirmation prompt
- group prefix-delegation group to display (if omitted, all will be displayed)
- router The name of the router to show
Positional Arguments
- verbosity detail | summary (default: summary)
Description
Show the prefix learned for prefix-delegation
Example
See Also
- release dhcp lease Release the current DHCP lease for a specified network-interface
- 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
show dhcp v4
Usage
Keyword Arguments
- force Skip confirmation prompt
- name Network interface to display (if omitted, all will be displayed)
- node node for which to display dhcp lease info
- router router for which to display dhcp lease info
Positional Arguments
- verbosity detail | summary (default: summary)
Description
Display dhcp lease info for network-interfaces
Example
Specifying the argument detail provides additional information
See Also
- release dhcp lease Release the current DHCP lease for a specified network-interface
- 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
show dhcp v6
Usage
Keyword Arguments
- force Skip confirmation prompt
- name Network interface to display (if omitted, all will be displayed)
- node node for which to display dhcp lease info
- router router for which to display dhcp lease info
Positional Arguments
- verbosity detail | summary (default: summary)
Description
Display DHCP lease info for network-interfaces
Example
See Also
- release dhcp lease Release the current DHCP lease for a specified network-interface
- 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 dns resolutions
Usage
Keyword Arguments
- force Skip confirmation prompt
- hostname The DNS hostname belonging to a node
- router The name of the router holding the node with the DNS resolutions
- rows The number of dns resolutions to display at once [type: int or 'all'] (default: 50)
Positional Arguments
- verbosity detail | summary (default: summary)
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
See Also
- refresh dns resolutions Refresh DNS resolutions
- set dns resolution Sets a hostname resolution temporarily until the next time the node processes config
show entitlement
Usage
Keyword Arguments
- force Skip confirmation prompt
- 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.
Description
This command displays the bandwidth entitlement for your 128T router.
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. For more information on the specifics of the 128T entitlement, visit the 128 Technology website.
Example
The asterisk next to the date indicates the current month and therefore a partial entitlement calcuation.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
show events alarm
Usage
Keyword Arguments
- force Skip confirmation prompt
- from Only show events after the provided time. [type: timestamp]
- router the name of the router for which to display alarm events
- rows the number of alarm events to display [type: int or 'all']
- to Only show events before the provided time. [type: timestamp]
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
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.1.0 | This feature was introduced |
See Also
- show alarms Display currently active or shelved alarms
show fib
Usage
Keyword Arguments
- force Skip confirmation prompt
- 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
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 3.0.0 | Added node keyword to enforce PCLI consistency |
show history
Usage
Keyword Arguments
- rows the number of recent commands to show [type: int or 'all']
Description
Show the PCLI command history for the current user.
Example
See Also
- clear history Clear the PCLI's command history
show load-balancer
Usage
Keyword Arguments
- agent Agent name to show. If unspecified, shows all agents.
- force Skip confirmation prompt
- 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
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
show network-interface
Usage
Keyword Arguments
- force Skip confirmation prompt
- name Network interface to display (if omitted, all will be displayed)
- node node for which to display network-interface data
- router router for which to display network-interface data
Subcommands
- application Display application data 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
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
show network-interface application
Usage
Keyword Arguments
- name Network interface to display (if omitted, all will be displayed)
- node node for which to display network-interface 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
Usage
Keyword Arguments
- force Skip confirmation prompt
- node the node from which to retrieve ntp status
- router the router from which to retrieve ntp status
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.
Privileges Required
Available to admin and user accounts. Updated in 3.0, added node keyword to enforce PCLI consistency.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show ospf
Usage
Keyword Arguments
- area the area to filter OSPF information for
- force Skip confirmation prompt
- router the router to request OSPF information from
Positional Arguments
- verbosity detail | summary (default: summary)
Subcommands
- border-routers Show information about the OSPF border routers
- database Show OSPF database information
- interfaces Show information about the OSPF interfaces
- neighbors Show information about OSPF neighbors
- routes Show information about the OSPF routes
Description
Show general information about OSPF
Example
Specifying the argument detail provides additional information
show ospf border-routers
Usage
Keyword Arguments
- force Skip confirmation prompt
- router the router to request OSPF information from
Positional Arguments
- verbosity detail | summary (default: summary)
Description
Show information about the OSPF border routers
Example
Specifying the argument detail provides additional information
show ospf database
Keyword Arguments
- force Skip confirmation prompt
- router the router to request OSPF information from
- self-originate retrieve only self-originated LSA information
Positional Arguments
- verbosity detail | summary (default: summary)
Subcommands
- lsa Show OSPF database LSA information
- max-age Show OSPF LSAs which have reached maximum age
Description
Show OSPF database information
Example
Specifying the argument detail provides additional information
show ospf database lsa
Usage
Keyword Arguments
- force Skip confirmation prompt
- 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
- verbosity detail | summary (default: summary)
Description
Show OSPF database LSA information
Example
Specifying the argument detail provides additional information
show ospf database max-age
Usage
Keyword Arguments
- force Skip confirmation prompt
- router the router to request OSPF information from
Description
Show OSPF LSAs which have reached maximum age
Example
show ospf interfaces
Usage
Keyword Arguments
- force Skip confirmation prompt
- network-interface the network interface to fetch OSPF information for
- router the router to request OSPF information from
Positional Arguments
- verbosity detail | summary (default: summary)
Description
Show information about the OSPF interfaces
Example
Specifying the argument detail provides additional information
show ospf neighbors
Usage
Keyword Arguments
- force Skip confirmation prompt
- 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
- verbosity detail | summary (default: summary)
Description
Show information about OSPF neighbors
Example
Specifying the argument detail provides additional information
show ospf routes
Usage
Keyword Arguments
- force Skip confirmation prompt
- router the router to request OSPF information from
Positional Arguments
- verbosity detail | summary (default: summary)
Description
Show information about the OSPF routes
Example
Specifying the argument detail provides additional information
show peers
Usage
Keyword Arguments
- force Skip confirmation prompt
- name peer to display (if omitted, all will be displayed)
- router router on which to display peers
Positional Arguments
- verbosity detail | summary (default: summary)
Subcommands
- 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.
Privileges Required
Available to admin and user accounts.
Version History
| Release | Modification |
|---|---|
| 3.0.0 | This feature was introduced |
show peers hostnames
Usage
Keyword Arguments
- force Skip confirmation prompt
- router router on which to display peer hostnames (default: all)
Description
Display resolved hostnames of peers
show platform
Usage
Keyword Arguments
- force Skip confirmation prompt
- node node for which platform info will be displayed
- router router for which platform info will be displayed
Positional Arguments
- category all | cpu | device-interfaces | disk | memory | operating-system | vendor (default: all)
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
Privileges Required
Available to admin and user accounts.
Version History
| Release | Modification |
|---|---|
| 3.0.0 | This feature was introduced |
show rib
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display RIB routes
Positional Arguments
- route route ip-prefix [type: IP prefix]
Subcommands
- bgp Show the BGP RIB routes from the routing manager
- connected Show the connected RIB routes from the routing manager
- ospf Show the OSPF RIB routes from the routing manager
- static Show the static RIB routes from the routing manager
- summary Show the current RIB summary from the routing manager
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
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display the RIB summary
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
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display the RIB summary
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
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display the RIB summary
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
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display the RIB summary
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
Usage
Keyword Arguments
- force Skip confirmation prompt
- router The name of the router for which to display the RIB summary
Description
The show rib summary command outputs a concise table with statistics on the RIB.
Example
show security key-status
Usage
Keyword Arguments
- force Skip confirmation prompt
- node node for which to display security key status
- router router for which to display security key status
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
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
show sessions
Usage
Keyword Arguments
- contains-service-name The partial substring match to show sessions for
- force Skip confirmation prompt
- 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
- top <bandwidth>
Description
The show sessions command displays active sessions passing through the 128T router (or the node specified by the optional node-name argument. 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.
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.
Example
Privileges Required
Available to admin and user.
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 |
show sessions top bandwidth
Usage
Keyword Arguments
- force Skip confirmation prompt
- router router for which to display top sessions by bandwidth
Positional Arguments
- 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 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 |
show stats cpu
Syntax
Description
The show stats cpu statistic shows the utilization value for each CPU core on the system that is being leveraged by the 128T networking software:
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
show stats database
Syntax
Description
The show stats database statistic displays details about the 128T router's on-board database activity. As of software version 3.1, this is limited to the amount of memory that the database has allocated:
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.1.0 | This feature was introduced |
show stats device-interface
Syntax
Description
The show stats device-interface statistics count the number of device-interface configuration (interface management) events, and tally both successes (shown under message-success) and failures (shown under message-failure).
As with most statistical output, omitting the message-failure/message-success parameter will show a table containing both items:
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
show stats disk
Syntax
Description
The show stats disk statistics displays information about the capacity of the fixed disk(s) associated with the nodes that comprise the 128T router, as well as the free space/used space on those disks.
Added in software version 3.1 is show stats disk component, which highlights the most common consumers of disk space by the 128T software (core dumps, system files, log files, and historical data).
Privileges Required
Available to admin and user. Updated in 3.0 to add node keyword and verbosity specifiers.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
| 3.0.0 | Added show stats disk component |
show stats dpi
Syntax
Description
Introduced with the application classification feature in software version 3.2, this command shows the statistics pertaining to the 128T's Deep Packet Inspection (DPI) function, which looks into the contents of X.509 certificates to find Common Name attributes, to associate with applications.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
show stats dynamic-peer-update
Syntax
Description
The 128T networking platform's dynamic peer update feature is what allows 128T devices that obtain IP addresses via a dynamic protocol (e.g., DHCP, LTE, PPPoE, etc.) to establish permanent peering relationships with other 128T devices. Introduced in our 3.2 software, the show stats dynamic-peer-update subcommand will enumerate the various stages and states of behavior associated with this new feature.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
show stats external-protocols
Syntax
Description
Each 128T router has a set of processes known as the External Protocol Manager (EPM) and External Protocol Agent (EPA) that communicate with each other to report on various types of environmental issues. The show stats external-protocols tables represent a breakdown of the different types of messaging that the EPM and EPA exchange. The table can be broken down further into the EPM statistics (with the optional argument manager, or the EPA statistics with the optional argument agent.
This command is usually only run at the request of 128 Technology's support organization to diagnose a specific problem.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
show stats external-protocols agent
Syntax
Description
This external-protocols subcommand displays statistical output for the messaging send and received by the External Protocols Agent (EPA) – to and from the EPM.
This command is usually only run at the request of 128 Technology's support organization to diagnose a specific problem.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats external-protocols manager
Syntax
Description
This external-protocols subcommand displays statistical output for the messaging send and received by the External Protocols Agent (EPM) – to and from the EPA.
This command is usually only run at the request of 128 Technology's support organization to diagnose a specific problem.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats highway
Syntax
Description
The "highway manager" (or "highwayManager") is a 128T router software process that governs the packet forwarding behavior of a Slice (including the packet-forwarding component of a Combo). The show stats highway command shows statistics regarding the operation of the highway manager.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
show stats highway action-event
Syntax
Description
Each flow within a 128T router's flow table may have various actions associated with it, to describe the operations that the 128T router may apply to packets that match the flow entry. Examples of actions are encryption, decryption, add metadata, perform DPI, etc.
The show stats highway action-event subcommands tabulate different actions associated with the 128T router's internal action processing; i.e., how many action events have been enqueued, dequeued, etc.
This command is generally only run at the specific request of the support team from 128 Technology, Inc.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.0.0 | This feature was introduced |
show stats highway actions
Syntax
Description
Each flow within a 128T router's flow table may have various actions associated with it, to describe the operations that the 128T router may apply to packets that match the flow entry. Examples of actions are encryption, decryption, add metadata, perform DPI, etc.
The show stats highway action action-meter returns the number of active "actions" that are allocated.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
show stats highway firewall-detector
Syntax
Description
Occasionally, 128T nodes are deployed with firewalls between them. The 128T router's built-in "firewall detector" uses a purpose-built testing algorithm and associated state machine to learn the type and nature of the firewall, so that it can accommodate it and send packets between the divided nodes successfully. The various show stats highway firewall-detector subcommands show the various states within this state machine.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats icmp
Syntax
Description
The show stats icmp shows information on the ICMP activity (sent and received) by the 128T router. The optional sent filter will show ICMP packets sent.
As with many other show stats commands, show stats icmp has options to change the verbosity of the output using the detail/debug/summary flags.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats interface
Syntax
Description
The show stats interface command displays interface-based statistics broken down into two main categories: receive statistics and transmit statistics (the received and sent subcommands, respectively). Each will be shown individually in the two sections that follow.
Executing the standalone command show stats interface displays a comprehensive set of all interface-based statistics available on the 128T router. Note that this command will execute a lot of queries, and may take as long as 60 seconds to return data to the PCLI.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 1.1.0 | Changed from "show stats interface-packets-received" and "show stats interface-packets-sent" to the "show stats interface" hierarchy. |
| 3.2.0 | Added missed to show stats interface received |
show stats interface received
Syntax
Description
The show stats interface received command displays information about the interfaces on a packet-forwarding element of the 128T router (i.e., a Slice or Combo).
The categorization of metrics is as follows: buffer-allocation-failure counts the number of times that the 128T router could not allocate a buffer to receive a packet that had arrived on the interface (this is generally due to a resource exhaustion on your 128T node and will be requested of you by 128 Technology's support department); bytes counts the number of bytes received on the interface; error counts the number of receive errors (malformed packets) on the interface; missed counts the number of packets that were dropped or discarded by the interface; packets counts the raw number of packets that have arrived; utilization measures the receive bandwidth per interface.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
show stats interface sent
Syntax
Description
The show stats interface sent command displays information about the interfaces on a packet-forwarding element of the 128T router (i.e., a Slice or Combo).
The categorization of metrics is as follows: bytes counts the number of bytes transmitted on the interface; error counts the number of send errors (malformed packets) on the interface; packets counts the raw number of packets that have been sent; utilization measures the transmit bandwidth per interface.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
show stats ipfix
Syntax
Description
The show stats ipfix command shows information about the 128T router's IPFIX (IP Flow Information eXport) record generation and export feature.
The output shows a number of IPFIX stats; the record-export-rate is the number of IPFIX records exported per second. The values for time-per-session and time-per-export, both expressed in microseconds, represent the average time spent by the 128T system to generate and export IPFIX records, respectively. The total-generation-time, also expressed in microseconds, represents the amount of time spent generating IPFIX records since the system was started. Lastly, the total-records is a counter of the number of IPFIX records generated in total.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.1.0 | This feature was introduced |
show stats memory
Syntax
Description
The show stats memory command shows information about the total memory (the capacity subcommand) and the used memory (the used subcommand) on each node within the 128T router.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced |
| 3.0.0 | Added verbosity argument |
show stats metrics
Syntax
Description
The show stats metrics commands display information about metrics (statistical data) collected by the 128T router for rendering to the user.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.0.0 | This feature was introduced |
| 3.2.0 | pending-aggregations renamed to collections-pending; collections-skipped added |
show stats packet-capture
Syntax
Description
The show stats packet-capture commands display information about any ongoing packet capture activity that an administrator has initiated. The success statistics show the number of packets that have been captured to date, the write-failure statistics show the number of packets that failed to be written to a file (likely due to disk space issues).
Both the success and write-failure modifiers show their information in the standard, tabular format:
As with most commands that display their information in this format, the show stats packet-capture command can be filtered by core, node and/or port with optional command-line arguments.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
show stats packet-processing
Syntax
Description
The show stats packet-processing is a top-level category that is the umbrella category for various statistics pertaining to the 128T router's packet processing. See the following sections for details on each of the subordinate commands.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced as a top-level category for many statistics that had been maintained elsewhere in earlier releases |
show stats packet-processing action
Syntax
Description
The show stats packet-processing-action command displays information for the various flow actions within the 128T router. Each flow, as it is instantiated by the 128T router, may have various "actions" associated with it based upon either the nature of the traffic, the configuration of the 128T router, or both.
The subcommands associated with packet-processing-action are grouped into success conditions and failure conditions, then broken down by action type, each one showing tabular data for the notable events associated with that flow action.
The various sections that follow illustrate all of the show stats packet-processing action subcommands.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.1.0 | This feature was introduced. Replaces the "show packet-processing-actions" command hierarchy in 1.0. |
| 2.0.0 | Formally "show packet-processing-action" |
show stats packet-processing action failure
Syntax
Description
The show stats packet-processing-action failure command enumerates all of the different failure cases for action processing within the 128T router. As mentioned earlier, actions are applied to packets received, and can perform a wide variety of functions: encryption, transformations, rate limiting, TCP state machine validation, etc. When these actions are applied to a packet and that action fails, the stats within this table are incremented.
| Action Category | Description |
|---|---|
| aes | These actions are related to the encryption and/or decryption of packets. |
| bfd | The BFD actions (Bidirectional Forwarding Detection) are associated with the inter-node and/or inter-router BFD exchanges that 128T routers use to determine health, aliveness, and utilization. |
| ethernet-header-transform | Ethernet headers are transformed (rewritten) as packets are sent to next hop gateways or hosts. (The source and destination MAC addresses.) |
| hmac | HMAC (Hash-based Message Authentication Code) is used to authenticate that the sender of a message is who it says that it is. 128T routers optionally use HMAC to authenticate one another – essentially "signing" packets to validate the authenticity of the source. |
| ip-header-transform | IP headers are transformed to change one protocol into another; notably, ICMP is transformed to UDP when sent via SVR to another 128T peer. |
| metadata | 128T routers use metadata to exchange state with one another. The insertion and removal of metadata are common actions at the outset of a new session. |
| rate-limit-check | Rate limiting (in bytes per second) is a flow-based action. |
| tcp-state | The 128T router will "follow" the TCP state machine for TCP-based flows (ensuring that the three-way handshake is completed within a set amount of time, for example). Checking the validity of the TCP state is a flow action. |
| ttl-validate | TTL (Time To Live) validation is used within IP networks as a last resort for loop prevention. |
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats packet-processing action success
Syntax
Description
Like the show stats packet-processing action failure command, the show stats packet-processing-action success command enumerates all of the different cases for action processing within the 128T router, but in this case ones that have completed successfully. When these actions are applied to a packet and that action succeeds, the stats within this table are incremented.
| Action Category | Description |
|---|---|
| aes | These actions are related to the encryption and/or decryption of packets. |
| bfd | The BFD actions (Bidirectional Forwarding Detection) are associated with the inter-node and/or inter-router BFD exchanges that 128T routers use to determine health, aliveness, and utilization. |
| detour | The detour action diverts packets from the "fast lane" (switching fabric) to the control path for further processing. |
| dpi | DPI, or Deep Packet Inspection, is used to peer into the payload of a packet for various patterns to perform more granular classification. |
| drop | As its name implies, this action causes a packet to be dropped. |
| ethernet-header-transform | Ethernet headers are transformed (rewritten) as packets are sent to next hop gateways or hosts. (The source and destination MAC addresses.) |
| forward | This action is used to indicate that a packet should be forwarded out of the 128T router and onto its next hop. |
| hmac | HMAC (Hash-based Message Authentication Code) is used to authenticate that the sender of a message is who it says that it is. 128T routers optionally use HMAC to authenticate one another – essentially "signing" packets to validate the authenticity of the source. |
| ip-header-transform | IP headers are transformed to change one protocol into another; notably, ICMP is transformed to UDP when sent via SVR to another 128T peer. |
| metadata | 128T routers use metadata to exchange state with one another. The insertion and removal of metadata are common actions at the outset of a new session. |
| rate-limit-check | Rate limiting (in bytes per second) is a flow-based action. |
| tcp-state | The 128T router will "follow" the TCP state machine for TCP-based flows (ensuring that the three-way handshake is completed within a set amount of time, for example). Checking the validity of the TCP state is a flow action. |
| ttl-validate | TTL (Time To Live) validation is used within IP networks as a last resort for loop prevention. |
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats packet-processing classifier
Syntax
Description
As packets are received by a 128T router, an initial classification is done to determine further treatment and processing. Most basic Layer 2 through Layer 4 types are classified and categorized, and reflected in the show stats packet-processing classifier received tables.
The show stats packet-processing classifier sent tables likewise return statistics regarding the number of packets of various L2-L4 types that the 128T router transmits.
The received and sent options are enumerated in the sections that follow.
Both the received and sent options are displayed in tabular format that breaks down the quantities by node and device port; the output for these tables may optionally be filtered to specific nodes and/or device ports by supplying them as arguments to the command line.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
show stats packet-processing classifier received
Syntax
Description
This command displays the current tally of the various types of packets that the 128T router has received. The table below enumerates that various statistics that are accumulated and a brief description for each.
| Classification | Description |
|---|---|
| arp | Incremented for each ARP packet received (both requests and replies). |
| broadcast-mac-discards | Incremented when packets are discarded due to the presence of a broadcast MAC address (FF:FF:FF:FF:FF:FF). |
| dhcp | Incremented with each received DHCP packet. |
| discards | Incremented when packets are discarded because the classifier did not recognize them as a known type. |
| exception | The number of software exceptions encountered when classifying packets. |
| icmp | The count of all received ICMP (IPv4) packets. |
| icmp-ttl-discards | The number of ICMP packets discarded due to its time to live reaching zero (0). |
| icmpv6 | The count of all received ICMPv6 packets. |
| icmpv6-hop-limit-discards | The number of ICMPv6 packets discarded due to their hop limit being reached. |
| icmpv6-link-local-discards | The number of link-local ICMPv6 packets discarded. |
| invalid-header-length | The number of received packets that had an invalid IP header length. |
| invalid-ipv6 | The number of invalid IPv6 packets received. |
| invalid-length | The number of received packets that had an invalid length (mismatch between received size and advertised size). |
| ipv4 | The total number of IPv4 packets that the 128T router has classified. |
| ipv4-fabric-fragmented | The number of IPv4 "fabric fragments" (packets that are fragmented between two 128T devices) received. |
| ipv4-fragmented | The total number of fragmented IPv4 packets that the 128T router has classified. (Including all fragments.) |
| ipv6 | The total number of IPv6 packets that the 128T router has classified. |
| ipv6-fabric-fragmented | The number of IPv6 "fabric fragments" (packets that are fragmented between two 128T devices) received. |
| ipv6-fragmented | The total number of fragmented IPv6 packets that the 128T router has classified. (Including all fragments.) |
| is-is | The total number of IS-IS (Intermediate System to Intermediate System) packets classified on receipt. |
| lacp | The total number of LACP (Link Aggregation Control Protocol) packets that have been classified on receipt. |
| ndp | The total number of NDP (Neighbor Discovery Protocol) packets that have been received and classified. |
| ospf | The total number of OSPF (Open Shortest Path First) routing packets that have been received and classified. |
| other-layer-4-protocol | This statistic counts the number of packets that have been received that do not fall into a known type (TCP, UDP, SCTP). |
| sctp | The total number of SCTP (Stream Control Transport Protocol) packets that have been received. |
| tcp | The total number of TCP (Transmission Control Protocol) packets that have been received. |
| total | The total number of packets that have been received, irrespective of type. |
| tunnel | The number of packets that have been received that were tunneled. |
| udp | The total number of UDP (User Datagram Protocol) packets that have been received. |
| unknown-layer-3-protocol-discards | The number of packets received that had a Layer 3 type that the classifier does not recognize. |
| vlan | The number of packets received that had a VLAN tag. |
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | was "show stats packet-classifier received" |
| 3.2.0 | added several more categories of classified packets |
show stats packet-processing classifier sent
Syntax
Description
This command displays the current tally of the various types of packets that the 128T router has transmitted. The table below enumerates that various statistics that are accumulated and a brief description for each.
| Classification | Description |
|---|---|
| arp | This statistic counts the number of ARP packets (requests and replies) that the 128T router has sent. |
| dhcp | This counts the number of DHCP packets that the 128T router has sent. |
| icmp | This statistic counts the number of IPv4 ICMP packets that the 128T router has sent. |
| icmpv6 | This statistic counts the number of IPv6 ICMP packets that the 128T router has sent. (Note: IPv6 is not currently available.) |
| ipv4 | This statistic counts the total number of IPv4 packets that the 128T router has sent. |
| ipv4-fabric-fragmented | The number of IPv4 "fabric fragments" (packets that are fragmented between two 128T devices) that have been sent. |
| ipv4-fragmented | This statistic counts the total number of fragmented IPv4 packets that the 128T router has sent. |
| ipv6 | This statistic counts the number of IPv6 packets that the 128T router has sent. (Note: IPv6 is not currently available.) |
| ipv6-fabric-fragmented | The number of IPv6 "fabric fragments" (packets that are fragmented between two 128T devices) that have been sent. |
| ipv6-fragmented | This statistic counts the number of fragmented IPv6 packets that the 128T router has sent. (Note: IPv6 is not currently available.) |
| is-is | This statistic counts the number of IS-IS packets that the 128T router has sent. (Note: IS-IS is not currently supported.) |
| lacp | This statistic counts the number of LACP packets that the 128T router has sent. (Note: LACP is not currently available.) |
| ndp | This statistic counts the number of NDP packets that the 128T router has sent. (Note: IPv6 is not currently available.) |
| ospf | This statistic counts the number of OSPF packets that the 128T router has sent. |
| other-layer-3-protocol | This statistic counts the number of packets that the 128T router has sent that do not fall into one of the other, counted network-layer categories. |
| other-layer-4-protocol | This statistic counts the number of packets that the 128T router has sent that do not fall into one of the other, counted transport-layer categories. (I.e., TCP, UDP, SCTP.) |
| sctp | This statistic counts the number of SCTP packets that the 128T router has sent. |
| tcp | This statistic counts the number of TCP packets that the 128T router has sent. |
| total | This shows the total number of packets that the 128T router has transmitted. |
| tunnel | This shows the number of packets that have been transmitted that are encapsulated in a tunnel. |
| udp | This statistic counts the number of UDP packets that the 128T router has sent. |
| vlan | This statistic reflects the number of packets that the 128T router has sent that include a VLAN tag. |
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | was "show stats packet-classifier sent" |
| 3.2.0 | added several more categories of classified packets |
show stats packet-processing enqueue
Syntax
Description
This command displays information about the various queues within the 128T router's traffic management and packet processing subsystems. At various points in a packet's lifecycle through the 128T router it is enqueued for processing; the subcommands associated with show stats packet-processing enqueue give tallies for the successful, and unsuccessful enqueue events.
Generally speaking, the various failure modes listed below are typically incremented when a queue is full – not draining as fast as packets are arriving. This is usually due to an unexpected flood of inbound packets.
The various subcommands are listed below:
| Subcommand | Description |
|---|---|
| to-controller-failure | This statistic counts the number of failure events when a control packet is unable to be enqueued when destined for the "fast lane controller". (Generally, the first packet of a new session.) |
| to-controller-success | This counts the number of successfully enqueued packets destined for the fast lane controller. |
| to-deferred-ring-failure | This statistic counts the number of failure events when a packet is unable to be enqueued when destined for the traffic engineering subsystem (e.g., for scheduling). |
| to-deferred-ring-success | This counts the number of successfully enqueued packets destined for the traffic engineering subsystem. |
| to-worker-core-failure | This statistic counts the number of failure events when a packet is unable to be enqueued back into the fast lane from the controller (generally, the first packet of a new session that has been processed by the controller). |
| to-worker-core-success | This counts the number of successfully enqueued packets destined for egress processing. |
A representative sample command is given here:
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced. Replaces (deprecates) show stats fast-lane-enqueue from pre-2.0 software releases. |
| 3.2.0 | Reorganized statistics and renamed several categories |
show stats packet-processing fib-action
Syntax
Description
FIB entries in the 128T router may have associated "actions", which affect the packet's processing logic upon entry into the router. (Note: FIB lookups happen logically later than flow table lookups; for statistics related to flow table action events, refer to the section on show stats packet-processing flow-action).
The show stats packet-processing fib-action table shows success, failure, and exception events (counters). More detail on success and failure events can be seen in the output from show stats packet-processing action. When the action processing has an exception, this means an internal error has occurred in attempting the action processing.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
| 2.1.0 | Renamed. Was show stats packet-processing fib-action-summary |
show stats packet-processing flow-action
Syntax
Description
Flow entries in the 128T router may have associated "actions", which affect the packet's processing logic upon entry into the router. Flow lookups happen very early in a packet's lifecycle within the 128T router, so it is quite common for these values to be large..
The show stats packet-processing flow-action table shows success, failure, and exception events (counters). More detail on success and failure events can be seen in the output from show stats packet-processing action. When the action processing has an exception, this means an internal error has occurred in attempting the action processing.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
| 2.1.0 | Renamed. Was show stats packet-processing flow-action-summary |
show stats packet-processing fragmentation
Syntax
Description
The show stats packet-processing fragmentation statistics capture information about all of the fragmented IP packets that the 128T router processes (both received fragments and transmitted fragments). The received and sent commands are detailed below.
A comprehensive list of all fragmentation-related statistics is available via the command show stats packet-processing fragmentation with no subcommand specified. Be advised, this command can take quite some time to complete due to the number of queries it generates.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. Was show stats fragmentation |
show stats packet-processing fragmentation received
Syntax
Description
Fragmented IP packets, as the name implies, are large packets split into smaller pieces prior to delivery. The fragments may arrive in any order, and must be reassembled by the recipient. If any of the fragments fail to arrive, the remaining fragments are of no value and are discarded. The show stats packet-processing fragmentation received statistics categorize different observed behaviors (one success case and several failure cases) with fragmented packets and increment statistics accordingly.
The duplicate-first-fragment and duplicate-last-fragment modifiers increment when the particular fragment arrives twice. The failure-to-reassemble increments when the 128T router cannot reassemble all of the fragments (usually due to missing fragments).
Fragments are reassembled in what are called "fragment chains". There are three statistics specific to the fragment chains: fragment-chains-discarded counts the number of times a fragment chain is discarded due to an error (not receiving all fragments, errored fragments, etc.); fragment-chains-exceeded is incremented when the 128T router does not have any available fragment chains to queue packets for reassembly; fragment-chain-timeout is when a fragment chain does not receive all fragments for a given reassembly job within ten (10) seconds.
The incomplete-fragments modifier shows the number of reassembly jobs that were missing fragments. The invalid-length-first-fragment modifier increments when a fragment arrives with a misadvertised length.
The successfully-reassembled modifier shows the number of fragment chains that have collected all fragments and completed reassembly with no errors.
All of the commands within show stats packet-processing fragmentation display their information similarly; one such example is below. The output may optionally be filtered by data node and/or port by adding the appropriate modifiers.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. Was show stats fragmentation received |
show stats packet-processing fragmentation sent
Syntax
Description
The complement to the receive statistics are the show stats fragmentation sent statistics, which account for all of the packets that the 128T router performs fragmentation on.
The fragmentation-creation-failure counts all instances where the 128T router cannot fragment a packet (internal error). The ipv4-dont-fragment-drop counts all packets dropped because they exceed the path MTU and have the "don't fragment" bit set (hence the 128T router cannot fragment it). The ipv4-packets-fragmented and ipv6-packets-fragmented counters are a running total of the number of packets (not fragments) that have been fragmented. The ipv4-fabric-fragments and ipv6-fabric-fragments counters are a running total of the number of fragmented packets sent over a "fabric" link (i.e., using Secure Vector Routing) between 128T routers. The unknown-l2-version counts the number of jumbo packets with an unknown (and therefore unhandled) L2 type.
All of the commands within show stats packet-processing fragmentation display their information similarly; one such example is below. The output may optionally be filtered by data node and/or port by adding the appropriate modifiers.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. Was show stats fragmentation sent |
| 3.2.0 | added ipv4-fabric-fragments, ipv6-fabric-fragments |
show stats packet-processing lookup
Syntax
Description
This command displays the current tally of various lookup table activity on the 128T router's data path. The various subcommands beneath show stats packet-processing lookup are enumerated in the sections that follow.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats packet-processing lookup access-policy-table
Syntax
Description
The access-policy-table statistics increment as sessions are established based on whether or not the access-policy criteria specified in the services are "hits" (matched) or "misses" (not matched). The "lock-failure" mode is an internal troubleshooting tool for 128 Technology's support team. By omitting the subcommand, a table with data regarding all subcommands (hit, lock-failure, and miss) is shown.
This show command presents the access-policy statistics in tabular format, based on ingress port (as defined in a configured device-interface).
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. was show stats access-policy-table |
show stats packet-processing lookup fib-table
Syntax
Description
Each packet-forwarding component of the 128T router maintains a Forwarding Information Base (FIB) that includes rules for packet processing. When packets arrive that do not match an established flow, the system performs a FIB query to determine their disposition. This table records those events; the hit table is when a match is found, the miss table contains a tally of the times when no match was found.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. was show stats fib-table |
show stats packet-processing lookup flow-table
Syntax
Description
One of the first operations performed by a 128T router for each inbound packet is to check its flow table to see if it belongs to an existing flow. The flow-table statistics show the results of this check, be they successful (flow-table hit) or unsuccessful (flow-table miss).
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. was show stats flow-table |
show stats packet-processing lookup icmp-table
Syntax
Description
The 128T router's "ICMP blackhole" feature lets administrator selectively decide when to respond to external ICMP packets. The show stats icmp-table statistics show the activity related to this ICMP blackholing – i.e., when a network-interface's icmp is set to drop.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats packet-processing lookup tenant-table
Syntax
Description
The 128T router's tenant lookup table is used to ascribe inbound packets to configured tenants. The resultant of the lookup is used in a subsequent lookup, the tenant-specific FIB lookup, to decide on the disposition for that packet.
Entries into the tenant table are populated by configuration on the 128T router. Each interface contributes to the source lookup table, with its assigned tenant (or the "global tenant" in the absence of an assigned tenant). Each service-route will create an entry in the tenant table, assigned to the tenant of the service that agent belongs to. Also, each waypoint (for internode "router" traffic) creates an entry into the table.
The hit modifier shows the normal (success) case, when a tenant is found in the lookup. The miss modifier shows the failure case, when no tenant can be found; in this case, the packet will be tallied and dropped. The lock-failure modifier increments when a lookup fails because the fast lane cannot obtain exclusive access to the source lookup table.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. was show stats source-lookup-table |
show stats packet-processing received
Syntax
Description
This command displays the current types of events that can transpire upon receipt of packets. The various subcommands are listed in the sections that follow.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats packet-processing received control-block-alloc-failure
Syntax
Description
This statistic shows the number of times that the 128T router was unable to allocate a packet control block, a data structure used for each connection. This type of resource exhaustion is an abnormal event; this command is usually only run at the request of 128 Technology's support organization to diagnose a specific problem. As with other show stats commands, this one may be filtered by node and/or port to refine the output.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. Was show stats control-block-pool-exhausted |
show stats packet-processing received control-success
Syntax
Description
Control packets are used within the 128T router to communicate between various software processes. The show stats packet-processing received control-success statistics are incremented when control packets are sent between the fast lane and the Highway Manager process. This occurs when events such as adding an interface occurs, or when AES encryption is enabled or disabled. This command is generally only run at the direct request of 128 Technology's support team, when troubleshooting a reported issue.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. Was show stats control-packets-received |
show stats packet-processing received injected-success
Syntax
Description
This statistic shows the number of packets that have been received in the "fast lane" (where fast packet processing occurs) that are destined for an egress interface.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 1.0.0 | This feature was introduced |
| 2.0.0 | Renamed. Was show stats control-block-pool-exhausted |
| 3.2.0 | Renamed. Was show stats packet-processing received egress-success |
show stats packet-processing received interface-standby-drop
Syntax
Description
This statistic shows the number of times that a packet was received by an interface that is in "standby" – i.e., it is not the active interface in a redundancy group. When a 128T router receives a packet on an interface that is in standby, it drops it and increments these counters.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats packet-processing received interface-success
Syntax
Description
This statistic shows the number packets successfully received from an interface.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats packet-processing sent
Syntax
Description
This command displays the current tally of the various types of packets that the 128T router has transmitted (or failed to transmit, as the case may be). The table below enumerates that various statistics that are accumulated and a brief description for each.
| Subcommand | Description |
|---|---|
| interface-failure | Incremented for each packet that fails to be transmitted via an egress interface for an unspecified reason. |
| interface-retry | Incremented each time a packet transmission is retried. |
| interface-standby-drop | Incremented for each packet that is dropped because the interface it would use is the standby interface within a redundant pair of interfaces. |
| interface-success | Incremented for each packet that successfully egresses the router. |
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
| 3.2.0 | Added interface-retry statistics |
show stats process
Syntax
Description
The show stats process command shows memory and CPU consumption for various processes on the routers and nodes in your deployment. You can specify which process (via its ID, or PID) if this is known, or by a process's name (if known).
These are used for memory or CPU consumption issues and are unusual events that will generally be requested by 128 Technology's support organization for triage purposes.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.2.0 | This feature was introduced |
show stats redis-server-manager
Syntax
Description
The show stats redis-server-manager displays information around the database used by the 128T routing software to hold state information for its high availability processing. The redis-server-inactives metric is the number of events where a node could not connect to the database; the redis-server-network-flaps counts the number of network events that caused connectivity problems to the database, and the redis-session-expiration counts the number of connections that were torn down due to detection of a stale connection.
These are used for troubleshooting high availability failures and/or session loss and are unusual events that will generally be requested by 128 Technology's support organization for triage purposes.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 3.0.0 | This feature was introduced |
show stats redundancy
Syntax
Description
The show stats redundancy commands show statistics related to the 128T router's behavior when configured in a redundant (highly available) pair of nodes. These commands can be helpful in diagnosing the behavior of a system when an active node has relinquished control to its mated pair, and to check on the resiliency of the active sessions that have been established.
The subcommands within show stats redundancy provide more detail on each of the various counters and are discussed in the sections that follow.
These commands are typically only run at the request of 128 Technology's support team, and to diagnose specific network conditions. This information, when combined with 128T log output, will help the support team to isolate network anomalies.
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats redundancy database-connection
Syntax
Description
The show stats redundancy database-connection set of commands list the statistics related to the 128T router's internal database used to track and replicate data between two nodes in a mated pair of Controls/Combos.
These commands are typically only run at the request of 128 Technology's support team, and to diagnose specific network conditions. This information, when combined with 128T log output, will help the support team to isolate network anomalies.
The various subcommands within show stats redundancy database-connection are described in the table that follows:
| Subcommand | Description |
|---|---|
| active-connections | This tracks the number of active connections to the redundancy database. |
| client-disconnect | This indicates the number of instances of a client successfully disconnecting from the redundancy database. |
| connect | This tracks the number of instances when a client connects to the database. |
| error-disconnect | This tracks the number of instances when a client has been disconnected from the redundancy database due to an internal error. |
| errors | This tracks the total number of errors (during client connection and disconnection) by the database. |
| failed-connect | This counts the number of failed connection attempts by a client to the redundancy database. |
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats redundancy port-initialization
Syntax
Description
The show stats redundancy port-initialization tables show statistics related to allocation of "port blocks" from the redundancy database. Various functions on the 128T router require allocation of specific IP:port tuples (e.g., source NAT and waypoint flows) choose ports to uniquely identify sessions as they traverse the node(s). These ports must be preserved during failover, and a newly active system must not inadvertently choose a port selected by a system that had relinquished the active role (i.e., cause what is called a "collision"). The behaviors of the mechanism for ensuring port continuity and uniqueness is reflected in this table.
These commands are typically only run at the request of 128 Technology's support team, and to diagnose specific network conditions. This information, when combined with 128T log output, will help the support team to isolate network anomalies.
| Subcommand | Description |
|---|---|
| marker-query-pending | At boot or after one of its interfaces has become active, a 128T router will issue a "marker query" to the redundancy database for each interface. This meter reflects the number of outstanding queries that have not yet received a reply. This value should typically be zero (0). |
| marker-record-found | This increments when a request for a marker record results in a match. (Generally at failover or restart.) |
| marker-record-not-found | This increments when a request for a marker record finds no match. (Generally at cold boot.) |
| marker-record-read-error | This value increments when a system cannot read the marker record from the database. This is |
| marker-record-write | This indicates the number of marker records tht a 128T router sets in the redundancy database after querying for an existing marker record and not finding one. This typically happens only during initial boot or when a system needs to grow the port range it has in use. |
| pending-queries | This meter will increment during boot, and is generally caused by the timing of the various 128T routing processes starting up (i.e., the database queries are attempted before the database is finished initialization or the communication to it is not yet available). During normal operation this should be zero (0). |
Privileges Required
Available to admin and user.
Version History
| Release | Modification |
|---|---|
| 2.0.0 | This feature was introduced |
show stats redundancy port-list-records
Syntax
Description
The show stats redundancy port-list tables show statistics related to allocation of "blocks" of ports for 128T applications that require unique ports per use – things such as source NAT and waypoint-to-waypoint communication.
The 128T router will request a block of free ports using a "pop" operation from the redundancy database, use those until they're (mostly) consumed, until it requests another. Meanwhile as it frees ports from previous allocations as sessions are torn down or expire, it aggregates a block of these ports and will "push" it back onto the database for later use. (This manifests as a least recently used, or LRU, algorithm, where ports that are freed wind up at the back of the line for subsequent reuse.)
These commands are typically only run at the request of 128 Technology's support team, and to diagnose specific network conditions. This information, when combined with 128T log output, will help the support team to isolate network anomalies.
| Subcommand | Description |
|---|---|
| list-record-pop-errors | This indicates the number of errors that occurred when attempting to retrieve a block of free ports from the redundancy database because the database was unreachable. |
| list-record-pop-failures | This indicates the number of failures when attempting to retrieve a block of free ports from the redundancy database because no free blocks were available. |
| list-record-pop-pending | This indicates the number pending requests that have neither succeeded nor failed, but are still being processed. |
| list-record-pop-success | This counts the number of blocks of free ports that have been successfully requested from the database. |
| list-record-push | This indicates the number of free ports returned to circulation. |