diff --git a/docs/_install_interactiveoverview.md b/docs/_install_interactiveoverview.md index ebe6420b142..f15e9e86467 100644 --- a/docs/_install_interactiveoverview.md +++ b/docs/_install_interactiveoverview.md @@ -8,4 +8,4 @@ The steps in this section describe the *interactive conductor installation* from The Conductor installation must be completed before installing a Session Smart Router or routers using the ISO. The same ISO is used for both installations. ::: -To install a router **after** installing and configuring the Conductor, use the [SSR Installation](intro_installation_bootable_media.mdx). The [Router Installation Using OTP](intro_otp_iso_install.mdx) procedure can be used for whitebox and air-gap, conductor-managed network installations. \ No newline at end of file +To install a router **after** installing and configuring the Conductor, use the [SSR Installation](intro_installation_bootable_media.mdx). The [Router Installation Using OTP](intro_otp_iso_install.md) procedure can be used for whitebox and air-gap, conductor-managed network installations. \ No newline at end of file diff --git a/docs/about_releases.md b/docs/about_releases.md index acfac4b218c..3cb84d4a7d8 100644 --- a/docs/about_releases.md +++ b/docs/about_releases.md @@ -54,6 +54,7 @@ However, issues resolved in `4.3.12`, which was released on 3/12/2021 are not ad | Version | Initial GA Version | First Release Shipping Date | Latest GA Version | Support Lifetime | End of Engineering support | End of Support | | -- | -- | -- | -- | -- | -- | -- | +| Release 7.2 | [7.2.0](release_notes_128t_7.2.md#release-720-24r1) | June 30, 2026 | [7.2.0](release_notes_128t_7.2.md#release-720-24r1) | LTS | December 30, 2028 | June 30, 2029 | | Release 7.1 | [7.1.0](release_notes_128t_7.1.md#release-710-50r1) | December 4, 2025 | [7.1.5](release_notes_128t_7.1.md#release-715-7r2) | STS | March 10, 2027 | September 10, 2027 | | Release 7.0 | [7.0.1](release_notes_128t_7.0.md#release-701-1r1) | October 14, 2025 | [7.0.1](release_notes_128t_7.0.md#release-701-1r1) | LTS | August 24, 2028 | February 24, 2029 | | Release 6.3 | [6.3.0](release_notes_128t_6.3.md#release-630-107r1) | September 30, 2024 | [6.3.7-6-sts](release_notes_128t_6.3.md#release-637-6-sts) | STS | May 6, 2026 | November 6, 2026 | diff --git a/docs/bcp_att_avpn_configuration.md b/docs/bcp_att_avpn_configuration.md index 11a874c4f9a..b00d53dc603 100644 --- a/docs/bcp_att_avpn_configuration.md +++ b/docs/bcp_att_avpn_configuration.md @@ -3,8 +3,6 @@ title: AT&T AVPN Configuration sidebar_label: AT&T AVPN Configuration --- -import Mermaid from '@theme/Mermaid'; - This guide is for network engineers and architects using their Session Smart Router to connect to AT&T’s MPLS VPN (AVPN) service. It will cover: - Service class definitions for the various COS queues on the AT&T MPLS network - Strategies for mapping `service` configuration to the COS queues using `service-policy` elements @@ -229,37 +227,37 @@ The base class `service-policy` configurations presented here are derived from t The SSR uses four traffic engineering queues for prioritizing egress traffic during times of congestion or link contention. The general practice of mapping the `traffic-class` assignments (high, medium, low, best-effort) into the various 6COS queues is shown below. - ATT-COS1 - id1(BFD, BGP) -.-> ATT-control - voip-video --> ATT-COS2V - video-streaming --> ATT-COS2V - voip-signaling --> ATT-COS2 - data-mission-critical --> ATT-COS2 - remote-desktop --> ATT-COS2 - management-interactive --> ATT-COS3 - management-m2m --> ATT-COS3 - data-interactive --> ATT-COS3 - data-best-effort --> ATT-COS4 - data-scavenger --> ATT-COS5 - video-streaming-scavenger --> ATT-COS5 - subgraph best-effort +```mermaid +graph LR + voip-audio --> ATT-COS1 + id1(BFD, BGP) -.-> ATT-control + voip-video --> ATT-COS2V + video-streaming --> ATT-COS2V + voip-signaling --> ATT-COS2 + data-mission-critical --> ATT-COS2 + remote-desktop --> ATT-COS2 + management-interactive --> ATT-COS3 + management-m2m --> ATT-COS3 + data-interactive --> ATT-COS3 + data-best-effort --> ATT-COS4 + data-scavenger --> ATT-COS5 + video-streaming-scavenger --> ATT-COS5 + subgraph best-effort ATT-COS5 - end - subgraph low + end + subgraph low ATT-COS4 - end - subgraph medium + end + subgraph medium ATT-COS2V ATT-COS2 ATT-COS3 - end - subgraph high + end + subgraph high ATT-COS1 ATT-control - end -`}/> + end +``` Each AT&T AVPN circuit has a *profile* associated with it (referred to as a "COS Package"), that maps to bandwidth allocations for the various COS queues. These in turn need to be mapped to the four egress traffic engineering queues on the SSR. The COS Package from AT&T is expressed as a set of six numbers (corresponding to the queues), where the first number is the percentage of the circuit bandwidth allocated for COS1, and the remaining five numbers (which sum to 100%) represent the amount of *bandwidth remaining* from the bandwidth not used by COS1. diff --git a/docs/bcp_sdwan_design_guide.md b/docs/bcp_sdwan_design_guide.md index 90e7d46ad53..69ac0610294 100644 --- a/docs/bcp_sdwan_design_guide.md +++ b/docs/bcp_sdwan_design_guide.md @@ -89,7 +89,7 @@ There are many considerations with a pod design. In the drawing above, the hando ### Tenancy Design -*Main article: [Tenancy Design](bcp_tenants.mdx)* +*Main article: [Tenancy Design](bcp_tenants.md)* From the discussion with the end customer on segmentation, the definition of tenants should be relatively straight forward. The goal is to create a list of global profiles that can be used for access policies to services. Conceptually, tenancy should not be tied to a location and should be a global construct available whenever we want to classify traffic to a profile when it enters the SSR fabric across the authority (though at times due to business logic defined by the customer, a tenant may reflect a location). At any point in the authority, when traffic ingresses into an SSR, tenancy is applied. Typically this is done by assigning the tenant to the network-interface according to the purpose of the VLAN for which the SSR is the router. For example "POS" for point of sale, "voice" for telephony devices, and "core" for traffic coming from the customer's core network (if no further breakdown of tenancy is required for this traffic). The SSR can also restrict ingress traffic into a tenant further by creating a neighborhood on the network interface. Neighborhoods serve multiple purposes and an additional discussion of neighborhoods will occur in an ensuing section. In the global tenant configuration, this neighborhood may be referenced as a "member" and then CIDR block ranges for source addresses can be defined within this member. In this manner, a shared neighborhood name can be configured on a common LAN network for a site category and the tenant configuration can be updated with the specific list of CIDR ranges that will be used to identify which source IP addresses belong to a particular tenant for traffic coming in on this interface. diff --git a/docs/bcp_tenants.mdx b/docs/bcp_tenants.md similarity index 97% rename from docs/bcp_tenants.mdx rename to docs/bcp_tenants.md index 7658d15201a..a3a0ea39c62 100644 --- a/docs/bcp_tenants.mdx +++ b/docs/bcp_tenants.md @@ -3,8 +3,6 @@ title: Tenancy Design sidebar_label: Tenancy Design --- -import Flowchart from '../src/components/Flowchart'; - The *tenant* is one of the foundational data model elements within the Session Smart Router (SSR), and represents a consumer of network *services*. Tenancy is the logical partitioning of a network’s resources, done in the interest of restricting access to network services to only the users and groups for which they’re intended. This document provides an overview of tenancy in the SSR, how it is configured, and provides guidance for modeling the segmentation of a network using the SSR's data modeling language. @@ -41,26 +39,20 @@ As new sessions arrive at an SSR, the router will attempt to classify the source Should none of these result in a definitive determination on the tenant of the source of this session request, the session is associated with the *global tenant* (see the section on "Special Tenants" for more information on the global tenant). Once the tenant has been identified – either as a specific tenant, or as the global tenant – this acts as a filter into the SSR’s FIB. Only the routes associated with that tenant are available to that user group. While this somewhat resembles the way a legacy router uses VRFs to create separate RIBs and FIBs, the segment by *tenant* is pervasive among all routers within an Authority by design, and is applied ubiquitously among all varieties of networks: public IP space, private, cloud, IPv4, IPv6, etc. -start: Packet Arrives - metadata=>condition: Packet has metadata? - int=>condition: Interface has a tenant? - nh=>condition: Neighborhood-based tenant? - tm=>operation: Tenant taken from metadata - ti=>operation: Tenant taken from interface - th=>operation: Tenant taken from neighborhood - global=>operation: Tenant assigned as "global" - e=>end: Proceed to FIB lookup - st->metadata - metadata(no)->int - metadata(yes,right)->tm->e - int(yes,right)->ti->e - int(no)->nh - nh(yes,right)->th->e - nh(no)->global->e - `} -/> +```mermaid +flowchart TD + st([Packet Arrives]) --> metadata{Packet has metadata?} + metadata -->|no| int{Interface has a tenant?} + metadata -->|yes| tm[Tenant taken from metadata] + tm --> e([Proceed to FIB lookup]) + int -->|yes| ti[Tenant taken from interface] + ti --> e + int -->|no| nh{Neighborhood-based tenant?} + nh -->|yes| th[Tenant taken from neighborhood] + th --> e + nh -->|no| gl["Tenant assigned as "global""] + gl --> e +``` #### Viewing a Router's Tenancy diff --git a/docs/cc_fips_downloading_iso.md b/docs/cc_fips_downloading_iso.md index bef726db732..a6ada033e3e 100644 --- a/docs/cc_fips_downloading_iso.md +++ b/docs/cc_fips_downloading_iso.md @@ -11,7 +11,7 @@ Juniper Session Smart Networking provides the following workflows for the compli - **Package-based ISO:** This ISO offers multiple local installation methods. - **One Touch Provisioning (OTP)** is the default and preferred method of Router installation. OTP sets up DHCP on all interfaces and boots a Web Server GUI. After installing the Conductor and configuring routers through the Conductor, the OTP quickstart process will install and configure the router. See the following procedures for OTP installation steps: - - [Router Installation Using OTP](intro_otp_iso_install.mdx) + - [Router Installation Using OTP](intro_otp_iso_install.md) - [Quickstart from the OTP ISO](intro_install_quickstart_otpiso.md) - **Interactive:** For Conductor installations and bespoke deployments where customized platform configuration is necessary, an interactive mode exists. Installation is done using the serial console. An interactive session is started to configure network interfaces, passwords, node name and type, and conductor IP (if applicable) before the SSR software is started. diff --git a/docs/cert_validation_requirements.md b/docs/cert_validation_requirements.md index 7316f596660..e027c1e4aeb 100644 --- a/docs/cert_validation_requirements.md +++ b/docs/cert_validation_requirements.md @@ -8,6 +8,7 @@ sidebar_label: Certificate Requirements and Validation | Release | Modification | | ------- | --------------------------- | | 7.0.0 | Certificate management and validation support added. | +| 7.2.0 | Subject Alternative Name URI support for peering identity. | This page describes the certificate properties that the SSR enforces, how `validation-mode` affects behavior, and the differences between config-time and runtime validation. @@ -112,6 +113,7 @@ Client certificates used for peering are validated as leaf (end-entity) certific | --- | --- | | Signature Algorithm | Must be an [accepted algorithm](#accepted-cryptographic-algorithms). | | Public Key | Must be an [accepted key type and size](#key-requirements). | +| Subject Alternative Name (optional) | Starting in SSR 7.2.0, a `urn:ssr:peering:` SAN URI can be used to carry SVR peering identity as an alternative to the Common Name. See [Enhanced Security Key Management — API Naming Rules](sec_enhanced_key_mgmt.md#api-naming-rules) for details. | ### Intermediate CA Certificates diff --git a/docs/cli_reference.md b/docs/cli_reference.md index 04446f4a8e2..3dae6206b72 100755 --- a/docs/cli_reference.md +++ b/docs/cli_reference.md @@ -2261,6 +2261,10 @@ migrate [skip-validation] [force] conductor
[
] router node | [`show idp network`](#show-idp-network) | Show IDP networks. | | [`show idp platform`](#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | | [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP. | #### Description @@ -2588,6 +2593,7 @@ Query and display the IDP signature database connectivity details. | [`show idp network`](#show-idp-network) | Show IDP networks | | [`show idp platform`](#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | | [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP | #### Description @@ -2601,7 +2607,7 @@ Downgrade to a new version of the SSR. #### Usage ``` -request system software downgrade [{router | resource-group }] [simultaneous] [skip-package-transfer] [skip-pre-health-check] [skip-post-health-check] [cohort-id ] [force] [node ] version +request system software downgrade [{router | resource-group }] [simultaneous] [skip-package-transfer] [skip-pre-health-check] [skip-post-health-check] [no-revert] [cohort-id ] [force] [node ] version ``` ##### Keyword Arguments @@ -2610,6 +2616,7 @@ request system software downgrade [{router | resource-group | resource-group }] [simultaneous] [skip-package-transfer] [skip-pre-health-check] [skip-post-health-check] [cohort-id ] [force] [node ] version +request system software upgrade [{router | resource-group }] [simultaneous] [skip-package-transfer] [skip-pre-health-check] [skip-post-health-check] [no-revert] [cohort-id ] [force] [node ] version ``` ##### Keyword Arguments @@ -2833,6 +2840,7 @@ request system software upgrade [{router | resource-group ] [since ] [router ] [node ] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt | +| node | The node to disable | +| router | The router to disable (default: <current router>) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable-now`](#send-command-disable-now) | Disable an SSR node and stop it | +| [`send command enable`](#send-command-enable) | Enable an SSR node such that it starts on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable an SSR node and start it | +| [`send command reboot`](#send-command-reboot) | Reboot an SSR node | +| [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | +| [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | +| [`send command restart`](#send-command-restart) | Restart an SSR node | +| [`send command start`](#send-command-start) | Start an SSR node | +| [`send command stop`](#send-command-stop) | Stop an SSR node | +| [`send command sync`](#send-command-sync) | Transition an asset back to 'synchronizing' and perform a sync. | +| [`send command system-check post-operation`](#send-command-system-check-post-operation) | Post-operation an SSR node | +| [`send command system-check pre-operation`](#send-command-system-check-pre-operation) | Pre-operation an SSR node | +| [`show assets`](#show-assets) | Shows the automated provisioning status of SSR nodes. | +| [`show assets summary`](#show-assets-summary) | A summary of assets connected to the Conductor. | + +## `send command disable-now` + +Disable an SSR node and stop it + +#### Usage + +``` +send command disable-now [no-block] [force] [router ] [node ] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt | +| no-block | Send the command as non blocking so it's completed asynchronously | +| node | The node to disable-now | +| router | The router to disable-now (default: <current router>) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node such that it does not start on boot | +| [`send command enable`](#send-command-enable) | Enable an SSR node such that it starts on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable an SSR node and start it | +| [`send command reboot`](#send-command-reboot) | Reboot an SSR node | +| [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | +| [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | +| [`send command restart`](#send-command-restart) | Restart an SSR node | +| [`send command start`](#send-command-start) | Start an SSR node | +| [`send command stop`](#send-command-stop) | Stop an SSR node | +| [`send command sync`](#send-command-sync) | Transition an asset back to 'synchronizing' and perform a sync. | +| [`send command system-check post-operation`](#send-command-system-check-post-operation) | Post-operation an SSR node | +| [`send command system-check pre-operation`](#send-command-system-check-pre-operation) | Pre-operation an SSR node | +| [`show assets`](#show-assets) | Shows the automated provisioning status of SSR nodes. | +| [`show assets summary`](#show-assets-summary) | A summary of assets connected to the Conductor. | + ## `send command download` This download command is now obsolete. @@ -3601,6 +3686,83 @@ request system software ... set system software ... delete system software ... +## `send command enable` + +Enable an SSR node such that it starts on boot + +#### Usage + +``` +send command enable [force] [router ] [node ] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt | +| node | The node to enable | +| router | The router to enable (default: <current router>) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node such that it does not start on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable an SSR node and stop it | +| [`send command enable-now`](#send-command-enable-now) | Enable an SSR node and start it | +| [`send command reboot`](#send-command-reboot) | Reboot an SSR node | +| [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | +| [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | +| [`send command restart`](#send-command-restart) | Restart an SSR node | +| [`send command start`](#send-command-start) | Start an SSR node | +| [`send command stop`](#send-command-stop) | Stop an SSR node | +| [`send command sync`](#send-command-sync) | Transition an asset back to 'synchronizing' and perform a sync. | +| [`send command system-check post-operation`](#send-command-system-check-post-operation) | Post-operation an SSR node | +| [`send command system-check pre-operation`](#send-command-system-check-pre-operation) | Pre-operation an SSR node | +| [`show assets`](#show-assets) | Shows the automated provisioning status of SSR nodes. | +| [`show assets summary`](#show-assets-summary) | A summary of assets connected to the Conductor. | + +## `send command enable-now` + +Enable an SSR node and start it + +#### Usage + +``` +send command enable-now [no-block] [force] [router ] [node ] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt | +| no-block | Send the command as non blocking so it's completed asynchronously | +| node | The node to enable-now | +| router | The router to enable-now (default: <current router>) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node such that it does not start on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable an SSR node and stop it | +| [`send command enable`](#send-command-enable) | Enable an SSR node such that it starts on boot | +| [`send command reboot`](#send-command-reboot) | Reboot an SSR node | +| [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | +| [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | +| [`send command restart`](#send-command-restart) | Restart an SSR node | +| [`send command start`](#send-command-start) | Start an SSR node | +| [`send command stop`](#send-command-stop) | Stop an SSR node | +| [`send command sync`](#send-command-sync) | Transition an asset back to 'synchronizing' and perform a sync. | +| [`send command system-check post-operation`](#send-command-system-check-post-operation) | Post-operation an SSR node | +| [`send command system-check pre-operation`](#send-command-system-check-pre-operation) | Pre-operation an SSR node | +| [`show assets`](#show-assets) | Shows the automated provisioning status of SSR nodes. | +| [`show assets summary`](#show-assets-summary) | A summary of assets connected to the Conductor. | + ## `send command reboot` Reboot an SSR node @@ -3624,6 +3786,10 @@ send command reboot [force] router node | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | | [`send command restart`](#send-command-restart) | Restart an SSR node | @@ -3669,6 +3835,10 @@ send command reconnect [router ] [node ] | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | | [`send command restart`](#send-command-restart) | Restart an SSR node | @@ -3701,6 +3871,10 @@ send command reconnect disconnected [force] | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command restart`](#send-command-restart) | Restart an SSR node | @@ -3725,7 +3899,7 @@ Restart an SSR node #### Usage ``` -send command restart [force] router node +send command restart [no-block] [force] [router ] [node ] ``` ##### Keyword Arguments @@ -3733,14 +3907,19 @@ send command restart [force] router node | name | description | | ---- | ----------- | | force | Skip confirmation prompt | +| no-block | Send the command as non blocking so it's completed asynchronously | | node | The node to restart | -| router | The router to restart | +| router | The router to restart (default: <current router>) | ##### See Also | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | @@ -3793,7 +3972,7 @@ Start an SSR node #### Usage ``` -send command start [force] router node +send command start [no-block] [force] [router ] [node ] ``` ##### Keyword Arguments @@ -3801,14 +3980,19 @@ send command start [force] router node | name | description | | ---- | ----------- | | force | Skip confirmation prompt | +| no-block | Send the command as non blocking so it's completed asynchronously | | node | The node to start | -| router | The router to start | +| router | The router to start (default: <current router>) | ##### See Also | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | @@ -3833,7 +4017,7 @@ Stop an SSR node #### Usage ``` -send command stop [force] router node +send command stop [no-block] [force] [router ] [node ] ``` ##### Keyword Arguments @@ -3841,14 +4025,19 @@ send command stop [force] router node | name | description | | ---- | ----------- | | force | Skip confirmation prompt | +| no-block | Send the command as non blocking so it's completed asynchronously | | node | The node to stop | -| router | The router to stop | +| router | The router to stop (default: <current router>) | ##### See Also | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | @@ -3890,6 +4079,10 @@ send command sync [{router | resource-group }] [force] | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | @@ -3932,6 +4125,10 @@ send command system-check post-operation [cohort-id ] [force] router | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | @@ -3972,6 +4169,10 @@ send command system-check pre-operation [cohort-id ] [force] router < | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | @@ -4763,6 +4964,29 @@ show app-id cache [rows ] [force] [node ] {router | resourc | [`lookup application by-domain`](#lookup-application-by-domain) | Look up application identification by domain name or url key | | [`show stats app-id application-director cache`](cli_stats_reference.md#show-stats-app-id-application-director-cache) | Statistics for 'cache' | +## `show app-id cache-sizes` + +Show app-id cache configured and current sizes + +#### Usage + +``` +show app-id cache-sizes router node +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| node | The node on which to show app-id cache sizes | +| router | The router on which to show app-id cache sizes | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show app-id web-filtering`](#show-app-id-web-filtering) | Show web-filtering state | + ## `show app-id categories` Show available top-level categories @@ -5087,6 +5311,10 @@ show assets [{router | resource-group }] [force] [node | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | @@ -5299,6 +5527,10 @@ show assets summary [{router | resource-group }] [force | command | description | | ------- | ----------- | | [`migrate`](#migrate) | Migrate an SSR to a new conductor | +| [`send command disable`](#send-command-disable) | Disable an SSR node and prevent it from starting on boot | +| [`send command disable-now`](#send-command-disable-now) | Disable and stop an SSR node | +| [`send command enable`](#send-command-enable) | Enable and start an SSR node on boot | +| [`send command enable-now`](#send-command-enable-now) | Enable and start an SSR node | | [`send command reboot`](#send-command-reboot) | Reboot an SSR node | | [`send command reconnect`](#send-command-reconnect) | Attempt to reconnect an asset | | [`send command reconnect disconnected`](#send-command-reconnect-disconnected) | Attempt to reconnect all disconnected assets. | @@ -5594,12 +5826,12 @@ show bgp neighbors [rows ] [vrf ] [force] {router | resource | name | description | | ---- | ----------- | | neighbor-ip | The IP address of the neighbor [type: IP address] | -| option | advertised-routes \| received-routes | +| option | advertised-routes \| received-routes \| filtered-routes | | family | ipv4 \| ipv6 \| ipv4-vpn \| ipv6-vpn \| all | #### Description -The _show bgp neighbors_ command displays detailed information about each of the SSR'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_. +The _show bgp neighbors_ command displays detailed information about each of the SSR'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-routes_, received from that peer by appending _received-routes_, or filtered from that peer by appending _filtered-routes_. #### Example @@ -5908,6 +6140,7 @@ show chassis [router ] [node ] | ------- | ----------- | | [`firmware`](#show-chassis-firmware) | Show information about the chassis firmware | | [`hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`health`](#show-chassis-health) | Show chassis health | | [`led`](#show-chassis-led) | Show the status of the chassis LEDs | | [`power`](#show-chassis-power) | Show chassis power | | [`temperature`](#show-chassis-temperature) | Show chassis temperature sensor readings | @@ -5919,6 +6152,8 @@ show chassis [router ] [node ] | ------- | ----------- | | [`show chassis firmware`](#show-chassis-firmware) | Show information about the chassis firmware | | [`show chassis hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`show chassis health`](#show-chassis-health) | Show chassis health | +| [`show chassis health details`](#show-chassis-health-details) | Show the details of the System Health | | [`show chassis led`](#show-chassis-led) | Show the status of the chassis LEDs | | [`show chassis led phy`](#show-chassis-led-phy) | Show the status of the port LEDs | | [`show chassis led system`](#show-chassis-led-system) | Show the status of the System LED | @@ -5955,6 +6190,8 @@ show chassis firmware [router ] [node ] | ------- | ----------- | | [`show chassis`](#show-chassis) | Display information about the chassis | | [`show chassis hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`show chassis health`](#show-chassis-health) | Show chassis health | +| [`show chassis health details`](#show-chassis-health-details) | Show the details of the System Health | | [`show chassis led`](#show-chassis-led) | Show the status of the chassis LEDs | | [`show chassis led phy`](#show-chassis-led-phy) | Show the status of the port LEDs | | [`show chassis led system`](#show-chassis-led-system) | Show the status of the System LED | @@ -5991,6 +6228,90 @@ show chassis hardware [router ] [node ] | ------- | ----------- | | [`show chassis`](#show-chassis) | Display information about the chassis | | [`show chassis firmware`](#show-chassis-firmware) | Show information about the chassis firmware | +| [`show chassis health`](#show-chassis-health) | Show chassis health | +| [`show chassis health details`](#show-chassis-health-details) | Show the details of the System Health | +| [`show chassis led`](#show-chassis-led) | Show the status of the chassis LEDs | +| [`show chassis led phy`](#show-chassis-led-phy) | Show the status of the port LEDs | +| [`show chassis led system`](#show-chassis-led-system) | Show the status of the System LED | +| [`show chassis power`](#show-chassis-power) | Show chassis power | +| [`show chassis temperature`](#show-chassis-temperature) | Show chassis temperature sensor readings | +| [`show chassis temperature-thresholds`](#show-chassis-temperature-thresholds) | Show chassis temperature thresholds | + +#### Description + +:::note +This command can only be run on an SSR400/SSR440. +::: + +## `show chassis health` + +Show chassis health + +#### Usage + +``` +show chassis health [router ] [node ] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| node | The name of the node | +| router | The name of the router (default: <current router>) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`details`](#show-chassis-health-details) | Show the details of the System Health | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show chassis`](#show-chassis) | Display information about the chassis | +| [`show chassis firmware`](#show-chassis-firmware) | Show information about the chassis firmware | +| [`show chassis hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`show chassis health details`](#show-chassis-health-details) | Show the details of the System Health | +| [`show chassis led`](#show-chassis-led) | Show the status of the chassis LEDs | +| [`show chassis led phy`](#show-chassis-led-phy) | Show the status of the port LEDs | +| [`show chassis led system`](#show-chassis-led-system) | Show the status of the System LED | +| [`show chassis power`](#show-chassis-power) | Show chassis power | +| [`show chassis temperature`](#show-chassis-temperature) | Show chassis temperature sensor readings | +| [`show chassis temperature-thresholds`](#show-chassis-temperature-thresholds) | Show chassis temperature thresholds | + +#### Description + +:::note +This command can only be run on a Leopard. +::: + +## `show chassis health details` + +Show the details of the System Health + +#### Usage + +``` +show chassis health details [router ] [node ] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| node | The name of the node | +| router | The name of the router (default: <current router>) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show chassis`](#show-chassis) | Display information about the chassis | +| [`show chassis firmware`](#show-chassis-firmware) | Show information about the chassis firmware | +| [`show chassis hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`show chassis health`](#show-chassis-health) | Show chassis health | | [`show chassis led`](#show-chassis-led) | Show the status of the chassis LEDs | | [`show chassis led phy`](#show-chassis-led-phy) | Show the status of the port LEDs | | [`show chassis led system`](#show-chassis-led-system) | Show the status of the System LED | @@ -6035,6 +6356,8 @@ show chassis led [router ] [node ] | [`show chassis`](#show-chassis) | Display information about the chassis | | [`show chassis firmware`](#show-chassis-firmware) | Show information about the chassis firmware | | [`show chassis hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`show chassis health`](#show-chassis-health) | Show chassis health | +| [`show chassis health details`](#show-chassis-health-details) | Show the details of the System Health | | [`show chassis led phy`](#show-chassis-led-phy) | Show the status of the port LEDs | | [`show chassis led system`](#show-chassis-led-system) | Show the status of the System LED | | [`show chassis power`](#show-chassis-power) | Show chassis power | @@ -6072,6 +6395,8 @@ show chassis led phy [port ] [router ] [node ] | [`show chassis`](#show-chassis) | Display information about the chassis | | [`show chassis firmware`](#show-chassis-firmware) | Show information about the chassis firmware | | [`show chassis hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`show chassis health`](#show-chassis-health) | Show chassis health | +| [`show chassis health details`](#show-chassis-health-details) | Show the details of the System Health | | [`show chassis led`](#show-chassis-led) | Show the status of the chassis LEDs | | [`show chassis led system`](#show-chassis-led-system) | Show the status of the System LED | | [`show chassis power`](#show-chassis-power) | Show chassis power | @@ -6108,6 +6433,8 @@ show chassis led system [router ] [node ] | [`show chassis`](#show-chassis) | Display information about the chassis | | [`show chassis firmware`](#show-chassis-firmware) | Show information about the chassis firmware | | [`show chassis hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`show chassis health`](#show-chassis-health) | Show chassis health | +| [`show chassis health details`](#show-chassis-health-details) | Show the details of the System Health | | [`show chassis led`](#show-chassis-led) | Show the status of the chassis LEDs | | [`show chassis led phy`](#show-chassis-led-phy) | Show the status of the port LEDs | | [`show chassis power`](#show-chassis-power) | Show chassis power | @@ -6144,6 +6471,8 @@ show chassis power [router ] [node ] | [`show chassis`](#show-chassis) | Display information about the chassis | | [`show chassis firmware`](#show-chassis-firmware) | Show information about the chassis firmware | | [`show chassis hardware`](#show-chassis-hardware) | Show information about the chassis hardware | +| [`show chassis health`](#show-chassis-health) | Show chassis health | +| [`show chassis health details`](#show-chassis-health-details) | Show the details of the System Health | | [`show chassis led`](#show-chassis-led) | Show the status of the chassis LEDs | | [`show chassis led phy`](#show-chassis-led-phy) | Show the status of the port LEDs | | [`show chassis led system`](#show-chassis-led-system) | Show the status of the System LED | @@ -6187,6 +6516,8 @@ show chassis temperature [sensor ] [router ] [node ] [] [router ] [node ] [force] [node ] router [] {router | resource-g | [`show idp network`](#show-idp-network) | Show IDP networks | | [`show idp platform`](#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | | [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP | #### Description @@ -7772,6 +8106,7 @@ show idp application status [force] [node ] {router | resource-gr | [`show idp network`](#show-idp-network) | Show IDP networks. | | [`show idp platform`](#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | | [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP. | #### Description @@ -7817,6 +8152,7 @@ show idp details [force] [node ] {router | resource-group | since }] [to ] [verbose] [rows | [`show idp network`](#show-idp-network) | Show IDP networks. | | [`show idp platform`](#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | -| [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP | +| [`show idp ssl-proxy status`](#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | +| [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP. | #### Version History @@ -7914,6 +8251,7 @@ show idp events by-application [{from | since }] [to ] [verbos | [`show idp network`](#show-idp-network) | Show IDP networks. | | [`show idp platform`](#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | | [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP. | #### Description @@ -7958,6 +8296,7 @@ show idp events by-attack [{from | since }] [to ] [verbose] [n | [`show idp network`](#show-idp-network) | Show IDP networks. | | [`show idp platform`](#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | | [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP. | #### Description @@ -8007,6 +8346,7 @@ show idp events by-severity [{from | since }] [to ] [verbose] | [`show idp network`](#show-idp-network) | Show IDP networks. | | [`show idp platform`](#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | | [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP. | #### Description @@ -8053,6 +8393,7 @@ show idp network [force] [node ] {router | resource-group ] {router | resource-group ] {router | resource-group ] {router | resource-group } +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The node for which engine started | +| resource-group | The name of the resource group | +| router | The router for which engine started | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`request idp restart`](#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](#show-idp-details) | Show IDP details. | +| [`show idp events`](#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](#show-idp-network) | Show IDP networks | +| [`show idp platform`](#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](#show-idp-signatures) | Show IDP signature package details. | +| [`show stats idp`](cli_stats_reference.md#show-stats-idp) | Metrics about IDP. | + ## `show igmp groups` Show IGMP groups @@ -11751,6 +12131,7 @@ show system [{router | resource-group }] [force] [node | command | description | | ------- | ----------- | +| [`config-integrity`](#show-system-config-integrity) | Display the current status of Configuration Integrity | | [`connectivity`](#show-system-connectivity) | Display inter-node connection statuses. | | [`processes`](#show-system-processes) | Display a table summarizing the statuses of processes. | | [`registry`](#show-system-registry) | Shows registered services from the system services coordinator for the specified process, node or router. | @@ -11788,6 +12169,16 @@ Mon 2017-02-27 15:11:06 EST Completed in 0.22 seconds ``` +## `show system config-integrity` + +Display the current status of Configuration Integrity + +#### Usage + +``` +show system config-integrity +``` + ## `show system connectivity` Display inter-node connection statuses. @@ -13009,6 +13400,56 @@ Completed in 0.03 seconds | ------- | ----------------------------| | 5.1.0 | This feature was introduced | +## `show waypoints` + +Displays waypoint table information at the specified node. + +#### Usage + +``` +show waypoints router node [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| node | The node on which to display waypoints information | +| router | The router on which to display waypoints information | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| detail | summary (default: summary) | + +#### Examples + +##### `show waypoints` + +``` +admin@branch.spoke# show waypoints +Thu 2026-06-18 10:31:02 UTC +:heavy_check_mark: Retrieving waypoint information... +============== ============== =========== ======== ========= ============ +Source Dest Interface In Use Usage Peak Usage +============== ============== =========== ======== ========= ============ +172.16.3.136 172.16.3.188 wan 50000 100.00% 100.00% +``` + +##### `show waypoints detail` + +``` +admin@branch.spoke# show waypoints detail +Tue 2026-06-16 16:32:25 UTC +✔ Retrieving waypoint table information... + +============== ============== =========== ============= ======== ============= ========= ============ ======= ======== ============ ========== ========= =========== + Source Dest Interface Total Ports In Use Range Usage Peak Usage In Db In Mem In Release Max Used State Ring Size +============== ============== =========== ============= ======== ============= ========= ============ ======= ======== ============ ========== ========= =========== + 172.16.3.136 172.16.3.188 wan 50000 50000 16385-65533 100.00% 100.00% 0 0 0 50000 Standby 1000 +``` + ## `sync peer addresses` Synchronize dynamic addresses (DHCP and PPPoE) between routers and a conductor. diff --git a/docs/cli_stats_reference.md b/docs/cli_stats_reference.md index 52a7b532530..aeb47d33cfb 100755 --- a/docs/cli_stats_reference.md +++ b/docs/cli_stats_reference.md @@ -73,9 +73,11 @@ show stats [since ] [force] [router ] [] | [`network-interface`](#show-stats-network-interface) | Stats pertaining to Network Interface | | [`packet-capture`](#show-stats-packet-capture) | Stats pertaining to captured packets | | [`packet-processing`](#show-stats-packet-processing) | Stats pertaining to packet processing | +| [`packet-throughput`](#show-stats-packet-throughput) | Statistics pertaining to packet throughput across the highway manager pipeline | | [`path-tree`](#show-stats-path-tree) | Metrics tracking PathTree server and client behavior | | [`performance-monitoring`](#show-stats-performance-monitoring) | Stats pertaining to SSR peer path performance monitoring | | [`process`](#show-stats-process) | Metrics about SSR processes | +| [`processing-time`](#show-stats-processing-time) | Statistics pertaining to the time spent processing packets across the highway manager pipeline | | [`queue`](#show-stats-queue) | Metrics tracking the TANK queue production and consumption | | [`redis-server-manager`](#show-stats-redis-server-manager) | Stats pertaining to the Redis Server Manager | | [`redundancy`](#show-stats-redundancy) | Stats pertaining to the highway manager redundancy | @@ -34789,6 +34791,7 @@ show stats application-director [since ] [force] [router ] [node | ------- | ----------- | | [`classify-session`](#show-stats-application-director-classify-session) | Metrics about how sessions were classified | | [`requests`](#show-stats-application-director-requests) | The requests made to each endpoint and the status code produced (in-memory) | +| [`throughput`](#show-stats-application-director-throughput) | Throughput rate of classify-session API (requests per second) | ## `show stats application-director classify-session` @@ -35367,6 +35370,33 @@ show stats application-director requests [endpoint ] [status ] For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +## `show stats application-director throughput` + +Throughput rate of classify-session API (requests per second) + +#### Usage + +``` +show stats application-director throughput [endpoint ] [status ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| endpoint | The name endpoint (comma-separated list) | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| status | The response code (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + ## `show stats application-framework` Application Framework statistics for managed applications @@ -49046,6 +49076,7 @@ show stats highway destination-reachability icmp [service ] [network-in | ------- | ----------- | | [`established`](#show-stats-highway-destination-reachability-icmp-established) | The number of ICMP sessions that have received a reverse packet (in-memory) | | [`time-to-establishment`](#show-stats-highway-destination-reachability-icmp-time-to-establishment) | Statistics for 'time-to-establishment' | +| [`time-to-first-server-packet`](#show-stats-highway-destination-reachability-icmp-time-to-first-server-packet) | The time it takes to receive the first packet from the server for an ICMP session | | [`timeout-before-establishment`](#show-stats-highway-destination-reachability-icmp-timeout-before-establishment) | The number of ICMP sessions that timed out before a packet was received in the reverse direction (in-memory) | | [`unreachable`](#show-stats-highway-destination-reachability-icmp-unreachable) | The number of times a ICMP endpoint was unreachable (in-memory) | @@ -49218,6 +49249,32 @@ show stats highway destination-reachability icmp time-to-establishment min [serv For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +## `show stats highway destination-reachability icmp time-to-first-server-packet` + +The time it takes to receive the first packet from the server for an ICMP session + +#### Usage + +``` +show stats highway destination-reachability icmp time-to-first-server-packet [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + ## `show stats highway destination-reachability icmp timeout-before-establishment` The number of ICMP sessions that timed out before a packet was received in the reverse direction (in-memory) @@ -49319,6 +49376,7 @@ show stats highway destination-reachability other [service ] [network-i | ------- | ----------- | | [`established`](#show-stats-highway-destination-reachability-other-established) | The number of other sessions that have received a reverse packet (in-memory) | | [`time-to-establishment`](#show-stats-highway-destination-reachability-other-time-to-establishment) | Statistics for 'time-to-establishment' | +| [`time-to-first-server-packet`](#show-stats-highway-destination-reachability-other-time-to-first-server-packet) | The time it takes to receive the first packet from the server for a session using a protocol other than TCP, TLS, UDP, or ICMP | | [`timeout-before-establishment`](#show-stats-highway-destination-reachability-other-timeout-before-establishment) | The number of other sessions that timed out before a packet was received in the reverse direction (in-memory) | | [`unreachable`](#show-stats-highway-destination-reachability-other-unreachable) | The number of times a other endpoint was unreachable (in-memory) | @@ -49491,6 +49549,32 @@ show stats highway destination-reachability other time-to-establishment min [ser For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +## `show stats highway destination-reachability other time-to-first-server-packet` + +The time it takes to receive the first packet from the server for a session using a protocol other than TCP, TLS, UDP, or ICMP + +#### Usage + +``` +show stats highway destination-reachability other time-to-first-server-packet [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + ## `show stats highway destination-reachability other timeout-before-establishment` The number of other sessions that timed out before a packet was received in the reverse direction (in-memory) @@ -49593,6 +49677,9 @@ show stats highway destination-reachability tcp [service ] [network-int | [`close-before-establishment`](#show-stats-highway-destination-reachability-tcp-close-before-establishment) | The number of TCP sessions that closed before any data was acknowledged (in-memory) | | [`established`](#show-stats-highway-destination-reachability-tcp-established) | The number of TCP sessions that have received an acknowledgement to data (in-memory) | | [`time-to-establishment`](#show-stats-highway-destination-reachability-tcp-time-to-establishment) | Statistics for 'time-to-establishment' | +| [`time-to-first-client-packet`](#show-stats-highway-destination-reachability-tcp-time-to-first-client-packet) | The time it takes to receive the first packet from the client after the TCP handshake is complete | +| [`time-to-first-server-packet`](#show-stats-highway-destination-reachability-tcp-time-to-first-server-packet) | The time it takes to receive the first packet from the server after the TCP handshake is complete | +| [`time-to-handshake`](#show-stats-highway-destination-reachability-tcp-time-to-handshake) | The time it takes to complete a TCP handshake | | [`timeout-before-establishment`](#show-stats-highway-destination-reachability-tcp-timeout-before-establishment) | The number of TCP sessions that timed out before any data was acknowledged (in-memory) | | [`unreachable`](#show-stats-highway-destination-reachability-tcp-unreachable) | The number of times a TCP endpoint was unreachable (in-memory) | @@ -49798,28 +49885,25 @@ show stats highway destination-reachability tcp time-to-establishment min [servi For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability tcp timeout-before-establishment` +## `show stats highway destination-reachability tcp time-to-first-client-packet` -The number of TCP sessions that timed out before any data was acknowledged (in-memory) +The time it takes to receive the first packet from the client after the TCP handshake is complete #### Usage ``` -show stats highway destination-reachability tcp timeout-before-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tcp time-to-first-client-packet [measurement ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| network-interface | The name of the network interface generating this metric (comma-separated list) | +| measurement | The measurement being made on by this metric instance (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | -| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -49827,32 +49911,25 @@ show stats highway destination-reachability tcp timeout-before-establishment [se | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats highway destination-reachability tcp unreachable` +## `show stats highway destination-reachability tcp time-to-first-server-packet` -The number of times a TCP endpoint was unreachable (in-memory) +The time it takes to receive the first packet from the server after the TCP handshake is complete #### Usage ``` -show stats highway destination-reachability tcp unreachable [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tcp time-to-first-server-packet [measurement ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| network-interface | The name of the network interface generating this metric (comma-separated list) | +| measurement | The measurement being made on by this metric instance (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | -| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -49860,32 +49937,25 @@ show stats highway destination-reachability tcp unreachable [service ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats highway destination-reachability tls` +## `show stats highway destination-reachability tcp time-to-handshake` -Statistics for 'tls' +The time it takes to complete a TCP handshake #### Usage ``` -show stats highway destination-reachability tls [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tcp time-to-handshake [measurement ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| network-interface | The name of the network interface generating this metric (comma-separated list) | +| measurement | The measurement being made on by this metric instance (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | -| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -49893,23 +49963,14 @@ show stats highway destination-reachability tls [service ] [network-int | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`close-before-establishment`](#show-stats-highway-destination-reachability-tls-close-before-establishment) | The number of TLS sessions that closed before the handshake could complete (in-memory) | -| [`established`](#show-stats-highway-destination-reachability-tls-established) | The number of TLS sessions that successfully completed the handshake (in-memory) | -| [`time-to-establishment`](#show-stats-highway-destination-reachability-tls-time-to-establishment) | Statistics for 'time-to-establishment' | -| [`timeout-before-establishment`](#show-stats-highway-destination-reachability-tls-timeout-before-establishment) | The number of TLS sessions that timed out before the handshake could complete (in-memory) | - -## `show stats highway destination-reachability tls close-before-establishment` +## `show stats highway destination-reachability tcp timeout-before-establishment` -The number of TLS sessions that closed before the handshake could complete (in-memory) +The number of TCP sessions that timed out before any data was acknowledged (in-memory) #### Usage ``` -show stats highway destination-reachability tls close-before-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tcp timeout-before-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -49935,14 +49996,14 @@ show stats highway destination-reachability tls close-before-establishment [serv For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability tls established` +## `show stats highway destination-reachability tcp unreachable` -The number of TLS sessions that successfully completed the handshake (in-memory) +The number of times a TCP endpoint was unreachable (in-memory) #### Usage ``` -show stats highway destination-reachability tls established [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tcp unreachable [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -49968,14 +50029,14 @@ show stats highway destination-reachability tls established [service ] For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability tls time-to-establishment` +## `show stats highway destination-reachability tls` -Statistics for 'time-to-establishment' +Statistics for 'tls' #### Usage ``` -show stats highway destination-reachability tls time-to-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50001,18 +50062,22 @@ show stats highway destination-reachability tls time-to-establishment [service < | command | description | | ------- | ----------- | -| [`max`](#show-stats-highway-destination-reachability-tls-time-to-establishment-max) | A windowed maximum of the time in milliseconds for establishment (in-memory) | -| [`mean`](#show-stats-highway-destination-reachability-tls-time-to-establishment-mean) | A windowed mean of the time in milliseconds for establishment (in-memory) | -| [`min`](#show-stats-highway-destination-reachability-tls-time-to-establishment-min) | A windowed minimum of the time in milliseconds for establishment (in-memory) | +| [`close-before-establishment`](#show-stats-highway-destination-reachability-tls-close-before-establishment) | The number of TLS sessions that closed before the handshake could complete (in-memory) | +| [`established`](#show-stats-highway-destination-reachability-tls-established) | The number of TLS sessions that successfully completed the handshake (in-memory) | +| [`time-to-establishment`](#show-stats-highway-destination-reachability-tls-time-to-establishment) | Statistics for 'time-to-establishment' | +| [`time-to-first-client-packet`](#show-stats-highway-destination-reachability-tls-time-to-first-client-packet) | The time it takes to receive the first packet from the client after the TLS handshake is complete | +| [`time-to-first-server-packet`](#show-stats-highway-destination-reachability-tls-time-to-first-server-packet) | The time it takes to receive the first packet from the server after the TLS handshake is complete | +| [`time-to-handshake`](#show-stats-highway-destination-reachability-tls-time-to-handshake) | The time it takes to complete a TLS handshake | +| [`timeout-before-establishment`](#show-stats-highway-destination-reachability-tls-timeout-before-establishment) | The number of TLS sessions that timed out before the handshake could complete (in-memory) | -## `show stats highway destination-reachability tls time-to-establishment max` +## `show stats highway destination-reachability tls close-before-establishment` -A windowed maximum of the time in milliseconds for establishment (in-memory) +The number of TLS sessions that closed before the handshake could complete (in-memory) #### Usage ``` -show stats highway destination-reachability tls time-to-establishment max [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls close-before-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50038,14 +50103,14 @@ show stats highway destination-reachability tls time-to-establishment max [servi For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability tls time-to-establishment mean` +## `show stats highway destination-reachability tls established` -A windowed mean of the time in milliseconds for establishment (in-memory) +The number of TLS sessions that successfully completed the handshake (in-memory) #### Usage ``` -show stats highway destination-reachability tls time-to-establishment mean [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls established [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50071,14 +50136,14 @@ show stats highway destination-reachability tls time-to-establishment mean [serv For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability tls time-to-establishment min` +## `show stats highway destination-reachability tls time-to-establishment` -A windowed minimum of the time in milliseconds for establishment (in-memory) +Statistics for 'time-to-establishment' #### Usage ``` -show stats highway destination-reachability tls time-to-establishment min [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls time-to-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50100,18 +50165,22 @@ show stats highway destination-reachability tls time-to-establishment min [servi | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`max`](#show-stats-highway-destination-reachability-tls-time-to-establishment-max) | A windowed maximum of the time in milliseconds for establishment (in-memory) | +| [`mean`](#show-stats-highway-destination-reachability-tls-time-to-establishment-mean) | A windowed mean of the time in milliseconds for establishment (in-memory) | +| [`min`](#show-stats-highway-destination-reachability-tls-time-to-establishment-min) | A windowed minimum of the time in milliseconds for establishment (in-memory) | -## `show stats highway destination-reachability tls timeout-before-establishment` +## `show stats highway destination-reachability tls time-to-establishment max` -The number of TLS sessions that timed out before the handshake could complete (in-memory) +A windowed maximum of the time in milliseconds for establishment (in-memory) #### Usage ``` -show stats highway destination-reachability tls timeout-before-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls time-to-establishment max [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50137,14 +50206,14 @@ show stats highway destination-reachability tls timeout-before-establishment [se For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability udp` +## `show stats highway destination-reachability tls time-to-establishment mean` -Statistics for 'udp' +A windowed mean of the time in milliseconds for establishment (in-memory) #### Usage ``` -show stats highway destination-reachability udp [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls time-to-establishment mean [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50166,23 +50235,18 @@ show stats highway destination-reachability udp [service ] [network-int | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands +#### Description -| command | description | -| ------- | ----------- | -| [`established`](#show-stats-highway-destination-reachability-udp-established) | The number of UDP sessions that have received a reverse packet (in-memory) | -| [`time-to-establishment`](#show-stats-highway-destination-reachability-udp-time-to-establishment) | Statistics for 'time-to-establishment' | -| [`timeout-before-establishment`](#show-stats-highway-destination-reachability-udp-timeout-before-establishment) | The number of UDP sessions that timed out before a packet was received in the reverse direction (in-memory) | -| [`unreachable`](#show-stats-highway-destination-reachability-udp-unreachable) | The number of times a UDP endpoint was unreachable (in-memory) | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability udp established` +## `show stats highway destination-reachability tls time-to-establishment min` -The number of UDP sessions that have received a reverse packet (in-memory) +A windowed minimum of the time in milliseconds for establishment (in-memory) #### Usage ``` -show stats highway destination-reachability udp established [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls time-to-establishment min [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50208,28 +50272,25 @@ show stats highway destination-reachability udp established [service ] For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability udp time-to-establishment` +## `show stats highway destination-reachability tls time-to-first-client-packet` -Statistics for 'time-to-establishment' +The time it takes to receive the first packet from the client after the TLS handshake is complete #### Usage ``` -show stats highway destination-reachability udp time-to-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls time-to-first-client-packet [measurement ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| network-interface | The name of the network interface generating this metric (comma-separated list) | +| measurement | The measurement being made on by this metric instance (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | -| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -50237,36 +50298,25 @@ show stats highway destination-reachability udp time-to-establishment [service < | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`max`](#show-stats-highway-destination-reachability-udp-time-to-establishment-max) | A windowed maximum of the time in milliseconds for establishment (in-memory) | -| [`mean`](#show-stats-highway-destination-reachability-udp-time-to-establishment-mean) | A windowed mean of the time in milliseconds for establishment (in-memory) | -| [`min`](#show-stats-highway-destination-reachability-udp-time-to-establishment-min) | A windowed minimum of the time in milliseconds for establishment (in-memory) | - -## `show stats highway destination-reachability udp time-to-establishment max` +## `show stats highway destination-reachability tls time-to-first-server-packet` -A windowed maximum of the time in milliseconds for establishment (in-memory) +The time it takes to receive the first packet from the server after the TLS handshake is complete #### Usage ``` -show stats highway destination-reachability udp time-to-establishment max [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls time-to-first-server-packet [measurement ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| network-interface | The name of the network interface generating this metric (comma-separated list) | +| measurement | The measurement being made on by this metric instance (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | -| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -50274,18 +50324,40 @@ show stats highway destination-reachability udp time-to-establishment max [servi | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +## `show stats highway destination-reachability tls time-to-handshake` -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +The time it takes to complete a TLS handshake -## `show stats highway destination-reachability udp time-to-establishment mean` +#### Usage -A windowed mean of the time in milliseconds for establishment (in-memory) +``` +show stats highway destination-reachability tls time-to-handshake [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats highway destination-reachability tls timeout-before-establishment` + +The number of TLS sessions that timed out before the handshake could complete (in-memory) #### Usage ``` -show stats highway destination-reachability udp time-to-establishment mean [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability tls timeout-before-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50311,14 +50383,14 @@ show stats highway destination-reachability udp time-to-establishment mean [serv For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability udp time-to-establishment min` +## `show stats highway destination-reachability udp` -A windowed minimum of the time in milliseconds for establishment (in-memory) +Statistics for 'udp' #### Usage ``` -show stats highway destination-reachability udp time-to-establishment min [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50340,18 +50412,24 @@ show stats highway destination-reachability udp time-to-establishment min [servi | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`established`](#show-stats-highway-destination-reachability-udp-established) | The number of UDP sessions that have received a reverse packet (in-memory) | +| [`time-to-establishment`](#show-stats-highway-destination-reachability-udp-time-to-establishment) | Statistics for 'time-to-establishment' | +| [`time-to-first-server-packet`](#show-stats-highway-destination-reachability-udp-time-to-first-server-packet) | The time it takes to receive the first packet from the server for a UDP session | +| [`timeout-before-establishment`](#show-stats-highway-destination-reachability-udp-timeout-before-establishment) | The number of UDP sessions that timed out before a packet was received in the reverse direction (in-memory) | +| [`unreachable`](#show-stats-highway-destination-reachability-udp-unreachable) | The number of times a UDP endpoint was unreachable (in-memory) | -## `show stats highway destination-reachability udp timeout-before-establishment` +## `show stats highway destination-reachability udp established` -The number of UDP sessions that timed out before a packet was received in the reverse direction (in-memory) +The number of UDP sessions that have received a reverse packet (in-memory) #### Usage ``` -show stats highway destination-reachability udp timeout-before-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp established [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50377,14 +50455,14 @@ show stats highway destination-reachability udp timeout-before-establishment [se For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway destination-reachability udp unreachable` +## `show stats highway destination-reachability udp time-to-establishment` -The number of times a UDP endpoint was unreachable (in-memory) +Statistics for 'time-to-establishment' #### Usage ``` -show stats highway destination-reachability udp unreachable [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp time-to-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50406,28 +50484,36 @@ show stats highway destination-reachability udp unreachable [service ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`max`](#show-stats-highway-destination-reachability-udp-time-to-establishment-max) | A windowed maximum of the time in milliseconds for establishment (in-memory) | +| [`mean`](#show-stats-highway-destination-reachability-udp-time-to-establishment-mean) | A windowed mean of the time in milliseconds for establishment (in-memory) | +| [`min`](#show-stats-highway-destination-reachability-udp-time-to-establishment-min) | A windowed minimum of the time in milliseconds for establishment (in-memory) | -## `show stats highway firewall-detector` +## `show stats highway destination-reachability udp time-to-establishment max` -Stats pertaining to the detection of a stateful firewalls in the network +A windowed maximum of the time in milliseconds for establishment (in-memory) #### Usage ``` -show stats highway firewall-detector [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp time-to-establishment max [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | +| network-interface | The name of the network interface generating this metric (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | +| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -50435,38 +50521,32 @@ show stats highway firewall-detector [since ] [force] [router ] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands +#### Description -| command | description | -| ------- | ----------- | -| [`discovery-packet-dropped`](#show-stats-highway-firewall-detector-discovery-packet-dropped) | The number of packets dropped by firewall detector discovery | -| [`discovery-timeout`](#show-stats-highway-firewall-detector-discovery-timeout) | The number of firewall discovery attempts that detected a firewall | -| [`duplicate-context-detected`](#show-stats-highway-firewall-detector-duplicate-context-detected) | The number of duplicate context lookups for missing peer name | -| [`reply-received`](#show-stats-highway-firewall-detector-reply-received) | The number of firewall discovery replies received | -| [`reply-sent`](#show-stats-highway-firewall-detector-reply-sent) | The number of firewall discovery replies sent | -| [`request-received`](#show-stats-highway-firewall-detector-request-received) | The number of firewall discovery requests received | -| [`request-sent`](#show-stats-highway-firewall-detector-request-sent) | The number of firewall discovery requests sent | -| [`tcp-reset-received`](#show-stats-highway-firewall-detector-tcp-reset-received) | The number of TCP reset packets received by firewall detector | -| [`unknown-received`](#show-stats-highway-firewall-detector-unknown-received) | The number of unknown packets received by firewall detector | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats highway firewall-detector discovery-packet-dropped` +## `show stats highway destination-reachability udp time-to-establishment mean` -The number of packets dropped by firewall detector discovery +A windowed mean of the time in milliseconds for establishment (in-memory) #### Usage ``` -show stats highway firewall-detector discovery-packet-dropped [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp time-to-establishment mean [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | +| network-interface | The name of the network interface generating this metric (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | +| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -50474,24 +50554,32 @@ show stats highway firewall-detector discovery-packet-dropped [since ] [f | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats highway firewall-detector discovery-timeout` +#### Description -The number of firewall discovery attempts that detected a firewall +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats highway destination-reachability udp time-to-establishment min` + +A windowed minimum of the time in milliseconds for establishment (in-memory) #### Usage ``` -show stats highway firewall-detector discovery-timeout [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp time-to-establishment min [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | +| network-interface | The name of the network interface generating this metric (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | +| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -50499,14 +50587,18 @@ show stats highway firewall-detector discovery-timeout [since ] [force] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats highway firewall-detector duplicate-context-detected` +#### Description -The number of duplicate context lookups for missing peer name +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats highway destination-reachability udp time-to-first-server-packet` + +The time it takes to receive the first packet from the server for a UDP session #### Usage ``` -show stats highway firewall-detector duplicate-context-detected [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp time-to-first-server-packet [measurement ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50514,6 +50606,7 @@ show stats highway firewall-detector duplicate-context-detected [since ] | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -50524,24 +50617,28 @@ show stats highway firewall-detector duplicate-context-detected [since ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats highway firewall-detector reply-received` +## `show stats highway destination-reachability udp timeout-before-establishment` -The number of firewall discovery replies received +The number of UDP sessions that timed out before a packet was received in the reverse direction (in-memory) #### Usage ``` -show stats highway firewall-detector reply-received [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp timeout-before-establishment [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | +| network-interface | The name of the network interface generating this metric (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | +| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -50549,24 +50646,32 @@ show stats highway firewall-detector reply-received [since ] [force] [rou | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats highway firewall-detector reply-sent` +#### Description -The number of firewall discovery replies sent +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats highway destination-reachability udp unreachable` + +The number of times a UDP endpoint was unreachable (in-memory) #### Usage ``` -show stats highway firewall-detector reply-sent [since ] [force] [router ] [node ] [] +show stats highway destination-reachability udp unreachable [service ] [network-interface ] [destination-prefix ] [traffic-class ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| destination-prefix | The destination IP address and prefix (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | +| network-interface | The name of the network interface generating this metric (comma-separated list) | | node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | +| service | The name of the service generating this metric (comma-separated list) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | ##### Positional Arguments @@ -50574,14 +50679,18 @@ show stats highway firewall-detector reply-sent [since ] [force] [router | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats highway firewall-detector request-received` +#### Description -The number of firewall discovery requests received +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats highway firewall-detector` + +Stats pertaining to the detection of a stateful firewalls in the network #### Usage ``` -show stats highway firewall-detector request-received [since ] [force] [router ] [node ] [] +show stats highway firewall-detector [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50599,14 +50708,28 @@ show stats highway firewall-detector request-received [since ] [force] [r | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats highway firewall-detector request-sent` +##### Subcommands -The number of firewall discovery requests sent +| command | description | +| ------- | ----------- | +| [`discovery-packet-dropped`](#show-stats-highway-firewall-detector-discovery-packet-dropped) | The number of packets dropped by firewall detector discovery | +| [`discovery-timeout`](#show-stats-highway-firewall-detector-discovery-timeout) | The number of firewall discovery attempts that detected a firewall | +| [`duplicate-context-detected`](#show-stats-highway-firewall-detector-duplicate-context-detected) | The number of duplicate context lookups for missing peer name | +| [`reply-received`](#show-stats-highway-firewall-detector-reply-received) | The number of firewall discovery replies received | +| [`reply-sent`](#show-stats-highway-firewall-detector-reply-sent) | The number of firewall discovery replies sent | +| [`request-received`](#show-stats-highway-firewall-detector-request-received) | The number of firewall discovery requests received | +| [`request-sent`](#show-stats-highway-firewall-detector-request-sent) | The number of firewall discovery requests sent | +| [`tcp-reset-received`](#show-stats-highway-firewall-detector-tcp-reset-received) | The number of TCP reset packets received by firewall detector | +| [`unknown-received`](#show-stats-highway-firewall-detector-unknown-received) | The number of unknown packets received by firewall detector | + +## `show stats highway firewall-detector discovery-packet-dropped` + +The number of packets dropped by firewall detector discovery #### Usage ``` -show stats highway firewall-detector request-sent [since ] [force] [router ] [node ] [] +show stats highway firewall-detector discovery-packet-dropped [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50624,14 +50747,14 @@ show stats highway firewall-detector request-sent [since ] [force] [route | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats highway firewall-detector tcp-reset-received` +## `show stats highway firewall-detector discovery-timeout` -The number of TCP reset packets received by firewall detector +The number of firewall discovery attempts that detected a firewall #### Usage ``` -show stats highway firewall-detector tcp-reset-received [since ] [force] [router ] [node ] [] +show stats highway firewall-detector discovery-timeout [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50649,14 +50772,14 @@ show stats highway firewall-detector tcp-reset-received [since ] [force] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats highway firewall-detector unknown-received` +## `show stats highway firewall-detector duplicate-context-detected` -The number of unknown packets received by firewall detector +The number of duplicate context lookups for missing peer name #### Usage ``` -show stats highway firewall-detector unknown-received [since ] [force] [router ] [node ] [] +show stats highway firewall-detector duplicate-context-detected [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50674,14 +50797,14 @@ show stats highway firewall-detector unknown-received [since ] [force] [r | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats icmp` +## `show stats highway firewall-detector reply-received` -Stats pertaining to ICMP packets +The number of firewall discovery replies received #### Usage ``` -show stats icmp [since ] [force] [router ] [node ] [] +show stats highway firewall-detector reply-received [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50699,22 +50822,14 @@ show stats icmp [since ] [force] [router ] [node ] [] [force] [router ] [node ] [] +show stats highway firewall-detector reply-sent [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50732,22 +50847,14 @@ show stats icmp reachability-probe [since ] [force] [router ] [no | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`request`](#show-stats-icmp-reachability-probe-request) | The number of ICMP Destination Unreachable Messages dropped | -| [`service-routes`](#show-stats-icmp-reachability-probe-service-routes) | Stats pertaining to ICMP Probe per Service Route | -| [`sla`](#show-stats-icmp-reachability-probe-sla) | ICMP Reachability Probe SLA | - -## `show stats icmp reachability-probe request` +## `show stats highway firewall-detector request-received` -The number of ICMP Destination Unreachable Messages dropped +The number of firewall discovery requests received #### Usage ``` -show stats icmp reachability-probe request [since ] [force] [router ] [node ] [] +show stats highway firewall-detector request-received [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50765,22 +50872,14 @@ show stats icmp reachability-probe request [since ] [force] [router ] [force] [router ] [node ] [] +show stats highway firewall-detector request-sent [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50798,14 +50897,14 @@ show stats icmp reachability-probe request failure [since ] [force] [rout | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats icmp reachability-probe request success` +## `show stats highway firewall-detector tcp-reset-received` -The number of ICMP probe echo requests that received a reply within the timeout +The number of TCP reset packets received by firewall detector #### Usage ``` -show stats icmp reachability-probe request success [since ] [force] [router ] [node ] [] +show stats highway firewall-detector tcp-reset-received [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50823,14 +50922,14 @@ show stats icmp reachability-probe request success [since ] [force] [rout | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats icmp reachability-probe request timeout` +## `show stats highway firewall-detector unknown-received` -The number of ICMP probe echo requests sent that timed out waiting for a response +The number of unknown packets received by firewall detector #### Usage ``` -show stats icmp reachability-probe request timeout [since ] [force] [router ] [node ] [] +show stats highway firewall-detector unknown-received [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50848,14 +50947,14 @@ show stats icmp reachability-probe request timeout [since ] [force] [rout | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats icmp reachability-probe service-routes` +## `show stats icmp` -Stats pertaining to ICMP Probe per Service Route +Stats pertaining to ICMP packets #### Usage ``` -show stats icmp reachability-probe service-routes [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +show stats icmp [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50863,11 +50962,7 @@ show stats icmp reachability-probe service-routes [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +show stats icmp flow-mtu-updates [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50904,11 +50996,7 @@ show stats icmp reachability-probe service-routes exceeded-by-max-latency [probe | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | -| netintf | The network interface for which this metric was generated (comma-separated list) | -| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | | node | The name of the node generating this metric | -| probe-address | The target address for a ICMP probe (comma-separated list) | -| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -50918,14 +51006,14 @@ show stats icmp reachability-probe service-routes exceeded-by-max-latency [probe | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats icmp reachability-probe service-routes exceeded-by-max-loss` +## `show stats icmp reachability-probe` -The number of ICMP probe intervals whose maximum percent lost exceeds the profile SLA for the service route. +Stats related to the ICMP reachability probe #### Usage ``` -show stats icmp reachability-probe service-routes exceeded-by-max-loss [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +show stats icmp reachability-probe [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50933,11 +51021,7 @@ show stats icmp reachability-probe service-routes exceeded-by-max-loss [probe-pr | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | -| netintf | The network interface for which this metric was generated (comma-separated list) | -| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | | node | The name of the node generating this metric | -| probe-address | The target address for a ICMP probe (comma-separated list) | -| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -50947,14 +51031,22 @@ show stats icmp reachability-probe service-routes exceeded-by-max-loss [probe-pr | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats icmp reachability-probe service-routes exceeded-by-mean-latency` +##### Subcommands -The number of ICMP probe intervals whose mean latency exceeds the profile SLA for the service route. +| command | description | +| ------- | ----------- | +| [`request`](#show-stats-icmp-reachability-probe-request) | The number of ICMP Destination Unreachable Messages dropped | +| [`service-routes`](#show-stats-icmp-reachability-probe-service-routes) | Stats pertaining to ICMP Probe per Service Route | +| [`sla`](#show-stats-icmp-reachability-probe-sla) | ICMP Reachability Probe SLA | + +## `show stats icmp reachability-probe request` + +The number of ICMP Destination Unreachable Messages dropped #### Usage ``` -show stats icmp reachability-probe service-routes exceeded-by-mean-latency [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +show stats icmp reachability-probe request [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50962,11 +51054,7 @@ show stats icmp reachability-probe service-routes exceeded-by-mean-latency [prob | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | -| netintf | The network interface for which this metric was generated (comma-separated list) | -| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | | node | The name of the node generating this metric | -| probe-address | The target address for a ICMP probe (comma-separated list) | -| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -50976,14 +51064,22 @@ show stats icmp reachability-probe service-routes exceeded-by-mean-latency [prob | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats icmp reachability-probe service-routes jitter` +##### Subcommands -Jitter in milliseconds for the service route. (in-memory) +| command | description | +| ------- | ----------- | +| [`failure`](#show-stats-icmp-reachability-probe-request-failure) | The number of ICMP probe echo request packets not sent because of some error setting up the session | +| [`success`](#show-stats-icmp-reachability-probe-request-success) | The number of ICMP probe echo requests that received a reply within the timeout | +| [`timeout`](#show-stats-icmp-reachability-probe-request-timeout) | The number of ICMP probe echo requests sent that timed out waiting for a response | + +## `show stats icmp reachability-probe request failure` + +The number of ICMP probe echo request packets not sent because of some error setting up the session #### Usage ``` -show stats icmp reachability-probe service-routes jitter [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +show stats icmp reachability-probe request failure [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -50991,11 +51087,7 @@ show stats icmp reachability-probe service-routes jitter [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +show stats icmp reachability-probe request success [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -51024,11 +51112,7 @@ show stats icmp reachability-probe service-routes latency [probe-profile-name

] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +show stats icmp reachability-probe request timeout [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -51057,11 +51137,7 @@ show stats icmp reachability-probe service-routes loss [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +show stats icmp reachability-probe service-routes [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| netintf | The network interface for which this metric was generated (comma-separated list) | +| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | +| node | The name of the node generating this metric | +| probe-address | The target address for a ICMP probe (comma-separated list) | +| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`exceeded-by-max-latency`](#show-stats-icmp-reachability-probe-service-routes-exceeded-by-max-latency) | The number of ICMP probe intervals whose maximum latency exceeds the profile SLA for the service route. | +| [`exceeded-by-max-loss`](#show-stats-icmp-reachability-probe-service-routes-exceeded-by-max-loss) | The number of ICMP probe intervals whose maximum percent lost exceeds the profile SLA for the service route. | +| [`exceeded-by-mean-latency`](#show-stats-icmp-reachability-probe-service-routes-exceeded-by-mean-latency) | The number of ICMP probe intervals whose mean latency exceeds the profile SLA for the service route. | +| [`jitter`](#show-stats-icmp-reachability-probe-service-routes-jitter) | Jitter in milliseconds for the service route. (in-memory) | +| [`latency`](#show-stats-icmp-reachability-probe-service-routes-latency) | Latency in milliseconds for the service route. (in-memory) | +| [`loss`](#show-stats-icmp-reachability-probe-service-routes-loss) | Packet loss percentage for the service route. (in-memory) | +| [`updated`](#show-stats-icmp-reachability-probe-service-routes-updated) | The unix timestamp (seconds) when the service route's values were last updated. (in-memory) | + +## `show stats icmp reachability-probe service-routes exceeded-by-max-latency` + +The number of ICMP probe intervals whose maximum latency exceeds the profile SLA for the service route. + +#### Usage + +``` +show stats icmp reachability-probe service-routes exceeded-by-max-latency [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| netintf | The network interface for which this metric was generated (comma-separated list) | +| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | +| node | The name of the node generating this metric | +| probe-address | The target address for a ICMP probe (comma-separated list) | +| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats icmp reachability-probe service-routes exceeded-by-max-loss` + +The number of ICMP probe intervals whose maximum percent lost exceeds the profile SLA for the service route. + +#### Usage + +``` +show stats icmp reachability-probe service-routes exceeded-by-max-loss [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| netintf | The network interface for which this metric was generated (comma-separated list) | +| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | +| node | The name of the node generating this metric | +| probe-address | The target address for a ICMP probe (comma-separated list) | +| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats icmp reachability-probe service-routes exceeded-by-mean-latency` + +The number of ICMP probe intervals whose mean latency exceeds the profile SLA for the service route. + +#### Usage + +``` +show stats icmp reachability-probe service-routes exceeded-by-mean-latency [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| netintf | The network interface for which this metric was generated (comma-separated list) | +| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | +| node | The name of the node generating this metric | +| probe-address | The target address for a ICMP probe (comma-separated list) | +| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats icmp reachability-probe service-routes jitter` + +Jitter in milliseconds for the service route. (in-memory) + +#### Usage + +``` +show stats icmp reachability-probe service-routes jitter [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| netintf | The network interface for which this metric was generated (comma-separated list) | +| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | +| node | The name of the node generating this metric | +| probe-address | The target address for a ICMP probe (comma-separated list) | +| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats icmp reachability-probe service-routes latency` + +Latency in milliseconds for the service route. (in-memory) + +#### Usage + +``` +show stats icmp reachability-probe service-routes latency [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| netintf | The network interface for which this metric was generated (comma-separated list) | +| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | +| node | The name of the node generating this metric | +| probe-address | The target address for a ICMP probe (comma-separated list) | +| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats icmp reachability-probe service-routes loss` + +Packet loss percentage for the service route. (in-memory) + +#### Usage + +``` +show stats icmp reachability-probe service-routes loss [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| netintf | The network interface for which this metric was generated (comma-separated list) | +| next-hop-gateway | The next hop's gateway for a service route (comma-separated list) | +| node | The name of the node generating this metric | +| probe-address | The target address for a ICMP probe (comma-separated list) | +| probe-profile-name | The profile name for an ICMP probe (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats icmp reachability-probe service-routes updated` + +The unix timestamp (seconds) when the service route's values were last updated. (in-memory) + +#### Usage + +``` +show stats icmp reachability-probe service-routes updated [probe-profile-name ] [probe-address ] [netintf ] [next-hop-gateway ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -51746,6 +52045,7 @@ show stats idp [since ] [force] [router ] [node ] [] [force] [router ] [node ] [] [force] [router ] [node ] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus basic` @@ -51871,6 +52173,7 @@ show stats idp antivirus basic [since ] [force] [router ] [node < | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus basic mime-skip` @@ -51913,6 +52216,7 @@ show stats idp antivirus basic mime-skip [since ] [force] [router ] [force] [router ] [force] [router ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus decompress-err` @@ -52089,6 +52396,7 @@ show stats idp antivirus decompress-err [since ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus decompress-err block` @@ -52131,6 +52439,7 @@ show stats idp antivirus decompress-err block [since ] [force] [router ] [force] [ | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus decompress-err permit` @@ -52215,6 +52525,7 @@ show stats idp antivirus decompress-err permit [since ] [force] [router < | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus engine-not-ready` @@ -52265,6 +52576,7 @@ show stats idp antivirus engine-not-ready [since ] [force] [router ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus engine-not-ready log-and-permit` @@ -52349,6 +52662,7 @@ show stats idp antivirus engine-not-ready log-and-permit [since ] [force] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus engine-not-ready permit` @@ -52391,6 +52705,7 @@ show stats idp antivirus engine-not-ready permit [since ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus max-content-size` @@ -52441,6 +52756,7 @@ show stats idp antivirus max-content-size [since ] [force] [router ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus max-content-size log-and-permit` @@ -52525,6 +52842,7 @@ show stats idp antivirus max-content-size log-and-permit [since ] [force] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus max-content-size permit` @@ -52567,6 +52885,7 @@ show stats idp antivirus max-content-size permit [since ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus others` @@ -52617,6 +52936,7 @@ show stats idp antivirus others [since ] [force] [router ] [node | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus others block` @@ -52659,6 +52979,7 @@ show stats idp antivirus others block [since ] [force] [router ] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus others log-and-permit` @@ -52701,6 +53022,7 @@ show stats idp antivirus others log-and-permit [since ] [force] [router < | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus others permit` @@ -52743,6 +53065,7 @@ show stats idp antivirus others permit [since ] [force] [router ] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus out-of-resource` @@ -52793,6 +53116,7 @@ show stats idp antivirus out-of-resource [since ] [force] [router ] [force] [router < | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus out-of-resource log-and-permit` @@ -52877,6 +53202,7 @@ show stats idp antivirus out-of-resource log-and-permit [since ] [force] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus out-of-resource permit` @@ -52919,6 +53245,7 @@ show stats idp antivirus out-of-resource permit [since ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus scan` @@ -52970,6 +53297,7 @@ show stats idp antivirus scan [since ] [force] [router ] [node ] [force] [router ] [n | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus scan fallback` @@ -53054,6 +53383,7 @@ show stats idp antivirus scan fallback [since ] [force] [router ] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus scan threat` @@ -53096,6 +53426,7 @@ show stats idp antivirus scan threat [since ] [force] [router ] [ | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus scan total` @@ -53138,6 +53469,7 @@ show stats idp antivirus scan total [since ] [force] [router ] [n | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus server-conn-err` @@ -53188,6 +53520,7 @@ show stats idp antivirus server-conn-err [since ] [force] [router ] [force] [router < | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus server-conn-err log-and-permit` @@ -53272,6 +53606,7 @@ show stats idp antivirus server-conn-err log-and-permit [since ] [force] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus server-conn-err permit` @@ -53314,6 +53649,7 @@ show stats idp antivirus server-conn-err permit [since ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus timeout` @@ -53364,6 +53700,7 @@ show stats idp antivirus timeout [since ] [force] [router ] [node | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus timeout block` @@ -53406,6 +53743,7 @@ show stats idp antivirus timeout block [since ] [force] [router ] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus timeout log-and-permit` @@ -53448,6 +53786,7 @@ show stats idp antivirus timeout log-and-permit [since ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus timeout permit` @@ -53490,6 +53829,7 @@ show stats idp antivirus timeout permit [since ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus too-many-requests` @@ -53540,6 +53880,7 @@ show stats idp antivirus too-many-requests [since ] [force] [router ] [force] [router | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus too-many-requests log-and-permit` @@ -53624,6 +53966,7 @@ show stats idp antivirus too-many-requests log-and-permit [since ] [force | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp antivirus too-many-requests permit` @@ -53666,6 +54009,7 @@ show stats idp antivirus too-many-requests permit [since ] [force] [route | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp attacks` @@ -53717,6 +54061,7 @@ show stats idp attacks [since ] [force] [router ] [node ] [ | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp attacks missed` @@ -53759,7 +54104,7 @@ show stats idp attacks missed [since ] [force] [router ] [node ] [force] [router ] [node | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | - -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats idp attacks received` - -Number of attacks received successfully (count) (in-memory) - -#### Usage - -``` -show stats idp attacks received [since ] [force] [router ] [node ] [] -``` - -##### Keyword Arguments - -| name | description | -| ---- | ----------- | -| force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| router | The router for which to display stats (default: <current router>) | -| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | - -##### Positional Arguments - -| name | description | -| ---- | ----------- | -| verbosity | detail \| summary \| debug (default: detail) | - -##### See Also - -| command | description | -| ------- | ----------- | -| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | -| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | -| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | -| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | -| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | -| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | -| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | -| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | -| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | -| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | -| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | -| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | - -#### Description +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats idp attacks received` + +Number of attacks received successfully (count) (in-memory) + +#### Usage + +``` +show stats idp attacks received [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ @@ -53896,7 +54240,7 @@ show stats idp attacks total [since ] [force] [router ] [node ] [since ] [force] [router ] [since ] [force] [route | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp bytes transmitted` @@ -54036,6 +54382,7 @@ show stats idp bytes transmitted [netintf ] [since ] [force] [ro | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp packets` @@ -54088,6 +54435,7 @@ show stats idp packets [since ] [force] [router ] [node ] [ | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp packets dropped` @@ -54130,8 +54478,7 @@ show stats idp packets dropped [since ] [force] [router ] [node < | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | - -#### Description +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ ## `show stats idp packets processed` @@ -54175,6 +54522,7 @@ show stats idp packets processed [since ] [force] [router ] [node | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | #### Description @@ -54230,10 +54578,11 @@ show stats idp packets protocol [since ] [force] [router ] [node | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp packets protocol icmp` -total number of icmp packets (in-memory) +Total number of icmp packets (in-memory) #### Usage @@ -54272,6 +54621,7 @@ show stats idp packets protocol icmp [since ] [force] [router ] [ | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | #### Description @@ -54317,14 +54667,13 @@ show stats idp packets protocol other [since ] [force] [router ] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | - -#### Description +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ ## `show stats idp packets protocol tcp` -total number of tcp packets (in-memory) +Total number of tcp packets (in-memory) #### Usage @@ -54363,14 +54712,13 @@ show stats idp packets protocol tcp [since ] [force] [router ] [n | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | - -#### Description +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ ## `show stats idp packets protocol udp` -total number of udp packets (in-memory) +Total number of udp packets (in-memory) #### Usage @@ -54409,8 +54757,8 @@ show stats idp packets protocol udp [since ] [force] [router ] [n | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | -#### Description For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ @@ -54456,6 +54804,7 @@ show stats idp packets received [netintf ] [since ] [force] [rou | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp packets transmitted` @@ -54499,6 +54848,7 @@ show stats idp packets transmitted [netintf ] [since ] [force] [ | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp performance` @@ -54549,6 +54899,7 @@ show stats idp performance [since ] [force] [router ] [node ] [force] [router ] [force] | [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | | [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | | [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | ## `show stats idp performance session-count` @@ -54675,15 +55028,16 @@ show stats idp performance session-count [since ] [force] [router ] [force] [router ] [] +show stats idp ssl-proxy [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -54691,6 +55045,7 @@ show stats interface [since ] [force] [router ] [] | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54704,18 +55059,35 @@ show stats interface [since ] [force] [router ] [] | command | description | | ------- | ----------- | -| [`packet-pool-utilization`](#show-stats-interface-packet-pool-utilization) | Current percentage of packet buffer pool for the interface | -| [`received`](#show-stats-interface-received) | Statistics for 'received' | -| [`sent`](#show-stats-interface-sent) | Statistics for 'sent' | +| [`allowlisted-url-cat-match`](#show-stats-idp-ssl-proxy-allowlisted-url-cat-match) | Allowlist comprise url hostnames that you want to exempt from the SSL proxy processing (requests) | +| [`sessions`](#show-stats-idp-ssl-proxy-sessions) | SSL Proxy Sessions | -## `show stats interface packet-pool-utilization` +##### See Also -Current percentage of packet buffer pool for the interface +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy allowlisted-url-cat-match` + +Allowlist comprise url hostnames that you want to exempt from the SSL proxy processing (requests) #### Usage ``` -show stats interface packet-pool-utilization [port ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy allowlisted-url-cat-match [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -54724,7 +55096,6 @@ show stats interface packet-pool-utilization [port ] [since ] [forc | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54734,14 +55105,32 @@ show stats interface packet-pool-utilization [port ] [since ] [forc | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received` +##### See Also -Statistics for 'received' +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy sessions` + +SSL Proxy Sessions #### Usage ``` -show stats interface received [since ] [force] [router ] [] +show stats idp ssl-proxy sessions [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -54749,6 +55138,7 @@ show stats interface received [since ] [force] [router ] [] [force] [router ] [] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions active [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -54793,7 +55197,6 @@ show stats interface received buffer-allocation-failure [port ] [since ] [since ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions allowlisted [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -54819,7 +55240,6 @@ show stats interface received bytes [port ] [since ] [force] [route | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54829,14 +55249,32 @@ show stats interface received bytes [port ] [since ] [force] [route | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received bytes-rate` +##### See Also -The rate received bytes per second on interface +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy sessions bypassed` + +SSL Proxy Sessions Bypassed #### Usage ``` -show stats interface received bytes-rate [port ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions bypassed [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -54845,7 +55283,6 @@ show stats interface received bytes-rate [port ] [since ] [force] [ | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54855,14 +55292,40 @@ show stats interface received bytes-rate [port ] [since ] [force] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received error` +##### Subcommands -The number of receive errors detected by interface +| command | description | +| ------- | ----------- | +| [`low-mem`](#show-stats-idp-ssl-proxy-sessions-bypassed-low-mem) | The number of proxy sessions that are bypassed because of low memory on Packet Forwarding Engine (requests) | +| [`mem-overflow`](#show-stats-idp-ssl-proxy-sessions-bypassed-mem-overflow) | The number of proxy sessions that are bypassed because the memory usage limit per session was reached (requests) | +| [`non-ssl`](#show-stats-idp-ssl-proxy-sessions-bypassed-non-ssl) | The number of proxy sessions that are bypassed because the non SSL sessions limit was exceeded (requests) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy sessions bypassed low-mem` + +The number of proxy sessions that are bypassed because of low memory on Packet Forwarding Engine (requests) #### Usage ``` -show stats interface received error [port ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions bypassed low-mem [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -54871,7 +55334,6 @@ show stats interface received error [port ] [since ] [force] [route | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54881,14 +55343,32 @@ show stats interface received error [port ] [since ] [force] [route | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received fcs-error` +##### See Also -The number of packets dropped because they fail frame check validation +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy sessions bypassed mem-overflow` + +The number of proxy sessions that are bypassed because the memory usage limit per session was reached (requests) #### Usage ``` -show stats interface received fcs-error [port ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions bypassed mem-overflow [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -54897,7 +55377,6 @@ show stats interface received fcs-error [port ] [since ] [force] [r | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54907,23 +55386,40 @@ show stats interface received fcs-error [port ] [since ] [force] [r | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received lacp` +##### See Also -Stats pertaining to LACP on specified Interface +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy sessions bypassed non-ssl` + +The number of proxy sessions that are bypassed because the non SSL sessions limit was exceeded (requests) #### Usage ``` -show stats interface received lacp [bond-interface ] [member-interface ] [since ] [force] [router ] [] +show stats idp ssl-proxy sessions bypassed non-ssl [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | +| node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54933,31 +55429,40 @@ show stats interface received lacp [bond-interface ] [member-int | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands +##### See Also | command | description | | ------- | ----------- | -| [`illegal`](#show-stats-interface-received-lacp-illegal) | The number of Illegal LACP packets received on this bond member (in-memory) | -| [`packets`](#show-stats-interface-received-lacp-packets) | The number of LACP packets received on this bond member (in-memory) | -| [`unknown`](#show-stats-interface-received-lacp-unknown) | The number of Unknown LACP packets received on this bond member (in-memory) | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | -## `show stats interface received lacp illegal` +## `show stats idp ssl-proxy sessions created` -The number of Illegal LACP packets received on this bond member (in-memory) +The number of proxy sessions that are newly created (requests) #### Usage ``` -show stats interface received lacp illegal [bond-interface ] [member-interface ] [since ] [force] [router ] [] +show stats idp ssl-proxy sessions created [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | +| node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54967,27 +55472,40 @@ show stats interface received lacp illegal [bond-interface ] [me | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### See Also -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | -## `show stats interface received lacp packets` +## `show stats idp ssl-proxy sessions default-profile-hit` -The number of LACP packets received on this bond member (in-memory) +The number of default profiles that are matched when the sessions are allowlisted (count) #### Usage ``` -show stats interface received lacp packets [bond-interface ] [member-interface ] [since ] [force] [router ] [] +show stats idp ssl-proxy sessions default-profile-hit [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | +| node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -54997,27 +55515,40 @@ show stats interface received lacp packets [bond-interface ] [me | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### See Also -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | -## `show stats interface received lacp unknown` +## `show stats idp ssl-proxy sessions dropped` -The number of Unknown LACP packets received on this bond member (in-memory) +The number of proxy sessions that are dropped (requests) #### Usage ``` -show stats interface received lacp unknown [bond-interface ] [member-interface ] [since ] [force] [router ] [] +show stats idp ssl-proxy sessions dropped [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | +| node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55027,18 +55558,32 @@ show stats interface received lacp unknown [bond-interface ] [me | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### See Also -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | -## `show stats interface received missed` +## `show stats idp ssl-proxy sessions dropped-no-default-profile` -The number of packets dropped or discarded by the interface +The number of sessions dropped when no default profiles are matched (requests) #### Usage ``` -show stats interface received missed [port ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions dropped-no-default-profile [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55047,7 +55592,6 @@ show stats interface received missed [port ] [since ] [force] [rout | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55057,14 +55601,32 @@ show stats interface received missed [port ] [since ] [force] [rout | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received missed-rate` +##### See Also -The rate of of packets dropped or discarded per second by the interface (packets per second) +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy sessions ignored` + +The number of proxy sessions that are ignored (requests) #### Usage ``` -show stats interface received missed-rate [port ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions ignored [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55073,7 +55635,6 @@ show stats interface received missed-rate [port ] [since ] [force] | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55083,14 +55644,32 @@ show stats interface received missed-rate [port ] [since ] [force] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received overrun-error` +##### See Also -The number of packets dropped because of queue overruns +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy sessions matched` + +The number of proxy sessions that are matched (requests) #### Usage ``` -show stats interface received overrun-error [port ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions matched [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55099,7 +55678,6 @@ show stats interface received overrun-error [port ] [since ] [force | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55109,14 +55687,32 @@ show stats interface received overrun-error [port ] [since ] [force | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received oversize-error` +##### See Also -The number of packets dropped because they are oversized +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats idp ssl-proxy sessions policy-conflict` + +The number of policies matched when no profile is configured (count) #### Usage ``` -show stats interface received oversize-error [port ] [since ] [force] [router ] [node ] [] +show stats idp ssl-proxy sessions policy-conflict [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55125,7 +55721,6 @@ show stats interface received oversize-error [port ] [since ] [forc | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55135,14 +55730,32 @@ show stats interface received oversize-error [port ] [since ] [forc | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received packets` +##### See Also -The number of packets received on interface +| command | description | +| ------- | ----------- | +| [`request idp restart`](cli_reference.md#request-idp-restart) | Restart IDP Command | +| [`request idp signature-query`](cli_reference.md#request-idp-signature-query) | Request IDP signature database connectivity. | +| [`show idp application details`](cli_reference.md#show-idp-application-details) | Show IDP engine details. | +| [`show idp application status`](cli_reference.md#show-idp-application-status) | Show IDP application status. | +| [`show idp details`](cli_reference.md#show-idp-details) | Show IDP details. | +| [`show idp events`](cli_reference.md#show-idp-events) | Show all IDP events | +| [`show idp events by-application`](cli_reference.md#show-idp-events-by-application) | Show IDP event by application | +| [`show idp events by-attack`](cli_reference.md#show-idp-events-by-attack) | Show IDP event by attack type | +| [`show idp events by-severity`](cli_reference.md#show-idp-events-by-severity) | Show IDP event by severity level | +| [`show idp network`](cli_reference.md#show-idp-network) | Show IDP networks | +| [`show idp platform`](cli_reference.md#show-idp-platform) | Show IDP platform data. | +| [`show idp signatures`](cli_reference.md#show-idp-signatures) | Show IDP signature package details. | +| [`show idp ssl-proxy status`](cli_reference.md#show-idp-ssl-proxy-status) | Show IDP ssl-proxy status. Query and display the IDP SSL engine details. | + +## `show stats interface` + +Stats pertaining to Ethernet Interface #### Usage ``` -show stats interface received packets [port ] [since ] [force] [router ] [node ] [] +show stats interface [since ] [force] [router ] [] ``` ##### Keyword Arguments @@ -55150,8 +55763,6 @@ show stats interface received packets [port ] [since ] [force] [rou | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55161,14 +55772,22 @@ show stats interface received packets [port ] [since ] [force] [rou | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received packets-rate` +##### Subcommands -The rate of received packets per second on interface +| command | description | +| ------- | ----------- | +| [`packet-pool-utilization`](#show-stats-interface-packet-pool-utilization) | Current percentage of packet buffer pool for the interface | +| [`received`](#show-stats-interface-received) | Statistics for 'received' | +| [`sent`](#show-stats-interface-sent) | Statistics for 'sent' | + +## `show stats interface packet-pool-utilization` + +Current percentage of packet buffer pool for the interface #### Usage ``` -show stats interface received packets-rate [port ] [since ] [force] [router ] [node ] [] +show stats interface packet-pool-utilization [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55187,14 +55806,14 @@ show stats interface received packets-rate [port ] [since ] [force] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received undersize-error` +## `show stats interface received` -The number of packets dropped because they are undersized +Statistics for 'received' #### Usage ``` -show stats interface received undersize-error [port ] [since ] [force] [router ] [node ] [] +show stats interface received [since ] [force] [router ] [] ``` ##### Keyword Arguments @@ -55202,8 +55821,6 @@ show stats interface received undersize-error [port ] [since ] [for | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55213,14 +55830,33 @@ show stats interface received undersize-error [port ] [since ] [for | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface received utilization` +##### Subcommands -The current percentage of total received bandwidth by the interface +| command | description | +| ------- | ----------- | +| [`buffer-allocation-failure`](#show-stats-interface-received-buffer-allocation-failure) | The number of receive buffer allocation failures | +| [`bytes`](#show-stats-interface-received-bytes) | The number of bytes received on interface | +| [`bytes-rate`](#show-stats-interface-received-bytes-rate) | The rate received bytes per second on interface | +| [`error`](#show-stats-interface-received-error) | The number of receive errors detected by interface | +| [`fcs-error`](#show-stats-interface-received-fcs-error) | The number of packets dropped because they fail frame check validation | +| [`lacp`](#show-stats-interface-received-lacp) | Stats pertaining to LACP on specified Interface | +| [`missed`](#show-stats-interface-received-missed) | The number of packets dropped or discarded by the interface | +| [`missed-rate`](#show-stats-interface-received-missed-rate) | The rate of of packets dropped or discarded per second by the interface (packets per second) | +| [`overrun-error`](#show-stats-interface-received-overrun-error) | The number of packets dropped because of queue overruns | +| [`oversize-error`](#show-stats-interface-received-oversize-error) | The number of packets dropped because they are oversized | +| [`packets`](#show-stats-interface-received-packets) | The number of packets received on interface | +| [`packets-rate`](#show-stats-interface-received-packets-rate) | The rate of received packets per second on interface | +| [`undersize-error`](#show-stats-interface-received-undersize-error) | The number of packets dropped because they are undersized | +| [`utilization`](#show-stats-interface-received-utilization) | The current percentage of total received bandwidth by the interface | + +## `show stats interface received buffer-allocation-failure` + +The number of receive buffer allocation failures #### Usage ``` -show stats interface received utilization [port ] [since ] [force] [router ] [node ] [] +show stats interface received buffer-allocation-failure [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55239,14 +55875,14 @@ show stats interface received utilization [port ] [since ] [force] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface sent` +## `show stats interface received bytes` -Statistics for 'sent' +The number of bytes received on interface #### Usage ``` -show stats interface sent [since ] [force] [router ] [] +show stats interface received bytes [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55254,6 +55890,8 @@ show stats interface sent [since ] [force] [router ] [ | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55263,24 +55901,14 @@ show stats interface sent [since ] [force] [router ] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`bytes`](#show-stats-interface-sent-bytes) | The number of bytes sent on interface | -| [`error`](#show-stats-interface-sent-error) | The number of send errors detected by interface | -| [`lacp`](#show-stats-interface-sent-lacp) | Stats pertaining to LACP on specified Interface | -| [`packets`](#show-stats-interface-sent-packets) | The number of packets sent on interface | -| [`utilization`](#show-stats-interface-sent-utilization) | The current transmit bandwidth of interface | - -## `show stats interface sent bytes` +## `show stats interface received bytes-rate` -The number of bytes sent on interface +The rate received bytes per second on interface #### Usage ``` -show stats interface sent bytes [port ] [since ] [force] [router ] [node ] [] +show stats interface received bytes-rate [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55299,14 +55927,14 @@ show stats interface sent bytes [port ] [since ] [force] [router ] [since ] [force] [router ] [node ] [] +show stats interface received error [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55325,23 +55953,23 @@ show stats interface sent error [port ] [since ] [force] [router ] [member-interface ] [since ] [force] [router ] [] +show stats interface received fcs-error [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | +| node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55351,21 +55979,14 @@ show stats interface sent lacp [bond-interface ] [member-interfa | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`packets`](#show-stats-interface-sent-lacp-packets) | The number of LACP packets sent on this bond member (in-memory) | -| [`queue-full`](#show-stats-interface-sent-lacp-queue-full) | The number of times that the transmit queue has been full for this bond member (in-memory) | - -## `show stats interface sent lacp packets` +## `show stats interface received lacp` -The number of LACP packets sent on this bond member (in-memory) +Stats pertaining to LACP on specified Interface #### Usage ``` -show stats interface sent lacp packets [bond-interface ] [member-interface ] [since ] [force] [router ] [] +show stats interface received lacp [bond-interface ] [member-interface ] [since ] [force] [router ] [] ``` ##### Keyword Arguments @@ -55384,18 +56005,22 @@ show stats interface sent lacp packets [bond-interface ] [member | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`illegal`](#show-stats-interface-received-lacp-illegal) | The number of Illegal LACP packets received on this bond member (in-memory) | +| [`packets`](#show-stats-interface-received-lacp-packets) | The number of LACP packets received on this bond member (in-memory) | +| [`unknown`](#show-stats-interface-received-lacp-unknown) | The number of Unknown LACP packets received on this bond member (in-memory) | -## `show stats interface sent lacp queue-full` +## `show stats interface received lacp illegal` -The number of times that the transmit queue has been full for this bond member (in-memory) +The number of Illegal LACP packets received on this bond member (in-memory) #### Usage ``` -show stats interface sent lacp queue-full [bond-interface ] [member-interface ] [since ] [force] [router ] [] +show stats interface received lacp illegal [bond-interface ] [member-interface ] [since ] [force] [router ] [] ``` ##### Keyword Arguments @@ -55418,23 +56043,23 @@ show stats interface sent lacp queue-full [bond-interface ] [mem For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats interface sent packets` +## `show stats interface received lacp packets` -The number of packets sent on interface +The number of LACP packets received on this bond member (in-memory) #### Usage ``` -show stats interface sent packets [port ] [since ] [force] [router ] [node ] [] +show stats interface received lacp packets [bond-interface ] [member-interface ] [since ] [force] [router ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | +| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55444,23 +56069,27 @@ show stats interface sent packets [port ] [since ] [force] [router | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats interface sent utilization` +#### Description -The current transmit bandwidth of interface +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats interface received lacp unknown` + +The number of Unknown LACP packets received on this bond member (in-memory) #### Usage ``` -show stats interface sent utilization [port ] [since ] [force] [router ] [node ] [] +show stats interface received lacp unknown [bond-interface ] [member-interface ] [since ] [force] [router ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| port | The device interface for which this metric was generated (comma-separated list) | +| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55470,14 +56099,18 @@ show stats interface sent utilization [port ] [since ] [force] [rou | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats ipfix` +#### Description -Stats pertaining to IPFIX export +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats interface received missed` + +The number of packets dropped or discarded by the interface #### Usage ``` -show stats ipfix [since ] [force] [router ] [node ] [] +show stats interface received missed [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55486,6 +56119,7 @@ show stats ipfix [since ] [force] [router ] [node ] [] [force] [router ] [node ] [] [force] [router ] [node ] [] +show stats interface received missed-rate [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55523,6 +56145,7 @@ show stats ipfix dropped [since ] [force] [router ] [node ] | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55532,22 +56155,14 @@ show stats ipfix dropped [since ] [force] [router ] [node ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`invalid-interface`](#show-stats-ipfix-dropped-invalid-interface) | The number of IPFIX records not generated due to session not having a valid interface (in-memory) | -| [`session-not-established`](#show-stats-ipfix-dropped-session-not-established) | The number of IPFIX records not generated due to session not being fully established (in-memory) | -| [`unsupported-address-family`](#show-stats-ipfix-dropped-unsupported-address-family) | Statistics for 'unsupported-address-family' | - -## `show stats ipfix dropped invalid-interface` +## `show stats interface received overrun-error` -The number of IPFIX records not generated due to session not having a valid interface (in-memory) +The number of packets dropped because of queue overruns #### Usage ``` -show stats ipfix dropped invalid-interface [since ] [force] [router ] [node ] [] +show stats interface received overrun-error [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55556,6 +56171,7 @@ show stats ipfix dropped invalid-interface [since ] [force] [router ] [force] [router ] [force] [router ] [node ] [] +show stats interface received oversize-error [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55585,6 +56197,7 @@ show stats ipfix dropped session-not-established [since ] [force] [router | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55594,18 +56207,14 @@ show stats ipfix dropped session-not-established [since ] [force] [router | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats ipfix dropped unsupported-address-family` +## `show stats interface received packets` -Statistics for 'unsupported-address-family' +The number of packets received on interface #### Usage ``` -show stats ipfix dropped unsupported-address-family [since ] [force] [router ] [node ] [] +show stats interface received packets [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55614,6 +56223,7 @@ show stats ipfix dropped unsupported-address-family [since ] [force] [rou | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55623,20 +56233,14 @@ show stats ipfix dropped unsupported-address-family [since ] [force] [rou | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`ipv6`](#show-stats-ipfix-dropped-unsupported-address-family-ipv6) | The number of IPFIX records not generated due to session having an unsupported address family (IPv6) (in-memory) | - -## `show stats ipfix dropped unsupported-address-family ipv6` +## `show stats interface received packets-rate` -The number of IPFIX records not generated due to session having an unsupported address family (IPv6) (in-memory) +The rate of received packets per second on interface #### Usage ``` -show stats ipfix dropped unsupported-address-family ipv6 [since ] [force] [router ] [node ] [] +show stats interface received packets-rate [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55645,6 +56249,7 @@ show stats ipfix dropped unsupported-address-family ipv6 [since ] [force] | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55654,18 +56259,14 @@ show stats ipfix dropped unsupported-address-family ipv6 [since ] [force] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats ipfix enqueue` +## `show stats interface received undersize-error` -Statistics for 'enqueue' +The number of packets dropped because they are undersized #### Usage ``` -show stats ipfix enqueue [since ] [force] [router ] [node ] [] +show stats interface received undersize-error [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55674,6 +56275,7 @@ show stats ipfix enqueue [since ] [force] [router ] [node ] | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55683,20 +56285,14 @@ show stats ipfix enqueue [since ] [force] [router ] [node ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`attempts`](#show-stats-ipfix-enqueue-attempts) | The number of IPFIX records attempted to be sent (in-memory) | - -## `show stats ipfix enqueue attempts` +## `show stats interface received utilization` -The number of IPFIX records attempted to be sent (in-memory) +The current percentage of total received bandwidth by the interface #### Usage ``` -show stats ipfix enqueue attempts [since ] [force] [router ] [node ] [] +show stats interface received utilization [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55705,6 +56301,7 @@ show stats ipfix enqueue attempts [since ] [force] [router ] [nod | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55714,18 +56311,14 @@ show stats ipfix enqueue attempts [since ] [force] [router ] [nod | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats ipfix record-export-rate` +## `show stats interface sent` -Rate of records exported per unit time (records per second) (in-memory) +Statistics for 'sent' #### Usage ``` -show stats ipfix record-export-rate [since ] [force] [router ] [node ] [] +show stats interface sent [since ] [force] [router ] [] ``` ##### Keyword Arguments @@ -55733,7 +56326,6 @@ show stats ipfix record-export-rate [since ] [force] [router ] [n | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55743,18 +56335,24 @@ show stats ipfix record-export-rate [since ] [force] [router ] [n | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`bytes`](#show-stats-interface-sent-bytes) | The number of bytes sent on interface | +| [`error`](#show-stats-interface-sent-error) | The number of send errors detected by interface | +| [`lacp`](#show-stats-interface-sent-lacp) | Stats pertaining to LACP on specified Interface | +| [`packets`](#show-stats-interface-sent-packets) | The number of packets sent on interface | +| [`utilization`](#show-stats-interface-sent-utilization) | The current transmit bandwidth of interface | -## `show stats ipfix time-per-export` +## `show stats interface sent bytes` -Average time spent generating IPFIX records per record export (us) (in-memory) +The number of bytes sent on interface #### Usage ``` -show stats ipfix time-per-export [since ] [force] [router ] [node ] [] +show stats interface sent bytes [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55763,6 +56361,7 @@ show stats ipfix time-per-export [since ] [force] [router ] [node | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55772,18 +56371,14 @@ show stats ipfix time-per-export [since ] [force] [router ] [node | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats ipfix time-per-session` +## `show stats interface sent error` -Average time spent generating IPFIX records per session in existence (us) (in-memory) +The number of send errors detected by interface #### Usage ``` -show stats ipfix time-per-session [since ] [force] [router ] [node ] [] +show stats interface sent error [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55792,6 +56387,7 @@ show stats ipfix time-per-session [since ] [force] [router ] [nod | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55801,26 +56397,23 @@ show stats ipfix time-per-session [since ] [force] [router ] [nod | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats ipfix total-generation-time` +## `show stats interface sent lacp` -Total time spent generating IPFIX records (us) (in-memory) +Stats pertaining to LACP on specified Interface #### Usage ``` -show stats ipfix total-generation-time [since ] [force] [router ] [node ] [] +show stats interface sent lacp [bond-interface ] [member-interface ] [since ] [force] [router ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | +| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55830,26 +56423,30 @@ show stats ipfix total-generation-time [since ] [force] [router ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`packets`](#show-stats-interface-sent-lacp-packets) | The number of LACP packets sent on this bond member (in-memory) | +| [`queue-full`](#show-stats-interface-sent-lacp-queue-full) | The number of times that the transmit queue has been full for this bond member (in-memory) | -## `show stats ipfix total-records` +## `show stats interface sent lacp packets` -Total number of records exported (in-memory) +The number of LACP packets sent on this bond member (in-memory) #### Usage ``` -show stats ipfix total-records [since ] [force] [router ] [node ] [] +show stats interface sent lacp packets [bond-interface ] [member-interface ] [since ] [force] [router ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | +| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55863,23 +56460,23 @@ show stats ipfix total-records [since ] [force] [router ] [node < For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats mars` +## `show stats interface sent lacp queue-full` -Metrics about the MARS process +The number of times that the transmit queue has been full for this bond member (in-memory) #### Usage ``` -show stats mars [process-name ] [since ] [force] [router ] [node ] [] +show stats interface sent lacp queue-full [bond-interface ] [member-interface ] [since ] [force] [router ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| bond-interface | The name of the bond device interface generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| member-interface | The name of the bond member device interface generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55889,20 +56486,18 @@ show stats mars [process-name ] [since ] [force] [router ] [since ] [force] [router ] [node ] [] +show stats interface sent packets [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55911,7 +56506,7 @@ show stats mars requests [process-name ] [since ] [force] [ | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| port | The device interface for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -55921,21 +56516,14 @@ show stats mars requests [process-name ] [since ] [force] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`bad-response`](#show-stats-mars-requests-bad-response) | The number of responses received from an endpoint that did not have the expected JSON (request) (in-memory) | -| [`count`](#show-stats-mars-requests-count) | The requests made to each endpoint and the status/compression of the response (in-memory) | - -## `show stats mars requests bad-response` +## `show stats interface sent utilization` -The number of responses received from an endpoint that did not have the expected JSON (request) (in-memory) +The current transmit bandwidth of interface #### Usage ``` -show stats mars requests bad-response [process-name ] [since ] [force] [router ] [node ] [] +show stats interface sent utilization [port ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -55944,7 +56532,7 @@ show stats mars requests bad-response [process-name ] [since ] [since ] [status ] [compression ] [since ] [force] [router ] [node ] [] +show stats ipfix [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| compression | the compression algorithm used (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| status | The response code (comma-separated list) | ##### Positional Arguments @@ -55986,18 +56567,509 @@ show stats mars requests count [process-name ] [status ] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`dropped`](#show-stats-ipfix-dropped) | Statistics for 'dropped' | +| [`enqueue`](#show-stats-ipfix-enqueue) | Statistics for 'enqueue' | +| [`record-export-rate`](#show-stats-ipfix-record-export-rate) | Rate of records exported per unit time (records per second) (in-memory) | +| [`time-per-export`](#show-stats-ipfix-time-per-export) | Average time spent generating IPFIX records per record export (us) (in-memory) | +| [`time-per-session`](#show-stats-ipfix-time-per-session) | Average time spent generating IPFIX records per session in existence (us) (in-memory) | +| [`total-generation-time`](#show-stats-ipfix-total-generation-time) | Total time spent generating IPFIX records (us) (in-memory) | +| [`total-records`](#show-stats-ipfix-total-records) | Total number of records exported (in-memory) | -## `show stats memory` +## `show stats ipfix dropped` -Memory usage information +Statistics for 'dropped' #### Usage ``` -show stats memory [since ] [force] [router ] [node ] [] +show stats ipfix dropped [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`invalid-interface`](#show-stats-ipfix-dropped-invalid-interface) | The number of IPFIX records not generated due to session not having a valid interface (in-memory) | +| [`session-not-established`](#show-stats-ipfix-dropped-session-not-established) | The number of IPFIX records not generated due to session not being fully established (in-memory) | +| [`unsupported-address-family`](#show-stats-ipfix-dropped-unsupported-address-family) | Statistics for 'unsupported-address-family' | + +## `show stats ipfix dropped invalid-interface` + +The number of IPFIX records not generated due to session not having a valid interface (in-memory) + +#### Usage + +``` +show stats ipfix dropped invalid-interface [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats ipfix dropped session-not-established` + +The number of IPFIX records not generated due to session not being fully established (in-memory) + +#### Usage + +``` +show stats ipfix dropped session-not-established [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats ipfix dropped unsupported-address-family` + +Statistics for 'unsupported-address-family' + +#### Usage + +``` +show stats ipfix dropped unsupported-address-family [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`ipv6`](#show-stats-ipfix-dropped-unsupported-address-family-ipv6) | The number of IPFIX records not generated due to session having an unsupported address family (IPv6) (in-memory) | + +## `show stats ipfix dropped unsupported-address-family ipv6` + +The number of IPFIX records not generated due to session having an unsupported address family (IPv6) (in-memory) + +#### Usage + +``` +show stats ipfix dropped unsupported-address-family ipv6 [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats ipfix enqueue` + +Statistics for 'enqueue' + +#### Usage + +``` +show stats ipfix enqueue [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`attempts`](#show-stats-ipfix-enqueue-attempts) | The number of IPFIX records attempted to be sent (in-memory) | + +## `show stats ipfix enqueue attempts` + +The number of IPFIX records attempted to be sent (in-memory) + +#### Usage + +``` +show stats ipfix enqueue attempts [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats ipfix record-export-rate` + +Rate of records exported per unit time (records per second) (in-memory) + +#### Usage + +``` +show stats ipfix record-export-rate [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats ipfix time-per-export` + +Average time spent generating IPFIX records per record export (us) (in-memory) + +#### Usage + +``` +show stats ipfix time-per-export [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats ipfix time-per-session` + +Average time spent generating IPFIX records per session in existence (us) (in-memory) + +#### Usage + +``` +show stats ipfix time-per-session [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats ipfix total-generation-time` + +Total time spent generating IPFIX records (us) (in-memory) + +#### Usage + +``` +show stats ipfix total-generation-time [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats ipfix total-records` + +Total number of records exported (in-memory) + +#### Usage + +``` +show stats ipfix total-records [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats mars` + +Metrics about the MARS process + +#### Usage + +``` +show stats mars [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`requests`](#show-stats-mars-requests) | Statistics for 'requests' | + +## `show stats mars requests` + +Statistics for 'requests' + +#### Usage + +``` +show stats mars requests [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`bad-response`](#show-stats-mars-requests-bad-response) | The number of responses received from an endpoint that did not have the expected JSON (request) (in-memory) | +| [`count`](#show-stats-mars-requests-count) | The requests made to each endpoint and the status/compression of the response (in-memory) | + +## `show stats mars requests bad-response` + +The number of responses received from an endpoint that did not have the expected JSON (request) (in-memory) + +#### Usage + +``` +show stats mars requests bad-response [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats mars requests count` + +The requests made to each endpoint and the status/compression of the response (in-memory) + +#### Usage + +``` +show stats mars requests count [process-name ] [status ] [compression ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| compression | the compression algorithm used (comma-separated list) | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| status | The response code (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats memory` + +Memory usage information + +#### Usage + +``` +show stats memory [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73636,14 +74708,14 @@ show stats packet-processing sent to-wire-sanitized [core ] [port ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree` +## `show stats packet-throughput` -Metrics tracking PathTree server and client behavior +Statistics pertaining to packet throughput across the highway manager pipeline #### Usage ``` -show stats path-tree [process ] [since ] [force] [router ] [node ] [] +show stats packet-throughput [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73652,7 +74724,6 @@ show stats path-tree [process ] [since ] [force] [router ] [since ] [force] [router ] [since ] [force] [router ] [node ] [] +show stats packet-throughput fastlane [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73685,7 +74757,6 @@ show stats path-tree client [process ] [since ] [force] [router | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -73695,22 +74766,14 @@ show stats path-tree client [process ] [since ] [force] [router | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands +## `show stats packet-throughput service-area` -| command | description | -| ------- | ----------- | -| [`received`](#show-stats-path-tree-client-received) | Statistics for 'received' | -| [`sent`](#show-stats-path-tree-client-sent) | Statistics for 'sent' | -| [`transactions`](#show-stats-path-tree-client-transactions) | Statistics for 'transactions' | - -## `show stats path-tree client received` - -Statistics for 'received' +The number of packets processed by the highway dispatcher #### Usage ``` -show stats path-tree client received [process ] [since ] [force] [router ] [node ] [] +show stats packet-throughput service-area [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73719,7 +74782,6 @@ show stats path-tree client received [process ] [since ] [force] | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | @@ -73729,22 +74791,14 @@ show stats path-tree client received [process ] [since ] [force] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`notifications`](#show-stats-path-tree-client-received-notifications) | Statistics for 'notifications' | -| [`responses`](#show-stats-path-tree-client-received-responses) | Statistics for 'responses' | -| [`unknown`](#show-stats-path-tree-client-received-unknown) | Statistics for 'unknown' | - -## `show stats path-tree client received notifications` +## `show stats packet-throughput traffic-eng` -Statistics for 'notifications' +The number of packets scheduled by the fastlane for highway from traffic engineering #### Usage ``` -show stats path-tree client received notifications [process ] [since ] [force] [router ] [node ] [] +show stats packet-throughput traffic-eng [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73753,7 +74807,6 @@ show stats path-tree client received notifications [process ] [since ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73797,40 +74842,21 @@ show stats path-tree client received notifications duration [process ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree client received notifications error` - -The number of invalid or malformed notification messages received (count) - -#### Usage - -``` -show stats path-tree client received notifications error [process ] [since ] [force] [router ] [node ] [] -``` - -##### Keyword Arguments - -| name | description | -| ---- | ----------- | -| force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| process | The name of the process generating this metric (comma-separated list) | -| router | The router for which to display stats (default: <current router>) | -| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | - -##### Positional Arguments +##### Subcommands -| name | description | -| ---- | ----------- | -| verbosity | detail \| summary \| debug (default: detail) | +| command | description | +| ------- | ----------- | +| [`client`](#show-stats-path-tree-client) | Statistics for 'client' | +| [`server`](#show-stats-path-tree-server) | Statistics for 'server' | -## `show stats path-tree client received notifications total` +## `show stats path-tree client` -The number of notification messages received successfully (count) +Statistics for 'client' #### Usage ``` -show stats path-tree client received notifications total [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73849,14 +74875,22 @@ show stats path-tree client received notifications total [process ] [si | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree client received responses` +##### Subcommands -Statistics for 'responses' +| command | description | +| ------- | ----------- | +| [`received`](#show-stats-path-tree-client-received) | Statistics for 'received' | +| [`sent`](#show-stats-path-tree-client-sent) | Statistics for 'sent' | +| [`transactions`](#show-stats-path-tree-client-transactions) | Statistics for 'transactions' | + +## `show stats path-tree client received` + +Statistics for 'received' #### Usage ``` -show stats path-tree client received responses [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client received [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73879,18 +74913,18 @@ show stats path-tree client received responses [process ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree client received notifications [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73909,40 +74943,22 @@ show stats path-tree client received responses duration [process ] [sin | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree client received responses error` - -The number of invalid or malformed transaction response messages received (count) - -#### Usage - -``` -show stats path-tree client received responses error [process ] [since ] [force] [router ] [node ] [] -``` - -##### Keyword Arguments - -| name | description | -| ---- | ----------- | -| force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| process | The name of the process generating this metric (comma-separated list) | -| router | The router for which to display stats (default: <current router>) | -| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | - -##### Positional Arguments +##### Subcommands -| name | description | -| ---- | ----------- | -| verbosity | detail \| summary \| debug (default: detail) | +| command | description | +| ------- | ----------- | +| [`duration`](#show-stats-path-tree-client-received-notifications-duration) | Average time to process Notifications on the client (microseconds) | +| [`error`](#show-stats-path-tree-client-received-notifications-error) | The number of invalid or malformed notification messages received (count) | +| [`total`](#show-stats-path-tree-client-received-notifications-total) | The number of notification messages received successfully (count) | -## `show stats path-tree client received responses total` +## `show stats path-tree client received notifications duration` -The number of transaction response messages received successfully (count) +Average time to process Notifications on the client (microseconds) #### Usage ``` -show stats path-tree client received responses total [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client received notifications duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73961,14 +74977,14 @@ show stats path-tree client received responses total [process ] [since | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree client received unknown` +## `show stats path-tree client received notifications error` -Statistics for 'unknown' +The number of invalid or malformed notification messages received (count) #### Usage ``` -show stats path-tree client received unknown [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client received notifications error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -73987,20 +75003,14 @@ show stats path-tree client received unknown [process ] [since ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`total`](#show-stats-path-tree-client-received-unknown-total) | The number of unknown message types received (count) | - -## `show stats path-tree client received unknown total` +## `show stats path-tree client received notifications total` -The number of unknown message types received (count) +The number of notification messages received successfully (count) #### Usage ``` -show stats path-tree client received unknown total [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client received notifications total [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74019,14 +75029,14 @@ show stats path-tree client received unknown total [process ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree client received responses [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74049,16 +75059,18 @@ show stats path-tree client sent [process ] [since ] [force] [ro | command | description | | ------- | ----------- | -| [`requests`](#show-stats-path-tree-client-sent-requests) | Statistics for 'requests' | +| [`duration`](#show-stats-path-tree-client-received-responses-duration) | Average time to process transaction responses on the client (microseconds) | +| [`error`](#show-stats-path-tree-client-received-responses-error) | The number of invalid or malformed transaction response messages received (count) | +| [`total`](#show-stats-path-tree-client-received-responses-total) | The number of transaction response messages received successfully (count) | -## `show stats path-tree client sent requests` +## `show stats path-tree client received responses duration` -Statistics for 'requests' +Average time to process transaction responses on the client (microseconds) #### Usage ``` -show stats path-tree client sent requests [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client received responses duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74077,21 +75089,14 @@ show stats path-tree client sent requests [process ] [since ] [f | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`error`](#show-stats-path-tree-client-sent-requests-error) | The number of transaction request messages that could not be sent (count) | -| [`total`](#show-stats-path-tree-client-sent-requests-total) | The number of transaction request messages sent successfully (count) | - -## `show stats path-tree client sent requests error` +## `show stats path-tree client received responses error` -The number of transaction request messages that could not be sent (count) +The number of invalid or malformed transaction response messages received (count) #### Usage ``` -show stats path-tree client sent requests error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client received responses error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74110,14 +75115,14 @@ show stats path-tree client sent requests error [process ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree client received responses total [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74136,14 +75141,14 @@ show stats path-tree client sent requests total [process ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree client received unknown [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74166,42 +75171,16 @@ show stats path-tree client transactions [process ] [since ] [fo | command | description | | ------- | ----------- | -| [`server-latency`](#show-stats-path-tree-client-transactions-server-latency) | Average latency for the server to process/respond-to transactions (microseconds) | - -## `show stats path-tree client transactions server-latency` - -Average latency for the server to process/respond-to transactions (microseconds) - -#### Usage - -``` -show stats path-tree client transactions server-latency [process ] [since ] [force] [router ] [node ] [] -``` - -##### Keyword Arguments - -| name | description | -| ---- | ----------- | -| force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| process | The name of the process generating this metric (comma-separated list) | -| router | The router for which to display stats (default: <current router>) | -| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | - -##### Positional Arguments - -| name | description | -| ---- | ----------- | -| verbosity | detail \| summary \| debug (default: detail) | +| [`total`](#show-stats-path-tree-client-received-unknown-total) | The number of unknown message types received (count) | -## `show stats path-tree server` +## `show stats path-tree client received unknown total` -Statistics for 'server' +The number of unknown message types received (count) #### Usage ``` -show stats path-tree server [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client received unknown total [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74220,22 +75199,14 @@ show stats path-tree server [process ] [since ] [force] [router | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`received`](#show-stats-path-tree-server-received) | Statistics for 'received' | -| [`sent`](#show-stats-path-tree-server-sent) | Statistics for 'sent' | -| [`transactions`](#show-stats-path-tree-server-transactions) | Statistics for 'transactions' | - -## `show stats path-tree server received` +## `show stats path-tree client sent` -Statistics for 'received' +Statistics for 'sent' #### Usage ``` -show stats path-tree server received [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client sent [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74258,16 +75229,16 @@ show stats path-tree server received [process ] [since ] [force] | command | description | | ------- | ----------- | -| [`requests`](#show-stats-path-tree-server-received-requests) | Statistics for 'requests' | +| [`requests`](#show-stats-path-tree-client-sent-requests) | Statistics for 'requests' | -## `show stats path-tree server received requests` +## `show stats path-tree client sent requests` Statistics for 'requests' #### Usage ``` -show stats path-tree server received requests [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client sent requests [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74290,26 +75261,23 @@ show stats path-tree server received requests [process ] [since | command | description | | ------- | ----------- | -| [`average`](#show-stats-path-tree-server-received-requests-average) | The number of transaction request messages received successfully (count) | -| [`error`](#show-stats-path-tree-server-received-requests-error) | The number of invalid or malformed transaction request messages received (count) | -| [`ignored`](#show-stats-path-tree-server-received-requests-ignored) | The number of transaction request messages received but were ignored due to invalid session state (count) | -| [`total`](#show-stats-path-tree-server-received-requests-total) | The number of transaction request messages received successfully (count) | +| [`error`](#show-stats-path-tree-client-sent-requests-error) | The number of transaction request messages that could not be sent (count) | +| [`total`](#show-stats-path-tree-client-sent-requests-total) | The number of transaction request messages sent successfully (count) | -## `show stats path-tree server received requests average` +## `show stats path-tree client sent requests error` -The number of transaction request messages received successfully (count) +The number of transaction request messages that could not be sent (count) #### Usage ``` -show stats path-tree server received requests average [process ] [client ] [since ] [force] [router ] [node ] [] +show stats path-tree client sent requests error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| client | The name of the client within a process generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | | process | The name of the process generating this metric (comma-separated list) | @@ -74322,14 +75290,14 @@ show stats path-tree server received requests average [process ] [clien | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server received requests error` +## `show stats path-tree client sent requests total` -The number of invalid or malformed transaction request messages received (count) +The number of transaction request messages sent successfully (count) #### Usage ``` -show stats path-tree server received requests error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client sent requests total [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74348,14 +75316,14 @@ show stats path-tree server received requests error [process ] [since < | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server received requests ignored` +## `show stats path-tree client transactions` -The number of transaction request messages received but were ignored due to invalid session state (count) +Statistics for 'transactions' #### Usage ``` -show stats path-tree server received requests ignored [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client transactions [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74374,14 +75342,20 @@ show stats path-tree server received requests ignored [process ] [since | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server received requests total` +##### Subcommands -The number of transaction request messages received successfully (count) +| command | description | +| ------- | ----------- | +| [`server-latency`](#show-stats-path-tree-client-transactions-server-latency) | Average latency for the server to process/respond-to transactions (microseconds) | + +## `show stats path-tree client transactions server-latency` + +Average latency for the server to process/respond-to transactions (microseconds) #### Usage ``` -show stats path-tree server received requests total [process ] [since ] [force] [router ] [node ] [] +show stats path-tree client transactions server-latency [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74400,14 +75374,14 @@ show stats path-tree server received requests total [process ] [since < | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server sent` +## `show stats path-tree server` -Statistics for 'sent' +Statistics for 'server' #### Usage ``` -show stats path-tree server sent [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74430,16 +75404,18 @@ show stats path-tree server sent [process ] [since ] [force] [ro | command | description | | ------- | ----------- | -| [`responses`](#show-stats-path-tree-server-sent-responses) | Statistics for 'responses' | +| [`received`](#show-stats-path-tree-server-received) | Statistics for 'received' | +| [`sent`](#show-stats-path-tree-server-sent) | Statistics for 'sent' | +| [`transactions`](#show-stats-path-tree-server-transactions) | Statistics for 'transactions' | -## `show stats path-tree server sent responses` +## `show stats path-tree server received` -Statistics for 'responses' +Statistics for 'received' #### Usage ``` -show stats path-tree server sent responses [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server received [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74462,17 +75438,16 @@ show stats path-tree server sent responses [process ] [since ] [ | command | description | | ------- | ----------- | -| [`error`](#show-stats-path-tree-server-sent-responses-error) | The number of transaction response messages that could not be sent (count) | -| [`total`](#show-stats-path-tree-server-sent-responses-total) | The number of transaction response messages sent successfully (count) | +| [`requests`](#show-stats-path-tree-server-received-requests) | Statistics for 'requests' | -## `show stats path-tree server sent responses error` +## `show stats path-tree server received requests` -The number of transaction response messages that could not be sent (count) +Statistics for 'requests' #### Usage ``` -show stats path-tree server sent responses error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server received requests [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74491,46 +75466,30 @@ show stats path-tree server sent responses error [process ] [since ] [since ] [force] [router ] [node ] [] -``` - -##### Keyword Arguments - -| name | description | -| ---- | ----------- | -| force | Skip confirmation prompt. Only required when targeting all routers | -| node | The name of the node generating this metric | -| process | The name of the process generating this metric (comma-separated list) | -| router | The router for which to display stats (default: <current router>) | -| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | - -##### Positional Arguments +##### Subcommands -| name | description | -| ---- | ----------- | -| verbosity | detail \| summary \| debug (default: detail) | +| command | description | +| ------- | ----------- | +| [`average`](#show-stats-path-tree-server-received-requests-average) | The number of transaction request messages received successfully (count) | +| [`error`](#show-stats-path-tree-server-received-requests-error) | The number of invalid or malformed transaction request messages received (count) | +| [`ignored`](#show-stats-path-tree-server-received-requests-ignored) | The number of transaction request messages received but were ignored due to invalid session state (count) | +| [`total`](#show-stats-path-tree-server-received-requests-total) | The number of transaction request messages received successfully (count) | -## `show stats path-tree server transactions` +## `show stats path-tree server received requests average` -Statistics for 'transactions' +The number of transaction request messages received successfully (count) #### Usage ``` -show stats path-tree server transactions [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server received requests average [process ] [client ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| client | The name of the client within a process generating this metric (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | | process | The name of the process generating this metric (comma-separated list) | @@ -74543,28 +75502,14 @@ show stats path-tree server transactions [process ] [since ] [fo | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`connect`](#show-stats-path-tree-server-transactions-connect) | Statistics for 'connect' | -| [`disconnect`](#show-stats-path-tree-server-transactions-disconnect) | Statistics for 'disconnect' | -| [`list`](#show-stats-path-tree-server-transactions-list) | Statistics for 'list' | -| [`ping`](#show-stats-path-tree-server-transactions-ping) | Statistics for 'ping' | -| [`publish`](#show-stats-path-tree-server-transactions-publish) | Statistics for 'publish' | -| [`read`](#show-stats-path-tree-server-transactions-read) | Statistics for 'read' | -| [`remove`](#show-stats-path-tree-server-transactions-remove) | Statistics for 'remove' | -| [`unsubscribe`](#show-stats-path-tree-server-transactions-unsubscribe) | Statistics for 'unsubscribe' | -| [`update`](#show-stats-path-tree-server-transactions-update) | Statistics for 'update' | - -## `show stats path-tree server transactions connect` +## `show stats path-tree server received requests error` -Statistics for 'connect' +The number of invalid or malformed transaction request messages received (count) #### Usage ``` -show stats path-tree server transactions connect [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server received requests error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74583,22 +75528,14 @@ show stats path-tree server transactions connect [process ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree server received requests ignored [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74617,14 +75554,14 @@ show stats path-tree server transactions connect duration [process ] [s | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions connect error` +## `show stats path-tree server received requests total` -The number of Connect transactions that could not be processed successfully (count) +The number of transaction request messages received successfully (count) #### Usage ``` -show stats path-tree server transactions connect error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server received requests total [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74643,14 +75580,14 @@ show stats path-tree server transactions connect error [process ] [sinc | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions connect processed` +## `show stats path-tree server sent` -The number of successfully processed Connect transactions (count) +Statistics for 'sent' #### Usage ``` -show stats path-tree server transactions connect processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server sent [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74669,14 +75606,20 @@ show stats path-tree server transactions connect processed [process ] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions disconnect` +##### Subcommands -Statistics for 'disconnect' +| command | description | +| ------- | ----------- | +| [`responses`](#show-stats-path-tree-server-sent-responses) | Statistics for 'responses' | + +## `show stats path-tree server sent responses` + +Statistics for 'responses' #### Usage ``` -show stats path-tree server transactions disconnect [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server sent responses [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74699,18 +75642,17 @@ show stats path-tree server transactions disconnect [process ] [since < | command | description | | ------- | ----------- | -| [`duration`](#show-stats-path-tree-server-transactions-disconnect-duration) | Average time to process/respond-to Disconnect transactions (microseconds) | -| [`error`](#show-stats-path-tree-server-transactions-disconnect-error) | The number of Disconnect transactions that could not be processed successfully (count) | -| [`processed`](#show-stats-path-tree-server-transactions-disconnect-processed) | The number of successfully processed Disconnect transactions (count) | +| [`error`](#show-stats-path-tree-server-sent-responses-error) | The number of transaction response messages that could not be sent (count) | +| [`total`](#show-stats-path-tree-server-sent-responses-total) | The number of transaction response messages sent successfully (count) | -## `show stats path-tree server transactions disconnect duration` +## `show stats path-tree server sent responses error` -Average time to process/respond-to Disconnect transactions (microseconds) +The number of transaction response messages that could not be sent (count) #### Usage ``` -show stats path-tree server transactions disconnect duration [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server sent responses error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74729,14 +75671,14 @@ show stats path-tree server transactions disconnect duration [process ] | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions disconnect error` +## `show stats path-tree server sent responses total` -The number of Disconnect transactions that could not be processed successfully (count) +The number of transaction response messages sent successfully (count) #### Usage ``` -show stats path-tree server transactions disconnect error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server sent responses total [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74755,14 +75697,14 @@ show stats path-tree server transactions disconnect error [process ] [s | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions disconnect processed` +## `show stats path-tree server transactions` -The number of successfully processed Disconnect transactions (count) +Statistics for 'transactions' #### Usage ``` -show stats path-tree server transactions disconnect processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74781,14 +75723,28 @@ show stats path-tree server transactions disconnect processed [process | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions list` +##### Subcommands -Statistics for 'list' +| command | description | +| ------- | ----------- | +| [`connect`](#show-stats-path-tree-server-transactions-connect) | Statistics for 'connect' | +| [`disconnect`](#show-stats-path-tree-server-transactions-disconnect) | Statistics for 'disconnect' | +| [`list`](#show-stats-path-tree-server-transactions-list) | Statistics for 'list' | +| [`ping`](#show-stats-path-tree-server-transactions-ping) | Statistics for 'ping' | +| [`publish`](#show-stats-path-tree-server-transactions-publish) | Statistics for 'publish' | +| [`read`](#show-stats-path-tree-server-transactions-read) | Statistics for 'read' | +| [`remove`](#show-stats-path-tree-server-transactions-remove) | Statistics for 'remove' | +| [`unsubscribe`](#show-stats-path-tree-server-transactions-unsubscribe) | Statistics for 'unsubscribe' | +| [`update`](#show-stats-path-tree-server-transactions-update) | Statistics for 'update' | + +## `show stats path-tree server transactions connect` + +Statistics for 'connect' #### Usage ``` -show stats path-tree server transactions list [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions connect [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74811,18 +75767,18 @@ show stats path-tree server transactions list [process ] [since | command | description | | ------- | ----------- | -| [`duration`](#show-stats-path-tree-server-transactions-list-duration) | Average time to process/respond-to List transactions (microseconds) | -| [`error`](#show-stats-path-tree-server-transactions-list-error) | The number of List transactions that could not be processed successfully (count) | -| [`processed`](#show-stats-path-tree-server-transactions-list-processed) | The number of successfully processed List transactions (count) | +| [`duration`](#show-stats-path-tree-server-transactions-connect-duration) | Average time to process/respond-to Connect transactions (microseconds) | +| [`error`](#show-stats-path-tree-server-transactions-connect-error) | The number of Connect transactions that could not be processed successfully (count) | +| [`processed`](#show-stats-path-tree-server-transactions-connect-processed) | The number of successfully processed Connect transactions (count) | -## `show stats path-tree server transactions list duration` +## `show stats path-tree server transactions connect duration` -Average time to process/respond-to List transactions (microseconds) +Average time to process/respond-to Connect transactions (microseconds) #### Usage ``` -show stats path-tree server transactions list duration [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions connect duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74841,14 +75797,14 @@ show stats path-tree server transactions list duration [process ] [sinc | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions list error` +## `show stats path-tree server transactions connect error` -The number of List transactions that could not be processed successfully (count) +The number of Connect transactions that could not be processed successfully (count) #### Usage ``` -show stats path-tree server transactions list error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions connect error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74867,14 +75823,14 @@ show stats path-tree server transactions list error [process ] [since < | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions list processed` +## `show stats path-tree server transactions connect processed` -The number of successfully processed List transactions (count) +The number of successfully processed Connect transactions (count) #### Usage ``` -show stats path-tree server transactions list processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions connect processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74893,14 +75849,14 @@ show stats path-tree server transactions list processed [process ] [sin | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions ping` +## `show stats path-tree server transactions disconnect` -Statistics for 'ping' +Statistics for 'disconnect' #### Usage ``` -show stats path-tree server transactions ping [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions disconnect [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74923,18 +75879,18 @@ show stats path-tree server transactions ping [process ] [since | command | description | | ------- | ----------- | -| [`duration`](#show-stats-path-tree-server-transactions-ping-duration) | Average time to process/respond-to Ping transactions (microseconds) | -| [`error`](#show-stats-path-tree-server-transactions-ping-error) | The number of Ping transactions that could not be processed successfully (count) | -| [`processed`](#show-stats-path-tree-server-transactions-ping-processed) | The number of successfully processed Ping transactions (count) | +| [`duration`](#show-stats-path-tree-server-transactions-disconnect-duration) | Average time to process/respond-to Disconnect transactions (microseconds) | +| [`error`](#show-stats-path-tree-server-transactions-disconnect-error) | The number of Disconnect transactions that could not be processed successfully (count) | +| [`processed`](#show-stats-path-tree-server-transactions-disconnect-processed) | The number of successfully processed Disconnect transactions (count) | -## `show stats path-tree server transactions ping duration` +## `show stats path-tree server transactions disconnect duration` -Average time to process/respond-to Ping transactions (microseconds) +Average time to process/respond-to Disconnect transactions (microseconds) #### Usage ``` -show stats path-tree server transactions ping duration [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions disconnect duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74953,14 +75909,14 @@ show stats path-tree server transactions ping duration [process ] [sinc | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions ping error` +## `show stats path-tree server transactions disconnect error` -The number of Ping transactions that could not be processed successfully (count) +The number of Disconnect transactions that could not be processed successfully (count) #### Usage ``` -show stats path-tree server transactions ping error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions disconnect error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -74979,14 +75935,14 @@ show stats path-tree server transactions ping error [process ] [since < | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions ping processed` +## `show stats path-tree server transactions disconnect processed` -The number of successfully processed Ping transactions (count) +The number of successfully processed Disconnect transactions (count) #### Usage ``` -show stats path-tree server transactions ping processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions disconnect processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75005,14 +75961,14 @@ show stats path-tree server transactions ping processed [process ] [sin | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions publish` +## `show stats path-tree server transactions list` -Statistics for 'publish' +Statistics for 'list' #### Usage ``` -show stats path-tree server transactions publish [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions list [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75035,18 +75991,18 @@ show stats path-tree server transactions publish [process ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions list duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75065,14 +76021,14 @@ show stats path-tree server transactions publish duration [process ] [s | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions publish error` +## `show stats path-tree server transactions list error` -The number of Publish transactions that could not be processed successfully (count) +The number of List transactions that could not be processed successfully (count) #### Usage ``` -show stats path-tree server transactions publish error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions list error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75091,14 +76047,14 @@ show stats path-tree server transactions publish error [process ] [sinc | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions publish processed` +## `show stats path-tree server transactions list processed` -The number of successfully processed Publish transactions (count) +The number of successfully processed List transactions (count) #### Usage ``` -show stats path-tree server transactions publish processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions list processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75117,14 +76073,14 @@ show stats path-tree server transactions publish processed [process ] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions read` +## `show stats path-tree server transactions ping` -Statistics for 'read' +Statistics for 'ping' #### Usage ``` -show stats path-tree server transactions read [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions ping [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75147,18 +76103,18 @@ show stats path-tree server transactions read [process ] [since | command | description | | ------- | ----------- | -| [`duration`](#show-stats-path-tree-server-transactions-read-duration) | Average time to process/respond-to Read transactions (microseconds) | -| [`error`](#show-stats-path-tree-server-transactions-read-error) | The number of Read transactions that could not be processed successfully (count) | -| [`processed`](#show-stats-path-tree-server-transactions-read-processed) | The number of successfully processed Read transactions (count) | +| [`duration`](#show-stats-path-tree-server-transactions-ping-duration) | Average time to process/respond-to Ping transactions (microseconds) | +| [`error`](#show-stats-path-tree-server-transactions-ping-error) | The number of Ping transactions that could not be processed successfully (count) | +| [`processed`](#show-stats-path-tree-server-transactions-ping-processed) | The number of successfully processed Ping transactions (count) | -## `show stats path-tree server transactions read duration` +## `show stats path-tree server transactions ping duration` -Average time to process/respond-to Read transactions (microseconds) +Average time to process/respond-to Ping transactions (microseconds) #### Usage ``` -show stats path-tree server transactions read duration [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions ping duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75177,14 +76133,14 @@ show stats path-tree server transactions read duration [process ] [sinc | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions read error` +## `show stats path-tree server transactions ping error` -The number of Read transactions that could not be processed successfully (count) +The number of Ping transactions that could not be processed successfully (count) #### Usage ``` -show stats path-tree server transactions read error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions ping error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75203,14 +76159,14 @@ show stats path-tree server transactions read error [process ] [since < | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions read processed` +## `show stats path-tree server transactions ping processed` -The number of successfully processed Read transactions (count) +The number of successfully processed Ping transactions (count) #### Usage ``` -show stats path-tree server transactions read processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions ping processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75229,14 +76185,14 @@ show stats path-tree server transactions read processed [process ] [sin | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions remove` +## `show stats path-tree server transactions publish` -Statistics for 'remove' +Statistics for 'publish' #### Usage ``` -show stats path-tree server transactions remove [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions publish [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75259,18 +76215,18 @@ show stats path-tree server transactions remove [process ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions publish duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75289,14 +76245,14 @@ show stats path-tree server transactions remove duration [process ] [si | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions remove error` +## `show stats path-tree server transactions publish error` -The number of Remove transactions that could not be processed successfully (count) +The number of Publish transactions that could not be processed successfully (count) #### Usage ``` -show stats path-tree server transactions remove error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions publish error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75315,14 +76271,14 @@ show stats path-tree server transactions remove error [process ] [since | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions remove processed` +## `show stats path-tree server transactions publish processed` -The number of successfully processed Remove transactions (count) +The number of successfully processed Publish transactions (count) #### Usage ``` -show stats path-tree server transactions remove processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions publish processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75341,14 +76297,14 @@ show stats path-tree server transactions remove processed [process ] [s | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions unsubscribe` +## `show stats path-tree server transactions read` -Statistics for 'unsubscribe' +Statistics for 'read' #### Usage ``` -show stats path-tree server transactions unsubscribe [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions read [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75371,18 +76327,18 @@ show stats path-tree server transactions unsubscribe [process ] [since | command | description | | ------- | ----------- | -| [`duration`](#show-stats-path-tree-server-transactions-unsubscribe-duration) | Average time to process/respond-to Unsubscribe transactions (microseconds) | -| [`error`](#show-stats-path-tree-server-transactions-unsubscribe-error) | The number of Unsubscribe transactions that could not be processed successfully (count) | -| [`processed`](#show-stats-path-tree-server-transactions-unsubscribe-processed) | The number of successfully processed Unsubscribe transactions (count) | +| [`duration`](#show-stats-path-tree-server-transactions-read-duration) | Average time to process/respond-to Read transactions (microseconds) | +| [`error`](#show-stats-path-tree-server-transactions-read-error) | The number of Read transactions that could not be processed successfully (count) | +| [`processed`](#show-stats-path-tree-server-transactions-read-processed) | The number of successfully processed Read transactions (count) | -## `show stats path-tree server transactions unsubscribe duration` +## `show stats path-tree server transactions read duration` -Average time to process/respond-to Unsubscribe transactions (microseconds) +Average time to process/respond-to Read transactions (microseconds) #### Usage ``` -show stats path-tree server transactions unsubscribe duration [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions read duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75401,14 +76357,14 @@ show stats path-tree server transactions unsubscribe duration [process | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions unsubscribe error` +## `show stats path-tree server transactions read error` -The number of Unsubscribe transactions that could not be processed successfully (count) +The number of Read transactions that could not be processed successfully (count) #### Usage ``` -show stats path-tree server transactions unsubscribe error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions read error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75427,14 +76383,14 @@ show stats path-tree server transactions unsubscribe error [process ] [ | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions unsubscribe processed` +## `show stats path-tree server transactions read processed` -The number of successfully processed Unsubscribe transactions (count) +The number of successfully processed Read transactions (count) #### Usage ``` -show stats path-tree server transactions unsubscribe processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions read processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75453,14 +76409,14 @@ show stats path-tree server transactions unsubscribe processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions remove [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75483,18 +76439,18 @@ show stats path-tree server transactions update [process ] [since ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions remove duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75513,14 +76469,14 @@ show stats path-tree server transactions update duration [process ] [si | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions update error` +## `show stats path-tree server transactions remove error` -The number of Update transactions that could not be processed successfully (count) +The number of Remove transactions that could not be processed successfully (count) #### Usage ``` -show stats path-tree server transactions update error [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions remove error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75539,14 +76495,14 @@ show stats path-tree server transactions update error [process ] [since | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats path-tree server transactions update processed` +## `show stats path-tree server transactions remove processed` -The number of successfully processed Update transactions (count) +The number of successfully processed Remove transactions (count) #### Usage ``` -show stats path-tree server transactions update processed [process ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions remove processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75565,30 +76521,25 @@ show stats path-tree server transactions update processed [process ] [s | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -## `show stats performance-monitoring` +## `show stats path-tree server transactions unsubscribe` -Stats pertaining to SSR peer path performance monitoring +Statistics for 'unsubscribe' #### Usage ``` -show stats performance-monitoring [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions unsubscribe [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| peer-host | The host of the peer generating this metric (comma-separated list) | -| peer-name | The name of the peer generating this metric (comma-separated list) | -| protocol | The protocol for which this metric was generated (comma-separated list) | +| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | -| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -75600,32 +76551,29 @@ show stats performance-monitoring [peer-name ] [peer-host | command | description | | ------- | ----------- | -| [`peer-path`](#show-stats-performance-monitoring-peer-path) | Statistics for 'peer-path' | +| [`duration`](#show-stats-path-tree-server-transactions-unsubscribe-duration) | Average time to process/respond-to Unsubscribe transactions (microseconds) | +| [`error`](#show-stats-path-tree-server-transactions-unsubscribe-error) | The number of Unsubscribe transactions that could not be processed successfully (count) | +| [`processed`](#show-stats-path-tree-server-transactions-unsubscribe-processed) | The number of successfully processed Unsubscribe transactions (count) | -## `show stats performance-monitoring peer-path` +## `show stats path-tree server transactions unsubscribe duration` -Statistics for 'peer-path' +Average time to process/respond-to Unsubscribe transactions (microseconds) #### Usage ``` -show stats performance-monitoring peer-path [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions unsubscribe duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| peer-host | The host of the peer generating this metric (comma-separated list) | -| peer-name | The name of the peer generating this metric (comma-separated list) | -| protocol | The protocol for which this metric was generated (comma-separated list) | +| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | -| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -75633,42 +76581,25 @@ show stats performance-monitoring peer-path [peer-name ] [peer-host < | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`jitter`](#show-stats-performance-monitoring-peer-path-jitter) | Jitter in milliseconds for the SSR peer path. (in-memory) | -| [`latency`](#show-stats-performance-monitoring-peer-path-latency) | Latency in milliseconds for the SSR peer path. (in-memory) | -| [`loss`](#show-stats-performance-monitoring-peer-path-loss) | Aggregate packet loss percentage for the SSR peer path. (in-memory) | -| [`mos`](#show-stats-performance-monitoring-peer-path-mos) | MOS value calculated for the SSR peer path. (hundredths of a decimal) (in-memory) | -| [`received`](#show-stats-performance-monitoring-peer-path-received) | Statistics for 'received' | -| [`transmit`](#show-stats-performance-monitoring-peer-path-transmit) | Statistics for 'transmit' | -| [`updated`](#show-stats-performance-monitoring-peer-path-updated) | The unix timestamp (seconds) when the peer path's values were last updated. (in-memory) | - -## `show stats performance-monitoring peer-path jitter` +## `show stats path-tree server transactions unsubscribe error` -Jitter in milliseconds for the SSR peer path. (in-memory) +The number of Unsubscribe transactions that could not be processed successfully (count) #### Usage ``` -show stats performance-monitoring peer-path jitter [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions unsubscribe error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| peer-host | The host of the peer generating this metric (comma-separated list) | -| peer-name | The name of the peer generating this metric (comma-separated list) | -| protocol | The protocol for which this metric was generated (comma-separated list) | +| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | -| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -75676,34 +76607,25 @@ show stats performance-monitoring peer-path jitter [peer-name ] [peer | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats performance-monitoring peer-path latency` +## `show stats path-tree server transactions unsubscribe processed` -Latency in milliseconds for the SSR peer path. (in-memory) +The number of successfully processed Unsubscribe transactions (count) #### Usage ``` -show stats performance-monitoring peer-path latency [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions unsubscribe processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| peer-host | The host of the peer generating this metric (comma-separated list) | -| peer-name | The name of the peer generating this metric (comma-separated list) | -| protocol | The protocol for which this metric was generated (comma-separated list) | +| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | -| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -75711,34 +76633,25 @@ show stats performance-monitoring peer-path latency [peer-name ] [pee | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats performance-monitoring peer-path loss` +## `show stats path-tree server transactions update` -Aggregate packet loss percentage for the SSR peer path. (in-memory) +Statistics for 'update' #### Usage ``` -show stats performance-monitoring peer-path loss [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions update [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| peer-host | The host of the peer generating this metric (comma-separated list) | -| peer-name | The name of the peer generating this metric (comma-separated list) | -| protocol | The protocol for which this metric was generated (comma-separated list) | +| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | -| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -75746,34 +76659,33 @@ show stats performance-monitoring peer-path loss [peer-name ] [peer-h | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`duration`](#show-stats-path-tree-server-transactions-update-duration) | Average time to process/respond-to Update transactions (microseconds) | +| [`error`](#show-stats-path-tree-server-transactions-update-error) | The number of Update transactions that could not be processed successfully (count) | +| [`processed`](#show-stats-path-tree-server-transactions-update-processed) | The number of successfully processed Update transactions (count) | -## `show stats performance-monitoring peer-path mos` +## `show stats path-tree server transactions update duration` -MOS value calculated for the SSR peer path. (hundredths of a decimal) (in-memory) +Average time to process/respond-to Update transactions (microseconds) #### Usage ``` -show stats performance-monitoring peer-path mos [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions update duration [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| peer-host | The host of the peer generating this metric (comma-separated list) | -| peer-name | The name of the peer generating this metric (comma-separated list) | -| protocol | The protocol for which this metric was generated (comma-separated list) | +| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | -| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -75781,34 +76693,25 @@ show stats performance-monitoring peer-path mos [peer-name ] [peer-ho | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats performance-monitoring peer-path received` +## `show stats path-tree server transactions update error` -Statistics for 'received' +The number of Update transactions that could not be processed successfully (count) #### Usage ``` -show stats performance-monitoring peer-path received [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions update error [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| peer-host | The host of the peer generating this metric (comma-separated list) | -| peer-name | The name of the peer generating this metric (comma-separated list) | -| protocol | The protocol for which this metric was generated (comma-separated list) | +| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | -| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -75816,38 +76719,25 @@ show stats performance-monitoring peer-path received [peer-name ] [pe | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`loss`](#show-stats-performance-monitoring-peer-path-received-loss) | Packet loss percentage for receiving from the SSR peer path. (in-memory) | -| [`marked-packets`](#show-stats-performance-monitoring-peer-path-received-marked-packets) | The number of packets marked by the peer during a given interval. (in-memory) | -| [`marked-packets-acknowledged`](#show-stats-performance-monitoring-peer-path-received-marked-packets-acknowledged) | The number of marked packets acknowledged by the node during a given interval. (in-memory) | - -## `show stats performance-monitoring peer-path received loss` +## `show stats path-tree server transactions update processed` -Packet loss percentage for receiving from the SSR peer path. (in-memory) +The number of successfully processed Update transactions (count) #### Usage ``` -show stats performance-monitoring peer-path received loss [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats path-tree server transactions update processed [process ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| peer-host | The host of the peer generating this metric (comma-separated list) | -| peer-name | The name of the peer generating this metric (comma-separated list) | -| protocol | The protocol for which this metric was generated (comma-separated list) | +| process | The name of the process generating this metric (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| traffic-class | The traffic class for which this metric was generated (comma-separated list) | -| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -75855,18 +76745,14 @@ show stats performance-monitoring peer-path received loss [peer-name | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description - -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ - -## `show stats performance-monitoring peer-path received marked-packets` +## `show stats performance-monitoring` -The number of packets marked by the peer during a given interval. (in-memory) +Stats pertaining to SSR peer path performance monitoring #### Usage ``` -show stats performance-monitoring peer-path received marked-packets [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75890,18 +76776,20 @@ show stats performance-monitoring peer-path received marked-packets [peer-name < | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`peer-path`](#show-stats-performance-monitoring-peer-path) | Statistics for 'peer-path' | -## `show stats performance-monitoring peer-path received marked-packets-acknowledged` +## `show stats performance-monitoring peer-path` -The number of marked packets acknowledged by the node during a given interval. (in-memory) +Statistics for 'peer-path' #### Usage ``` -show stats performance-monitoring peer-path received marked-packets-acknowledged [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75925,18 +76813,26 @@ show stats performance-monitoring peer-path received marked-packets-acknowledged | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`jitter`](#show-stats-performance-monitoring-peer-path-jitter) | Jitter in milliseconds for the SSR peer path. (in-memory) | +| [`latency`](#show-stats-performance-monitoring-peer-path-latency) | Latency in milliseconds for the SSR peer path. (in-memory) | +| [`loss`](#show-stats-performance-monitoring-peer-path-loss) | Aggregate packet loss percentage for the SSR peer path. (in-memory) | +| [`mos`](#show-stats-performance-monitoring-peer-path-mos) | MOS value calculated for the SSR peer path. (hundredths of a decimal) (in-memory) | +| [`received`](#show-stats-performance-monitoring-peer-path-received) | Statistics for 'received' | +| [`transmit`](#show-stats-performance-monitoring-peer-path-transmit) | Statistics for 'transmit' | +| [`updated`](#show-stats-performance-monitoring-peer-path-updated) | The unix timestamp (seconds) when the peer path's values were last updated. (in-memory) | -## `show stats performance-monitoring peer-path transmit` +## `show stats performance-monitoring peer-path jitter` -Statistics for 'transmit' +Jitter in milliseconds for the SSR peer path. (in-memory) #### Usage ``` -show stats performance-monitoring peer-path transmit [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path jitter [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -75960,22 +76856,18 @@ show stats performance-monitoring peer-path transmit [peer-name ] [pe | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands +#### Description -| command | description | -| ------- | ----------- | -| [`loss`](#show-stats-performance-monitoring-peer-path-transmit-loss) | Packet loss percentage for transmitting to the SSR peer path. (in-memory) | -| [`marked-packets`](#show-stats-performance-monitoring-peer-path-transmit-marked-packets) | The number of packets marked by the node during a given interval. (in-memory) | -| [`marked-packets-acknowledged`](#show-stats-performance-monitoring-peer-path-transmit-marked-packets-acknowledged) | The number of marked packets acknowledged by the peer during a given interval. (in-memory) | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats performance-monitoring peer-path transmit loss` +## `show stats performance-monitoring peer-path latency` -Packet loss percentage for transmitting to the SSR peer path. (in-memory) +Latency in milliseconds for the SSR peer path. (in-memory) #### Usage ``` -show stats performance-monitoring peer-path transmit loss [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path latency [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76003,14 +76895,14 @@ show stats performance-monitoring peer-path transmit loss [peer-name For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats performance-monitoring peer-path transmit marked-packets` +## `show stats performance-monitoring peer-path loss` -The number of packets marked by the node during a given interval. (in-memory) +Aggregate packet loss percentage for the SSR peer path. (in-memory) #### Usage ``` -show stats performance-monitoring peer-path transmit marked-packets [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path loss [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76038,14 +76930,14 @@ show stats performance-monitoring peer-path transmit marked-packets [peer-name < For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats performance-monitoring peer-path transmit marked-packets-acknowledged` +## `show stats performance-monitoring peer-path mos` -The number of marked packets acknowledged by the peer during a given interval. (in-memory) +MOS value calculated for the SSR peer path. (hundredths of a decimal) (in-memory) #### Usage ``` -show stats performance-monitoring peer-path transmit marked-packets-acknowledged [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path mos [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76073,14 +76965,14 @@ show stats performance-monitoring peer-path transmit marked-packets-acknowledged For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats performance-monitoring peer-path updated` +## `show stats performance-monitoring peer-path received` -The unix timestamp (seconds) when the peer path's values were last updated. (in-memory) +Statistics for 'received' #### Usage ``` -show stats performance-monitoring peer-path updated [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path received [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76104,29 +76996,38 @@ show stats performance-monitoring peer-path updated [peer-name ] [pee | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -#### Description +##### Subcommands -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +| command | description | +| ------- | ----------- | +| [`loss`](#show-stats-performance-monitoring-peer-path-received-loss) | Packet loss percentage for receiving from the SSR peer path. (in-memory) | +| [`marked-packets`](#show-stats-performance-monitoring-peer-path-received-marked-packets) | The number of packets marked by the peer during a given interval. (in-memory) | +| [`marked-packets-acknowledged`](#show-stats-performance-monitoring-peer-path-received-marked-packets-acknowledged) | The number of marked packets acknowledged by the node during a given interval. (in-memory) | -## `show stats process` +## `show stats performance-monitoring peer-path received loss` -Metrics about SSR processes +Packet loss percentage for receiving from the SSR peer path. (in-memory) #### Usage ``` -show stats process [process-name ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path received loss [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| peer-host | The host of the peer generating this metric (comma-separated list) | +| peer-name | The name of the peer generating this metric (comma-separated list) | +| protocol | The protocol for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | +| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -76134,39 +77035,34 @@ show stats process [process-name ] [since ] [force] [router | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`cpu`](#show-stats-process-cpu) | Metrics about CPU usage of SSR processes | -| [`memory`](#show-stats-process-memory) | Metrics about memory usage of SSR processes | -| [`thread`](#show-stats-process-thread) | Metrics about threads in SSR processes | - -##### See Also +#### Description -| command | description | -| ------- | ----------- | -| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats process cpu` +## `show stats performance-monitoring peer-path received marked-packets` -Metrics about CPU usage of SSR processes +The number of packets marked by the peer during a given interval. (in-memory) #### Usage ``` -show stats process cpu [process-name ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path received marked-packets [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| peer-host | The host of the peer generating this metric (comma-separated list) | +| peer-name | The name of the peer generating this metric (comma-separated list) | +| protocol | The protocol for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | +| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -76174,37 +77070,34 @@ show stats process cpu [process-name ] [since ] [force] [ro | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`usage`](#show-stats-process-cpu-usage) | CPU percentage used per process | - -##### See Also +#### Description -| command | description | -| ------- | ----------- | -| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats process cpu usage` +## `show stats performance-monitoring peer-path received marked-packets-acknowledged` -CPU percentage used per process +The number of marked packets acknowledged by the node during a given interval. (in-memory) #### Usage ``` -show stats process cpu usage [process-name ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path received marked-packets-acknowledged [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| peer-host | The host of the peer generating this metric (comma-separated list) | +| peer-name | The name of the peer generating this metric (comma-separated list) | +| protocol | The protocol for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | +| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -76212,31 +77105,34 @@ show stats process cpu usage [process-name ] [since ] [forc | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### See Also +#### Description -| command | description | -| ------- | ----------- | -| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats process memory` +## `show stats performance-monitoring peer-path transmit` -Metrics about memory usage of SSR processes +Statistics for 'transmit' #### Usage ``` -show stats process memory [process-name ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path transmit [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| peer-host | The host of the peer generating this metric (comma-separated list) | +| peer-name | The name of the peer generating this metric (comma-separated list) | +| protocol | The protocol for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | +| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -76248,37 +77144,34 @@ show stats process memory [process-name ] [since ] [force] | command | description | | ------- | ----------- | -| [`allocated`](#show-stats-process-memory-allocated) | Number of bytes allocated to the application itself | -| [`heap-size`](#show-stats-process-memory-heap-size) | Number of bytes allocated to the heap | -| [`rss`](#show-stats-process-memory-rss) | Resident memory used per process (bytes) | -| [`tc-malloc`](#show-stats-process-memory-tc-malloc) | Statistics for 'tc-malloc' | -| [`vsz`](#show-stats-process-memory-vsz) | Virtual memory used per process (bytes) | - -##### See Also - -| command | description | -| ------- | ----------- | -| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | +| [`loss`](#show-stats-performance-monitoring-peer-path-transmit-loss) | Packet loss percentage for transmitting to the SSR peer path. (in-memory) | +| [`marked-packets`](#show-stats-performance-monitoring-peer-path-transmit-marked-packets) | The number of packets marked by the node during a given interval. (in-memory) | +| [`marked-packets-acknowledged`](#show-stats-performance-monitoring-peer-path-transmit-marked-packets-acknowledged) | The number of marked packets acknowledged by the peer during a given interval. (in-memory) | -## `show stats process memory allocated` +## `show stats performance-monitoring peer-path transmit loss` -Number of bytes allocated to the application itself +Packet loss percentage for transmitting to the SSR peer path. (in-memory) #### Usage ``` -show stats process memory allocated [process-name ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path transmit loss [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| peer-host | The host of the peer generating this metric (comma-separated list) | +| peer-name | The name of the peer generating this metric (comma-separated list) | +| protocol | The protocol for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | +| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -76286,31 +77179,34 @@ show stats process memory allocated [process-name ] [since | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### See Also +#### Description -| command | description | -| ------- | ----------- | -| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats process memory heap-size` +## `show stats performance-monitoring peer-path transmit marked-packets` -Number of bytes allocated to the heap +The number of packets marked by the node during a given interval. (in-memory) #### Usage ``` -show stats process memory heap-size [process-name ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path transmit marked-packets [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| peer-host | The host of the peer generating this metric (comma-separated list) | +| peer-name | The name of the peer generating this metric (comma-separated list) | +| protocol | The protocol for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | +| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -76318,31 +77214,34 @@ show stats process memory heap-size [process-name ] [since | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### See Also +#### Description -| command | description | -| ------- | ----------- | -| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats process memory rss` +## `show stats performance-monitoring peer-path transmit marked-packets-acknowledged` -Resident memory used per process (bytes) +The number of marked packets acknowledged by the peer during a given interval. (in-memory) #### Usage ``` -show stats process memory rss [process-name ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path transmit marked-packets-acknowledged [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| peer-host | The host of the peer generating this metric (comma-separated list) | +| peer-name | The name of the peer generating this metric (comma-separated list) | +| protocol | The protocol for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | +| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -76350,31 +77249,34 @@ show stats process memory rss [process-name ] [since ] [for | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### See Also +#### Description -| command | description | -| ------- | ----------- | -| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats process memory tc-malloc` +## `show stats performance-monitoring peer-path updated` -Statistics for 'tc-malloc' +The unix timestamp (seconds) when the peer path's values were last updated. (in-memory) #### Usage ``` -show stats process memory tc-malloc [process-name ] [since ] [force] [router ] [node ] [] +show stats performance-monitoring peer-path updated [peer-name ] [peer-host ] [device-name ] [vlan ] [traffic-class ] [protocol ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | +| device-name | The name of the device port for which this metric was generated (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | -| process-name | The name of the process (comma-separated list) | +| peer-host | The host of the peer generating this metric (comma-separated list) | +| peer-name | The name of the peer generating this metric (comma-separated list) | +| protocol | The protocol for which this metric was generated (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| traffic-class | The traffic class for which this metric was generated (comma-separated list) | +| vlan | The vlan for which this metrics was generated (comma-separated list) | ##### Positional Arguments @@ -76382,29 +77284,18 @@ show stats process memory tc-malloc [process-name ] [since | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | -##### Subcommands - -| command | description | -| ------- | ----------- | -| [`current-total-thread-cache`](#show-stats-process-memory-tc-malloc-current-total-thread-cache) | Number of (some of the) bytes tc-malloc is using for small objects | -| [`max-total-thread-cache`](#show-stats-process-memory-tc-malloc-max-total-thread-cache) | Number of bytes tc-malloc dedicates for small objects | -| [`page-heap-free`](#show-stats-process-memory-tc-malloc-page-heap-free) | Number of bytes in free, mapped pages in the page heap | -| [`page-heap-unmapped`](#show-stats-process-memory-tc-malloc-page-heap-unmapped) | Number of bytes in free, unmapped pages in the page heap | - -##### See Also +#### Description -| command | description | -| ------- | ----------- | -| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ -## `show stats process memory tc-malloc current-total-thread-cache` +## `show stats process` -Number of (some of the) bytes tc-malloc is using for small objects +Metrics about SSR processes #### Usage ``` -show stats process memory tc-malloc current-total-thread-cache [process-name ] [since ] [force] [router ] [node ] [] +show stats process [process-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76423,20 +77314,30 @@ show stats process memory tc-malloc current-total-thread-cache [process-name ] [since ] [force] [router ] [node ] [] +show stats process cpu [process-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76455,20 +77356,26 @@ show stats process memory tc-malloc max-total-thread-cache [process-name ] [since ] [force] [router ] [node ] [] +show stats process cpu usage [process-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76493,14 +77400,14 @@ show stats process memory tc-malloc page-heap-free [process-name ] | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -## `show stats process memory tc-malloc page-heap-unmapped` +## `show stats process function` -Number of bytes in free, unmapped pages in the page heap +Metrics about functions in SSR processes #### Usage ``` -show stats process memory tc-malloc page-heap-unmapped [process-name ] [since ] [force] [router ] [node ] [] +show stats process function [process-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76508,10 +77415,12 @@ show stats process memory tc-malloc page-heap-unmapped [process-name ] [since ] [force] [router ] [node ] [] +show stats process function thread [process-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76540,10 +77455,12 @@ show stats process memory vsz [process-name ] [since ] [for | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| function-name | The name of the function measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | ##### Positional Arguments @@ -76551,20 +77468,33 @@ show stats process memory vsz [process-name ] [since ] [for | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`executed`](#show-stats-process-function-thread-executed) | The number of times the function was invoked in the thread per time period (executed) | +| [`execution-time-average`](#show-stats-process-function-thread-execution-time-average) | The average execution time for the function in the thread per time period (us) | +| [`execution-time-buckets`](#show-stats-process-function-thread-execution-time-buckets) | The number of executions for the function in the thread per time period, broken down by duration buckets (executed) | +| [`execution-time-total`](#show-stats-process-function-thread-execution-time-total) | The total execution time for the function in the thread per time period (us) | +| [`memory-allocated-average`](#show-stats-process-function-thread-memory-allocated-average) | The average memory allocated by the function in the thread per time period, in bytes | +| [`memory-allocated-total`](#show-stats-process-function-thread-memory-allocated-total) | The total memory allocated by the function in the thread per time period, in bytes | +| [`memory-deallocated-average`](#show-stats-process-function-thread-memory-deallocated-average) | The average memory released by the function in the thread per time period, in bytes | +| [`memory-deallocated-total`](#show-stats-process-function-thread-memory-deallocated-total) | The total memory released by the function in the thread per time period, in bytes | + ##### See Also | command | description | | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -## `show stats process thread` +## `show stats process function thread executed` -Metrics about threads in SSR processes +The number of times the function was invoked in the thread per time period (executed) #### Usage ``` -show stats process thread [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process function thread executed [process-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76572,6 +77502,7 @@ show stats process thread [process-name ] [thread-name ] [thread-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| function-name | The name of the function measurement (comma-separated list) | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | ##### See Also @@ -76598,14 +77555,14 @@ show stats process thread [process-name ] [thread-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process function thread execution-time-buckets [process-name ] [function-name ] [thread-name ] [measurement ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76613,6 +77570,8 @@ show stats process thread cpu [process-name ] [thread-name ] [thread-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| function-name | The name of the function measurement (comma-separated list) | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | ##### See Also @@ -76640,14 +77624,14 @@ show stats process thread cpu [process-name ] [thread-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process function thread memory-allocated-average [process-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76655,6 +77639,7 @@ show stats process thread cpu iowait [process-name ] [thread-name | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| function-name | The name of the function measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | @@ -76673,14 +77658,14 @@ show stats process thread cpu iowait [process-name ] [thread-name | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -## `show stats process thread cpu system-usage` +## `show stats process function thread memory-allocated-total` -System-level CPU percentage used in a thread +The total memory allocated by the function in the thread per time period, in bytes #### Usage ``` -show stats process thread cpu system-usage [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process function thread memory-allocated-total [process-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76688,6 +77673,7 @@ show stats process thread cpu system-usage [process-name ] [thread | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| function-name | The name of the function measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | @@ -76706,14 +77692,14 @@ show stats process thread cpu system-usage [process-name ] [thread | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -## `show stats process thread cpu usage` +## `show stats process function thread memory-deallocated-average` -CPU percentage used in a thread for both user and system +The average memory released by the function in the thread per time period, in bytes #### Usage ``` -show stats process thread cpu usage [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process function thread memory-deallocated-average [process-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76721,6 +77707,7 @@ show stats process thread cpu usage [process-name ] [thread-name < | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| function-name | The name of the function measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | @@ -76739,14 +77726,14 @@ show stats process thread cpu usage [process-name ] [thread-name < | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -## `show stats process thread cpu user-usage` +## `show stats process function thread memory-deallocated-total` -User-level CPU percentage used in a thread +The total memory released by the function in the thread per time period, in bytes #### Usage ``` -show stats process thread cpu user-usage [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process function thread memory-deallocated-total [process-name ] [function-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76754,6 +77741,7 @@ show stats process thread cpu user-usage [process-name ] [thread-n | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| function-name | The name of the function measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | @@ -76772,14 +77760,14 @@ show stats process thread cpu user-usage [process-name ] [thread-n | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -## `show stats process thread queue` +## `show stats process memory` -Metrics about queues in threads in SSR processes +Metrics about memory usage of SSR processes #### Usage ``` -show stats process thread queue [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process memory [process-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76791,7 +77779,6 @@ show stats process thread queue [process-name ] [thread-name ] [thread-name ] [thread-name ] [thread-name ] [average-type-name ] [since ] [force] [router ] [node ] [] +show stats process memory allocated [process-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| average-type-name | The name of the average type: long-term vs. recent (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| thread-name | The name of the thread (comma-separated list) | ##### Positional Arguments @@ -76847,14 +77834,14 @@ show stats process thread queue delay [process-name ] [thread-name | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -## `show stats process thread queue depth` +## `show stats process memory heap-size` -The number of tasks in the thread-queue waiting to be executed +Number of bytes allocated to the heap #### Usage ``` -show stats process thread queue depth [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process memory heap-size [process-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76866,7 +77853,6 @@ show stats process thread queue depth [process-name ] [thread-name | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| thread-name | The name of the thread (comma-separated list) | ##### Positional Arguments @@ -76880,14 +77866,14 @@ show stats process thread queue depth [process-name ] [thread-name | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -## `show stats process thread queue total` +## `show stats process memory rss` -The lifetime total number of tasks sent through the thread-queue (in-memory) +Resident memory used per process (bytes) #### Usage ``` -show stats process thread queue total [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process memory rss [process-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76899,7 +77885,6 @@ show stats process thread queue total [process-name ] [thread-name | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| thread-name | The name of the thread (comma-separated list) | ##### Positional Arguments @@ -76913,18 +77898,215 @@ show stats process thread queue total [process-name ] [thread-name | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -#### Description +## `show stats process memory tc-malloc` -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +Statistics for 'tc-malloc' -## `show stats process thread task` +#### Usage -Metrics about tasks in threads in SSR processes +``` +show stats process memory tc-malloc [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`current-total-thread-cache`](#show-stats-process-memory-tc-malloc-current-total-thread-cache) | Number of (some of the) bytes tc-malloc is using for small objects | +| [`max-total-thread-cache`](#show-stats-process-memory-tc-malloc-max-total-thread-cache) | Number of bytes tc-malloc dedicates for small objects | +| [`page-heap-free`](#show-stats-process-memory-tc-malloc-page-heap-free) | Number of bytes in free, mapped pages in the page heap | +| [`page-heap-unmapped`](#show-stats-process-memory-tc-malloc-page-heap-unmapped) | Number of bytes in free, unmapped pages in the page heap | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process memory tc-malloc current-total-thread-cache` + +Number of (some of the) bytes tc-malloc is using for small objects #### Usage ``` -show stats process thread task [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process memory tc-malloc current-total-thread-cache [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process memory tc-malloc max-total-thread-cache` + +Number of bytes tc-malloc dedicates for small objects + +#### Usage + +``` +show stats process memory tc-malloc max-total-thread-cache [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process memory tc-malloc page-heap-free` + +Number of bytes in free, mapped pages in the page heap + +#### Usage + +``` +show stats process memory tc-malloc page-heap-free [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process memory tc-malloc page-heap-unmapped` + +Number of bytes in free, unmapped pages in the page heap + +#### Usage + +``` +show stats process memory tc-malloc page-heap-unmapped [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process memory vsz` + +Virtual memory used per process (bytes) + +#### Usage + +``` +show stats process memory vsz [process-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process mutex` + +Metrics about mutexes in SSR processes + +#### Usage + +``` +show stats process mutex [process-name ] [mutex-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76932,6 +78114,7 @@ show stats process thread task [process-name ] [thread-name ] [thread-name ] [thread-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process mutex thread [process-name ] [mutex-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -76974,6 +78154,7 @@ show stats process thread task errors [process-name ] [thread-name | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| mutex-name | The name of the mutex measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | @@ -76986,37 +78167,78 @@ show stats process thread task errors [process-name ] [thread-name | ---- | ----------- | | verbosity | detail \| summary \| debug (default: detail) | +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`locked`](#show-stats-process-mutex-thread-locked) | The number of times the mutex was locked in the thread per time period | +| [`locked-duration-average`](#show-stats-process-mutex-thread-locked-duration-average) | The average duration the mutex was locked for in the thread per time period (us) | +| [`locked-duration-buckets`](#show-stats-process-mutex-thread-locked-duration-buckets) | The number of times the mutex was locked in the thread per time period, broken down by duration buckets | +| [`locked-duration-total`](#show-stats-process-mutex-thread-locked-duration-total) | The total duration the mutex was locked for in the thread per time period (us) | +| [`locking-delay-average`](#show-stats-process-mutex-thread-locking-delay-average) | The average delay time for the mutex to be locked in the thread per time period (us) | +| [`locking-delay-buckets`](#show-stats-process-mutex-thread-locking-delay-buckets) | The number of times the mutex experienced locking delay in the thread per time period, broken down by delay duration buckets (locked) | +| [`locking-delay-total`](#show-stats-process-mutex-thread-locking-delay-total) | The total delay time for the mutex to be locked in the thread per time period (us) | + ##### See Also | command | description | | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -#### Description +## `show stats process mutex thread locked` -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +The number of times the mutex was locked in the thread per time period -## `show stats process thread task execution-time` +#### Usage -The running-average execution times for tasks of the given type on the thread (us) (in-memory) +``` +show stats process mutex thread locked [process-name ] [mutex-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| mutex-name | The name of the mutex measurement (comma-separated list) | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process mutex thread locked-duration-average` + +The average duration the mutex was locked for in the thread per time period (us) #### Usage ``` -show stats process thread task execution-time [process-name ] [thread-name ] [task-type ] [average-type-name ] [since ] [force] [router ] [node ] [] +show stats process mutex thread locked-duration-average [process-name ] [mutex-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments | name | description | | ---- | ----------- | -| average-type-name | The name of the average type: long-term vs. recent (comma-separated list) | | force | Skip confirmation prompt. Only required when targeting all routers | +| mutex-name | The name of the mutex measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| task-type | The type of the task: normal, packet, exclusive, etc. (comma-separated list) | | thread-name | The name of the thread (comma-separated list) | ##### Positional Arguments @@ -77031,18 +78253,49 @@ show stats process thread task execution-time [process-name ] [thr | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -#### Description +## `show stats process mutex thread locked-duration-buckets` -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +The number of times the mutex was locked in the thread per time period, broken down by duration buckets -## `show stats process thread task timeouts` +#### Usage -The total number of tasks that timed out on the thread (in-memory) +``` +show stats process mutex thread locked-duration-buckets [process-name ] [mutex-name ] [thread-name ] [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| mutex-name | The name of the mutex measurement (comma-separated list) | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process mutex thread locked-duration-total` + +The total duration the mutex was locked for in the thread per time period (us) #### Usage ``` -show stats process thread task timeouts [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +show stats process mutex thread locked-duration-total [process-name ] [mutex-name ] [thread-name ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -77050,6 +78303,7 @@ show stats process thread task timeouts [process-name ] [thread-na | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| mutex-name | The name of the mutex measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | @@ -77068,18 +78322,48 @@ show stats process thread task timeouts [process-name ] [thread-na | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -#### Description +## `show stats process mutex thread locking-delay-average` -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +The average delay time for the mutex to be locked in the thread per time period (us) -## `show stats process thread task total` +#### Usage -The lifetime total number of tasks of the given type executed on the thread (in-memory) +``` +show stats process mutex thread locking-delay-average [process-name ] [mutex-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| mutex-name | The name of the mutex measurement (comma-separated list) | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process mutex thread locking-delay-buckets` + +The number of times the mutex experienced locking delay in the thread per time period, broken down by delay duration buckets (locked) #### Usage ``` -show stats process thread task total [process-name ] [thread-name ] [task-type ] [since ] [force] [router ] [node ] [] +show stats process mutex thread locking-delay-buckets [process-name ] [mutex-name ] [thread-name ] [measurement ] [since ] [force] [router ] [node ] [] ``` ##### Keyword Arguments @@ -77087,11 +78371,12 @@ show stats process thread task total [process-name ] [thread-name | name | description | | ---- | ----------- | | force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| mutex-name | The name of the mutex measurement (comma-separated list) | | node | The name of the node generating this metric | | process-name | The name of the process (comma-separated list) | | router | The router for which to display stats (default: <current router>) | | since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | -| task-type | The type of the task: normal, packet, exclusive, etc. (comma-separated list) | | thread-name | The name of the thread (comma-separated list) | ##### Positional Arguments @@ -77106,9 +78391,1836 @@ show stats process thread task total [process-name ] [thread-name | ------- | ----------- | | [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | -#### Description +## `show stats process mutex thread locking-delay-total` -For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ +The total delay time for the mutex to be locked in the thread per time period (us) + +#### Usage + +``` +show stats process mutex thread locking-delay-total [process-name ] [mutex-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| mutex-name | The name of the mutex measurement (comma-separated list) | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread` + +Metrics about threads in SSR processes + +#### Usage + +``` +show stats process thread [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`cpu`](#show-stats-process-thread-cpu) | Metrics about CPU usage of threads in SSR processes | +| [`queue`](#show-stats-process-thread-queue) | Metrics about queues in threads in SSR processes | +| [`task`](#show-stats-process-thread-task) | Metrics about tasks in threads in SSR processes | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread cpu` + +Metrics about CPU usage of threads in SSR processes + +#### Usage + +``` +show stats process thread cpu [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`iowait`](#show-stats-process-thread-cpu-iowait) | Percentage of time used in a thread waiting for input/output (percentage) | +| [`system-usage`](#show-stats-process-thread-cpu-system-usage) | System-level CPU percentage used in a thread | +| [`usage`](#show-stats-process-thread-cpu-usage) | CPU percentage used in a thread for both user and system | +| [`user-usage`](#show-stats-process-thread-cpu-user-usage) | User-level CPU percentage used in a thread | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread cpu iowait` + +Percentage of time used in a thread waiting for input/output (percentage) + +#### Usage + +``` +show stats process thread cpu iowait [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread cpu system-usage` + +System-level CPU percentage used in a thread + +#### Usage + +``` +show stats process thread cpu system-usage [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread cpu usage` + +CPU percentage used in a thread for both user and system + +#### Usage + +``` +show stats process thread cpu usage [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread cpu user-usage` + +User-level CPU percentage used in a thread + +#### Usage + +``` +show stats process thread cpu user-usage [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread queue` + +Metrics about queues in threads in SSR processes + +#### Usage + +``` +show stats process thread queue [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`delay`](#show-stats-process-thread-queue-delay) | The running-average delays for tasks in the thread-queue (us) | +| [`depth`](#show-stats-process-thread-queue-depth) | The number of tasks in the thread-queue waiting to be executed | +| [`total`](#show-stats-process-thread-queue-total) | The lifetime total number of tasks sent through the thread-queue (in-memory) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread queue delay` + +The running-average delays for tasks in the thread-queue (us) + +#### Usage + +``` +show stats process thread queue delay [process-name ] [thread-name ] [average-type-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| average-type-name | The name of the average type: long-term vs. recent (comma-separated list) | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread queue depth` + +The number of tasks in the thread-queue waiting to be executed + +#### Usage + +``` +show stats process thread queue depth [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread queue total` + +The lifetime total number of tasks sent through the thread-queue (in-memory) + +#### Usage + +``` +show stats process thread queue total [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats process thread task` + +Metrics about tasks in threads in SSR processes + +#### Usage + +``` +show stats process thread task [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`errors`](#show-stats-process-thread-task-errors) | The total number of failed tasks on the thread (in-memory) | +| [`execution-time`](#show-stats-process-thread-task-execution-time) | The running-average execution times for tasks of the given type on the thread (us) (in-memory) | +| [`timeouts`](#show-stats-process-thread-task-timeouts) | The total number of tasks that timed out on the thread (in-memory) | +| [`total`](#show-stats-process-thread-task-total) | The lifetime total number of tasks of the given type executed on the thread (in-memory) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +## `show stats process thread task errors` + +The total number of failed tasks on the thread (in-memory) + +#### Usage + +``` +show stats process thread task errors [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats process thread task execution-time` + +The running-average execution times for tasks of the given type on the thread (us) (in-memory) + +#### Usage + +``` +show stats process thread task execution-time [process-name ] [thread-name ] [task-type ] [average-type-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| average-type-name | The name of the average type: long-term vs. recent (comma-separated list) | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| task-type | The type of the task: normal, packet, exclusive, etc. (comma-separated list) | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats process thread task timeouts` + +The total number of tasks that timed out on the thread (in-memory) + +#### Usage + +``` +show stats process thread task timeouts [process-name ] [thread-name ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats process thread task total` + +The lifetime total number of tasks of the given type executed on the thread (in-memory) + +#### Usage + +``` +show stats process thread task total [process-name ] [thread-name ] [task-type ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| node | The name of the node generating this metric | +| process-name | The name of the process (comma-separated list) | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | +| task-type | The type of the task: normal, packet, exclusive, etc. (comma-separated list) | +| thread-name | The name of the thread (comma-separated list) | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### See Also + +| command | description | +| ------- | ----------- | +| [`show system processes`](cli_reference.md#show-system-processes) | Display a table summarizing the statuses of processes. | + +#### Description + +For more information regarding in-memory metrics, please refer to this retention document - https://www.juniper.net/documentation/us/en/software/session-smart-router/docs/config_in-memory_metrics/ + +## `show stats processing-time` + +Statistics pertaining to the time spent processing packets across the highway manager pipeline + +#### Usage + +``` +show stats processing-time [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`scheduled`](#show-stats-processing-time-scheduled) | Stats pertaining to the time packets spent waiting to be scheduled for processing | +| [`total`](#show-stats-processing-time-total) | Stats pertaining to the total time from wire arrival to wire departure | +| [`working`](#show-stats-processing-time-working) | Stats pertaining to the time packets spent actively being processed | + +## `show stats processing-time scheduled` + +Stats pertaining to the time packets spent waiting to be scheduled for processing + +#### Usage + +``` +show stats processing-time scheduled [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`arp`](#show-stats-processing-time-scheduled-arp) | Stats pertaining to the time packets spent waiting to be scheduled in the arp queue | +| [`bfd`](#show-stats-processing-time-scheduled-bfd) | Stats pertaining to the time packets spent waiting to be scheduled in the bfd queue | +| [`dhcp`](#show-stats-processing-time-scheduled-dhcp) | Stats pertaining to the time packets spent waiting to be scheduled in the dhcp queue | +| [`diverted`](#show-stats-processing-time-scheduled-diverted) | Stats pertaining to the time packets spent waiting to be scheduled in the diverted queue | +| [`dpi`](#show-stats-processing-time-scheduled-dpi) | Stats pertaining to the time packets spent waiting to be scheduled in the dpi queue | +| [`external-protocol`](#show-stats-processing-time-scheduled-external-protocol) | Stats pertaining to the time packets spent waiting to be scheduled in the external-protocol queue | +| [`firewall-detector`](#show-stats-processing-time-scheduled-firewall-detector) | Stats pertaining to the time packets spent waiting to be scheduled in the firewall-detector queue | +| [`icmp`](#show-stats-processing-time-scheduled-icmp) | Stats pertaining to the time packets spent waiting to be scheduled in the icmp queue | +| [`lldp`](#show-stats-processing-time-scheduled-lldp) | Stats pertaining to the time packets spent waiting to be scheduled in the lldp queue | +| [`service-area`](#show-stats-processing-time-scheduled-service-area) | Stats pertaining to the time packets spent waiting to be scheduled in the service-area queue | +| [`trace-route`](#show-stats-processing-time-scheduled-trace-route) | Stats pertaining to the time packets spent waiting to be scheduled in the trace-route queue | +| [`vrrp`](#show-stats-processing-time-scheduled-vrrp) | Stats pertaining to the time packets spent waiting to be scheduled in the vrrp queue | + +## `show stats processing-time scheduled arp` + +Stats pertaining to the time packets spent waiting to be scheduled in the arp queue + +#### Usage + +``` +show stats processing-time scheduled arp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled bfd` + +Stats pertaining to the time packets spent waiting to be scheduled in the bfd queue + +#### Usage + +``` +show stats processing-time scheduled bfd [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled dhcp` + +Stats pertaining to the time packets spent waiting to be scheduled in the dhcp queue + +#### Usage + +``` +show stats processing-time scheduled dhcp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled diverted` + +Stats pertaining to the time packets spent waiting to be scheduled in the diverted queue + +#### Usage + +``` +show stats processing-time scheduled diverted [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled dpi` + +Stats pertaining to the time packets spent waiting to be scheduled in the dpi queue + +#### Usage + +``` +show stats processing-time scheduled dpi [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled external-protocol` + +Stats pertaining to the time packets spent waiting to be scheduled in the external-protocol queue + +#### Usage + +``` +show stats processing-time scheduled external-protocol [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled firewall-detector` + +Stats pertaining to the time packets spent waiting to be scheduled in the firewall-detector queue + +#### Usage + +``` +show stats processing-time scheduled firewall-detector [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled icmp` + +Stats pertaining to the time packets spent waiting to be scheduled in the icmp queue + +#### Usage + +``` +show stats processing-time scheduled icmp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled lldp` + +Stats pertaining to the time packets spent waiting to be scheduled in the lldp queue + +#### Usage + +``` +show stats processing-time scheduled lldp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled service-area` + +Stats pertaining to the time packets spent waiting to be scheduled in the service-area queue + +#### Usage + +``` +show stats processing-time scheduled service-area [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled trace-route` + +Stats pertaining to the time packets spent waiting to be scheduled in the trace-route queue + +#### Usage + +``` +show stats processing-time scheduled trace-route [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time scheduled vrrp` + +Stats pertaining to the time packets spent waiting to be scheduled in the vrrp queue + +#### Usage + +``` +show stats processing-time scheduled vrrp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total` + +Stats pertaining to the total time from wire arrival to wire departure + +#### Usage + +``` +show stats processing-time total [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`application-director`](#show-stats-processing-time-total-application-director) | Statistics for 'application-director' | +| [`arp`](#show-stats-processing-time-total-arp) | Stats pertaining to the total time packets spent in the arp queue from wire to wire | +| [`bfd`](#show-stats-processing-time-total-bfd) | Stats pertaining to the total time packets spent in the bfd queue from wire to wire | +| [`dhcp`](#show-stats-processing-time-total-dhcp) | Stats pertaining to the total time packets spent in the dhcp queue from wire to wire | +| [`diverted`](#show-stats-processing-time-total-diverted) | Stats pertaining to the total time packets spent in the diverted queue from wire to wire | +| [`dpi`](#show-stats-processing-time-total-dpi) | Stats pertaining to the total time packets spent in the dpi queue from wire to wire | +| [`external-protocol`](#show-stats-processing-time-total-external-protocol) | Stats pertaining to the total time packets spent in the external-protocol queue from wire to wire | +| [`firewall-detector`](#show-stats-processing-time-total-firewall-detector) | Stats pertaining to the total time packets spent in the firewall-detector queue from wire to wire | +| [`icmp`](#show-stats-processing-time-total-icmp) | Stats pertaining to the total time packets spent in the icmp queue from wire to wire | +| [`lldp`](#show-stats-processing-time-total-lldp) | Stats pertaining to the total time packets spent in the lldp queue from wire to wire | +| [`service-area`](#show-stats-processing-time-total-service-area) | Stats pertaining to the total time packets spent in the service-area queue from wire to wire | +| [`trace-route`](#show-stats-processing-time-total-trace-route) | Stats pertaining to the total time packets spent in the trace-route queue from wire to wire | +| [`vrrp`](#show-stats-processing-time-total-vrrp) | Stats pertaining to the total time packets spent in the vrrp queue from wire to wire | + +## `show stats processing-time total application-director` + +Statistics for 'application-director' + +#### Usage + +``` +show stats processing-time total application-director [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`lookup`](#show-stats-processing-time-total-application-director-lookup) | Statistics for 'lookup' | + +## `show stats processing-time total application-director lookup` + +Statistics for 'lookup' + +#### Usage + +``` +show stats processing-time total application-director lookup [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`failure`](#show-stats-processing-time-total-application-director-lookup-failure) | Stats pertaining to the async round-trip time of Application Director HTTP lookups that returned a non-200 non-404 HTTP error within the app-id processing path (packets) | +| [`miss`](#show-stats-processing-time-total-application-director-lookup-miss) | Stats pertaining to the async round-trip time of Application Director HTTP lookups that returned HTTP 404 Not Found within the app-id processing path (packets) | +| [`success`](#show-stats-processing-time-total-application-director-lookup-success) | Stats pertaining to the async round-trip time of Application Director HTTP lookups that returned HTTP 200 and were successfully written to cache within the app-id processing path (packets) | + +## `show stats processing-time total application-director lookup failure` + +Stats pertaining to the async round-trip time of Application Director HTTP lookups that returned a non-200 non-404 HTTP error within the app-id processing path (packets) + +#### Usage + +``` +show stats processing-time total application-director lookup failure [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total application-director lookup miss` + +Stats pertaining to the async round-trip time of Application Director HTTP lookups that returned HTTP 404 Not Found within the app-id processing path (packets) + +#### Usage + +``` +show stats processing-time total application-director lookup miss [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total application-director lookup success` + +Stats pertaining to the async round-trip time of Application Director HTTP lookups that returned HTTP 200 and were successfully written to cache within the app-id processing path (packets) + +#### Usage + +``` +show stats processing-time total application-director lookup success [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total arp` + +Stats pertaining to the total time packets spent in the arp queue from wire to wire + +#### Usage + +``` +show stats processing-time total arp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total bfd` + +Stats pertaining to the total time packets spent in the bfd queue from wire to wire + +#### Usage + +``` +show stats processing-time total bfd [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total dhcp` + +Stats pertaining to the total time packets spent in the dhcp queue from wire to wire + +#### Usage + +``` +show stats processing-time total dhcp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total diverted` + +Stats pertaining to the total time packets spent in the diverted queue from wire to wire + +#### Usage + +``` +show stats processing-time total diverted [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total dpi` + +Stats pertaining to the total time packets spent in the dpi queue from wire to wire + +#### Usage + +``` +show stats processing-time total dpi [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total external-protocol` + +Stats pertaining to the total time packets spent in the external-protocol queue from wire to wire + +#### Usage + +``` +show stats processing-time total external-protocol [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total firewall-detector` + +Stats pertaining to the total time packets spent in the firewall-detector queue from wire to wire + +#### Usage + +``` +show stats processing-time total firewall-detector [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total icmp` + +Stats pertaining to the total time packets spent in the icmp queue from wire to wire + +#### Usage + +``` +show stats processing-time total icmp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total lldp` + +Stats pertaining to the total time packets spent in the lldp queue from wire to wire + +#### Usage + +``` +show stats processing-time total lldp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total service-area` + +Stats pertaining to the total time packets spent in the service-area queue from wire to wire + +#### Usage + +``` +show stats processing-time total service-area [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total trace-route` + +Stats pertaining to the total time packets spent in the trace-route queue from wire to wire + +#### Usage + +``` +show stats processing-time total trace-route [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time total vrrp` + +Stats pertaining to the total time packets spent in the vrrp queue from wire to wire + +#### Usage + +``` +show stats processing-time total vrrp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working` + +Stats pertaining to the time packets spent actively being processed + +#### Usage + +``` +show stats processing-time working [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`arp`](#show-stats-processing-time-working-arp) | Stats pertaining to the time packets spent being processed in the arp queue | +| [`bfd`](#show-stats-processing-time-working-bfd) | Stats pertaining to the time packets spent being processed in the bfd queue | +| [`dhcp`](#show-stats-processing-time-working-dhcp) | Stats pertaining to the time packets spent being processed in the dhcp queue | +| [`diverted`](#show-stats-processing-time-working-diverted) | Stats pertaining to the time packets spent being processed in the diverted queue | +| [`dpi`](#show-stats-processing-time-working-dpi) | Stats pertaining to the time packets spent being processed in the dpi queue | +| [`external-protocol`](#show-stats-processing-time-working-external-protocol) | Stats pertaining to the time packets spent being processed in the external-protocol queue | +| [`firewall-detector`](#show-stats-processing-time-working-firewall-detector) | Stats pertaining to the time packets spent being processed in the firewall-detector queue | +| [`icmp`](#show-stats-processing-time-working-icmp) | Stats pertaining to the time packets spent being processed in the icmp queue | +| [`lldp`](#show-stats-processing-time-working-lldp) | Stats pertaining to the time packets spent being processed in the lldp queue | +| [`service-area`](#show-stats-processing-time-working-service-area) | Stats pertaining to the time packets spent being processed in the service-area queue | +| [`trace-route`](#show-stats-processing-time-working-trace-route) | Stats pertaining to the time packets spent being processed in the trace-route queue | +| [`vrrp`](#show-stats-processing-time-working-vrrp) | Stats pertaining to the time packets spent being processed in the vrrp queue | + +## `show stats processing-time working arp` + +Stats pertaining to the time packets spent being processed in the arp queue + +#### Usage + +``` +show stats processing-time working arp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working bfd` + +Stats pertaining to the time packets spent being processed in the bfd queue + +#### Usage + +``` +show stats processing-time working bfd [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working dhcp` + +Stats pertaining to the time packets spent being processed in the dhcp queue + +#### Usage + +``` +show stats processing-time working dhcp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working diverted` + +Stats pertaining to the time packets spent being processed in the diverted queue + +#### Usage + +``` +show stats processing-time working diverted [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working dpi` + +Stats pertaining to the time packets spent being processed in the dpi queue + +#### Usage + +``` +show stats processing-time working dpi [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working external-protocol` + +Stats pertaining to the time packets spent being processed in the external-protocol queue + +#### Usage + +``` +show stats processing-time working external-protocol [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working firewall-detector` + +Stats pertaining to the time packets spent being processed in the firewall-detector queue + +#### Usage + +``` +show stats processing-time working firewall-detector [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working icmp` + +Stats pertaining to the time packets spent being processed in the icmp queue + +#### Usage + +``` +show stats processing-time working icmp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working lldp` + +Stats pertaining to the time packets spent being processed in the lldp queue + +#### Usage + +``` +show stats processing-time working lldp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working service-area` + +Stats pertaining to the time packets spent being processed in the service-area queue + +#### Usage + +``` +show stats processing-time working service-area [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working trace-route` + +Stats pertaining to the time packets spent being processed in the trace-route queue + +#### Usage + +``` +show stats processing-time working trace-route [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | + +## `show stats processing-time working vrrp` + +Stats pertaining to the time packets spent being processed in the vrrp queue + +#### Usage + +``` +show stats processing-time working vrrp [measurement ] [since ] [force] [router ] [node ] [] +``` + +##### Keyword Arguments + +| name | description | +| ---- | ----------- | +| force | Skip confirmation prompt. Only required when targeting all routers | +| measurement | The measurement being made on by this metric instance (comma-separated list) | +| node | The name of the node generating this metric | +| router | The router for which to display stats (default: <current router>) | +| since | The displayed stats will be calculated as a delta from the given time. The given time can either be a timestamp or a delta, such as 45m, 1d, or 1mo. Providing "launch" ensures that no start time for the delta is set [type: timestamp] | + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| verbosity | detail \| summary \| debug (default: detail) | ## `show stats queue` diff --git a/docs/concepts_machine_communication.md b/docs/concepts_machine_communication.md index c6c027b9b7a..9d34daa9c57 100644 --- a/docs/concepts_machine_communication.md +++ b/docs/concepts_machine_communication.md @@ -87,7 +87,9 @@ Peering SSR routers will perform path MTU discovery on each peer path between ea In order to accommodate these deployments where “ICMP Destination Unreachable - Fragmentation Needed” response messages are not generated (RFC1911 is not followed), three successive non-responses are considered equivalent to ICMP responses for the purposes of driving the algorithm with an inferred MTU. -The discovered MTU is viewable in the output of `show peers`. +The discovered MTU is viewable in the output of `show peers`. + +For additional information, see [Path MTU Discovery](config_pmtu.md). ### Secure Vector Routing Traffic diff --git a/docs/conductor_upgrade.md b/docs/conductor_upgrade.md index ed102a0161f..b3e39258803 100644 --- a/docs/conductor_upgrade.md +++ b/docs/conductor_upgrade.md @@ -130,7 +130,7 @@ While the linux shell is available for upgrading the conductor, it is advised to ## Next Steps -See [Router Interactive Installation](intro_installation_bootable_media.mdx) or [Router Installation Using OTP](intro_otp_iso_install.mdx) for steps to install your routers. +See [Router Interactive Installation](intro_installation_bootable_media.mdx) or [Router Installation Using OTP](intro_otp_iso_install.md) for steps to install your routers. If your deployment will take advantage of Mist Telemetry, see [Enable WAN Assurance on the Conductor](config_wan_assurance.md#enable-wan-assurance-on-the-conductor) for those next steps. diff --git a/docs/config_bgp.md b/docs/config_bgp.md index 2bfa1926228..3df27a083b2 100644 --- a/docs/config_bgp.md +++ b/docs/config_bgp.md @@ -1029,6 +1029,7 @@ There is one additional field which needs to be set in route reflector's BGP con When the route reflector sends routes to the clients, by default it doesn't modify the next-hop. An outbound policy can be used to change the next-hop in these routes to that of the route reflector, if desired. In such instances, another option, which is turned off by default, needs to be set in the route reflector's BGP config: `Route Reflector Allow Outbound Policy = TRUE`. ### BGP Confederations + When configuring iBGP, the **Confederation** feature may be helpful when dealing with an enormous autonomous system. This feature allows you to break up the AS into smaller sub-autonomous systems. Confederation can be directly configured under the routing protocol element. Here, 65535 is the **confederation identifier AS number** and, 1100 and 2200 are the **member AS** numbers of that confederation AS. ``` @@ -1041,3 +1042,145 @@ admin@branchoffice1.seattlesite1 (routing-protocol[type=bgp])# confederation mem admin@branchoffice1.seattlesite1 (routing-protocol[type=bgp])# confederation member-as 2200 admin@branchoffice1.seattlesite1 (routing-protocol[type=bgp])# exit ``` + +## Viewing Filtered BGP Routes + +When an inbound BGP policy rejects prefixes received from a neighbor, those routes do not appear in the BGP table or the FIB. The `filtered-routes` option exposes exactly which prefixes were suppressed by the inbound policy for a given neighbor, making it straightforward to troubleshoot why expected routes are absent from the routing table. + +### Version History + +| Release | Modification | +|---|---| +| 7.2.0 | Feature introduced. | + +### PCLI + +The `filtered-routes` option is available as a third choice alongside `received-routes` and `advertised-routes` in the `show bgp neighbors` command: + +``` +show bgp neighbors [vrf ] filtered-routes [ipv4 | ipv4-vpn | ipv6 | ipv6-vpn] +``` + +**Examples** + +Display filtered routes for a neighbor in the default VRF using IPv4 unicast (the default address family): + +```text +admin@router1.site1# show bgp neighbors 172.16.3.3 filtered-routes +``` + +Display filtered IPv6 routes for a neighbor in a named VRF: + +```text +admin@router1.site1# show bgp neighbors vrf vrfA fd00:5::3 filtered-routes ipv6 +``` + +When no routes have been filtered, the command returns an empty table. When routes are present, the output format mirrors that of `received-routes` and `advertised-routes`. If the neighbor address is unknown, the VRF does not exist, or the address family is invalid, the PCLI surfaces the underlying error string describing the problem. + +### REST API + +A new endpoint mirrors the PCLI functionality: + +``` +GET /api/v1/routing/bgp/neighbors/filtered-routes +``` + +**Query Parameters** + +| Parameter | Required | Default | Description | +|---|---|---|---| +| `neighborAddress` | Yes | — | IP address of the BGP neighbor | +| `vrf` | No | `default` | VRF name | +| `addressFamily` | No | `ipv4` | Address family: `ipv4`, `ipv4-vpn`, `ipv6`, or `ipv6-vpn` | +| `firstIndex` | No | `0` | Zero-based starting index for paginated results | +| `elementCount` | No | all | Maximum number of routes to return (range: 1–5000) | + +:::note +The REST endpoint does not support `vrf all` or `addressFamily all`. Each VRF and address family must be queried individually. +::: + +**Example: IPv4, default VRF** + +```bash +curl --unix-socket /var/run/128technology/speakeasy.sock -i -XGET \ + 'http://localhost/api/v1/routing/bgp/neighbors/filtered-routes?neighborAddress=172.16.3.3&firstIndex=0&elementCount=1' +``` + +Response: + +```json +{ + "bgpTableVersion": 14, + "bgpLocalRouterId": "2.1.1.1", + "defaultLocPrf": 100, + "localAS": 2, + "bgpStatusCodes": { + "suppressed": "s", "damped": "d", "history": "h", + "valid": "*", "best": ">", "multipath": "=", + "internal": "i", "ribFailure": "r", "stale": "S", "removed": "R" + }, + "bgpOriginCodes": { "igp": "i", "egp": "e", "incomplete": "?" }, + "filteredRoutes": [ + { + "prefix": "10.99.1.0/24", + "network": "10.99.1.0/24", + "nextHop": "172.16.3.2", + "metric": 0, + "weight": 0, + "path": "3", + "bgpOriginCode": "?", + "valid": true, + "best": true + } + ], + "totalPrefixCounter": 1, + "filteredPrefixCounter": 0, + "nextEntry": 1 +} +``` + +**Example: IPv6, named VRF** + +```bash +curl --unix-socket /var/run/128technology/speakeasy.sock -i -XGET \ + 'http://localhost/api/v1/routing/bgp/neighbors/filtered-routes?neighborAddress=fd00:5::3&firstIndex=0&elementCount=1&addressFamily=ipv6&vrf=vrfA' +``` + +Response: + +```json +{ + "bgpTableVersion": 1, + "bgpLocalRouterId": "2.1.1.1", + "defaultLocPrf": 100, + "localAS": 2, + "filteredRoutes": [ + { + "prefix": "2001:db8:5::1/128", + "network": "2001:db8:5::1/128", + "nextHopGlobal": "fd00:5::3", + "metric": 0, + "weight": 0, + "path": "3", + "bgpOriginCode": "?", + "valid": true, + "best": true + } + ], + "totalPrefixCounter": 1, + "filteredPrefixCounter": 0, + "nextEntry": 1 +} +``` + +### Troubleshooting + +| Failure | PCLI behavior | REST behavior | +|---|---|---| +| `bgpd` not running | Surfaces vty error string | Returns standard upstream failure with informative status code | +| Unknown neighbor IP, neighbor not in specified VRF/address family | Surfaces vty error string with neighbor details | Returns `200 OK` with a `warning` key in the JSON body | +| Invalid `addressFamily` or `vrf` argument | Surfaces vty error string | Returns `200 OK` with a `warning` key in the JSON body | +| vty call timeout (120 s) | Surfaces timeout error string | Returns `HTTP 400` with timeout exception message | + +PCLI and REST activity is logged in `routingManager.log`. FRR vty-level logs are in `routingEngine.log`. + diff --git a/docs/config_command_guide.md b/docs/config_command_guide.md index 6523483c6c9..0001c6d4cce 100755 --- a/docs/config_command_guide.md +++ b/docs/config_command_guide.md @@ -38,6 +38,7 @@ Authority configuration is the top-most level in the SSR configuration hierarchy | [`management-service-generation`](#configure-authority-management-service-generation) | Configure Management Service Generation | | [`metrics`](#configure-authority-metrics) | Configuration for metrics collection. | | [`metrics-profile`](#configure-authority-metrics-profile) | A collection of metrics | +| [`minion-watchdog-settings`](#configure-authority-minion-watchdog-settings) | Settings for monitoring and remediating a wedged salt-minion. | | [`name`](#configure-authority-name) | The identifier for the Authority. | | `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | | [`password-policy`](#configure-authority-password-policy) | Password policy for user's passwords. | @@ -62,6 +63,7 @@ Authority configuration is the top-most level in the SSR configuration hierarchy | `show` | Show configuration data for 'authority' | | [`software-access`](#configure-authority-software-access) | Configuration for SSR software access for the authority. Supported on managed assets only. | | [`software-update`](#configure-authority-software-update) | Configure Software Update | +| [`ssl-proxy-profile`](#configure-authority-ssl-proxy-profile) | User defined SSL proxy profiles. | | [`step`](#configure-authority-step) | Configure Step | | [`step-repo`](#configure-authority-step-repo) | List of Service and Topology Exchange Protocol repositories. | | [`syslog-policy`](#configure-authority-syslog-policy) | Configuration for syslog message generation. | @@ -4028,6 +4030,245 @@ A string identifier which only uses alphanumerics, underscores, or dashes, and c Must contain only alphanumeric characters or any of the following: _ - Length: 0-63 +## `configure authority minion-watchdog-settings` + +Settings for monitoring and remediating a wedged salt-minion. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`check-interval`](#configure-authority-minion-watchdog-settings-check-interval) | Interval to check whether the salt-minion is wedged. | +| [`consecutive-failures`](#configure-authority-minion-watchdog-settings-consecutive-failures) | Number of consecutive failures before salt-minion restart. | +| `delete` | Delete configuration data | +| [`enabled`](#configure-authority-minion-watchdog-settings-enabled) | Enable or disable the minion watchdog. | +| [`ha-consecutive-failures`](#configure-authority-minion-watchdog-settings-ha-consecutive-failures) | The number of consecutive failures for HA conductor alarms recorded before salt-minion restart. | +| [`job-timeout`](#configure-authority-minion-watchdog-settings-job-timeout) | Timeout before a running job is considered stuck and the minion is restarted. | +| [`log-level`](#configure-authority-minion-watchdog-settings-log-level) | Watchdog log level. | +| [`max-memory`](#configure-authority-minion-watchdog-settings-max-memory) | Maximum memory threshold the salt-minion is allowed to consume. | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`override-master-count`](#configure-authority-minion-watchdog-settings-override-master-count) | Override expected number of salt-master connections instead of auto-detecting from the salt-minion configuration file. | +| `show` | Show configuration data for 'minion-watchdog-settings' | + +## `configure authority minion-watchdog-settings check-interval` + +Interval to check whether the salt-minion is wedged. + +#### Usage + +``` +configure authority minion-watchdog-settings check-interval [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint8 | The value to set for this field | + +#### Description + +Units: minutes + +Default: 3 + +##### uint8 + +An unsigned 8-bit integer. + +Range: 1-10 + +## `configure authority minion-watchdog-settings consecutive-failures` + +Number of consecutive failures before salt-minion restart. + +#### Usage + +``` +configure authority minion-watchdog-settings consecutive-failures [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint16 | The value to set for this field | + +#### Description + +Default: 20 + +##### uint16 + +An unsigned 16-bit integer. + +Range: 1-1000 + +## `configure authority minion-watchdog-settings enabled` + +Enable or disable the minion watchdog. + +#### Usage + +``` +configure authority minion-watchdog-settings enabled [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| boolean | The value to set for this field | + +#### Description + +Default: true + +##### boolean + +A true or false value. + +Options: true or false + +## `configure authority minion-watchdog-settings ha-consecutive-failures` + +The number of consecutive failures for HA conductor alarms recorded before salt-minion restart. + +#### Usage + +``` +configure authority minion-watchdog-settings ha-consecutive-failures [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint16 | The value to set for this field | + +#### Description + +Default: 30 + +##### uint16 + +An unsigned 16-bit integer. + +Range: 1-1000 + +## `configure authority minion-watchdog-settings job-timeout` + +Timeout before a running job is considered stuck and the minion is restarted. + +#### Usage + +``` +configure authority minion-watchdog-settings job-timeout [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint16 | The value to set for this field | + +#### Description + +Units: minutes + +Default: 60 + +##### uint16 + +An unsigned 16-bit integer. + +Range: 1-1440 + +## `configure authority minion-watchdog-settings log-level` + +Watchdog log level. + +#### Usage + +``` +configure authority minion-watchdog-settings log-level [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| log-level | The value to set for this field | + +#### Description + +Default: info + +##### log-level (enumeration) + +Log levels + +Options: + +- fatal: Only record log messages with level "fatal" or higher. +- error: Only record log messages with level "error" or higher. +- warning: Only record log messages with level "warning" or higher. +- info: Only record log messages with level "info" or higher. +- debug: Only record log messages with level "debug" or higher. +- trace: Only record log messages with level "trace" or higher. + +## `configure authority minion-watchdog-settings max-memory` + +Maximum memory threshold the salt-minion is allowed to consume. + +#### Usage + +``` +configure authority minion-watchdog-settings max-memory [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint16 | The value to set for this field | + +#### Description + +Units: MB + +Default: 1000 + +##### uint16 + +An unsigned 16-bit integer. + +Range: 500-5000 + +## `configure authority minion-watchdog-settings override-master-count` + +Override expected number of salt-master connections instead of auto-detecting from the salt-minion configuration file. + +#### Usage + +``` +configure authority minion-watchdog-settings override-master-count [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint8 | The value to set for this field | + +#### Description + +##### uint8 + +An unsigned 8-bit integer. + +Range: 0-2 + ## `configure authority name` The identifier for the Authority. @@ -5123,7 +5364,7 @@ Configure Application Identification | command | description | | ------- | ----------- | -| [`application-director-cache-max-capacity`](#configure-authority-router-application-identification-application-director-cache-max-capacity) | The maximum capacity for caching application-director requests | +| [`application-director-cache-max-capacity`](#configure-authority-router-application-identification-application-director-cache-max-capacity) | The maximum capacity for caching application-director requests. Set to 'auto' to scale with platform size. | | [`auto-update`](#configure-authority-router-application-identification-auto-update) | Automatic updating of application data | | `delete` | Delete configuration data | | [`max-capacity`](#configure-authority-router-application-identification-max-capacity) | The maximum capacity for resolved next-hops under a client | @@ -5140,28 +5381,38 @@ Configure Application Identification ## `configure authority router application-identification application-director-cache-max-capacity` -The maximum capacity for caching application-director requests +The maximum capacity for caching application-director requests. Set to 'auto' to scale with platform size. #### Usage ``` -configure authority router application-identification application-director-cache-max-capacity [] +configure authority router application-identification application-director-cache-max-capacity [] ``` ##### Positional Arguments | name | description | | ---- | ----------- | -| uint64 | The value to set for this field | +| union | The value to set for this field | #### Description -Default: 10000 +Default: auto -##### uint64 +##### union + +A value that corresponds to one of its member types. + +Must be one of the following types: + +##### (0) uint64 An unsigned 64-bit integer. +##### (1) string + +A text value. + ## `configure authority router application-identification auto-update` Automatic updating of application data @@ -5566,7 +5817,7 @@ Configure Classify Session | command | description | | ------- | ----------- | | `delete` | Delete configuration data | -| [`max-cache-size`](#configure-authority-router-application-identification-web-filtering-classify-session-max-cache-size) | The maximum size for the in-memory cache that stores url data | +| [`max-cache-size`](#configure-authority-router-application-identification-web-filtering-classify-session-max-cache-size) | The maximum size for the in-memory cache that stores url data. Set to `auto` to scale with platform size. | | `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | | [`retries`](#configure-authority-router-application-identification-web-filtering-classify-session-retries) | The maximum retries for client to request for classifying the session | | `show` | Show configuration data for 'classify-session' | @@ -5574,30 +5825,40 @@ Configure Classify Session ## `configure authority router application-identification web-filtering classify-session max-cache-size` -The maximum size for the in-memory cache that stores url data +The maximum size for the in-memory cache that stores url data. Set to `auto` to scale with platform size. #### Usage ``` -configure authority router application-identification web-filtering classify-session max-cache-size [] +configure authority router application-identification web-filtering classify-session max-cache-size [] ``` ##### Positional Arguments | name | description | | ---- | ----------- | -| uint32 | The value to set for this field | +| union | The value to set for this field | #### Description -Default: 1000 +Default: auto -##### uint32 +##### union + +A value that corresponds to one of its member types. + +Must be one of the following types: + +##### (0) uint32 An unsigned 32-bit integer. Range: 1-500000 +##### (1) string + +A text value. + ## `configure authority router application-identification web-filtering classify-session retries` The maximum retries for client to request for classifying the session @@ -8276,20 +8537,23 @@ The interface name associated with the OS network device. #### Usage ``` -configure authority router node device-interface interface-name [] +configure authority router node device-interface interface-name [] ``` ##### Positional Arguments | name | description | | ---- | ----------- | -| string | The value to set for this field | +| interface-name | The value to set for this field | #### Description -##### string +##### interface-name (string) -A text value. +A string identifier for network-interface which only uses alphanumerics, underscores, dashes, dots, or slashes, and cannot exceed 63 characters. + +Must contain only alphanumeric characters or any of the following: _ - . +Length: 0-63 ## `configure authority router node device-interface link-settings` @@ -8901,6 +9165,7 @@ configure authority router node device-interface network-interface address host- | `clone` | Clone a list item | | `delete` | Delete configuration data | | [`description`](#configure-authority-router-node-device-interface-network-interface-address-host-service-description) | A description about the hosted service. | +| [`dhcp-server-debug-log`](#configure-authority-router-node-device-interface-network-interface-address-host-service-dhcp-server-debug-log) | Whether to log DHCP server debug messages. | | [`echo-client-id`](#configure-authority-router-node-device-interface-network-interface-address-host-service-echo-client-id) | Whether the client id should be echoed in DHCP server responses as specified in RFC 6842 or not as specified in the original RFC 2131. | | [`enabled`](#configure-authority-router-node-device-interface-network-interface-address-host-service-enabled) | Enable/disable for host services | | [`max-lease-time`](#configure-authority-router-node-device-interface-network-interface-address-host-service-max-lease-time) | Maximum lease time for leases allocated to clients. | @@ -8909,6 +9174,7 @@ configure authority router node device-interface network-interface address host- | [`service-type`](#configure-authority-router-node-device-interface-network-interface-address-host-service-service-type) | The type of hosted service | | `show` | Show configuration data for 'host-service' | | [`static-assignment`](#configure-authority-router-node-device-interface-network-interface-address-host-service-static-assignment) | Static assignment(s) for DHCP configuration for a specific client | +| [`subnet-options`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options) | The DHCP server options for subnet. | | [`transport`](#configure-authority-router-node-device-interface-network-interface-address-host-service-transport) | The transport protocol(s) and port(s) for the service. | ## `configure authority router node device-interface network-interface address host-service access-policy` @@ -11332,6 +11598,32 @@ configure authority router node device-interface network-interface address host- A text value. +## `configure authority router node device-interface network-interface address host-service dhcp-server-debug-log` + +Whether to log DHCP server debug messages. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service dhcp-server-debug-log [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| boolean | The value to set for this field | + +#### Description + +Default: false + +##### boolean + +A true or false value. + +Options: true or false + ## `configure authority router node device-interface network-interface address host-service echo-client-id` Whether the client id should be echoed in DHCP server responses as specified in RFC 6842 or not as specified in the original RFC 2131. @@ -12583,6 +12875,976 @@ The order of elements matters. A text value. +## `configure authority router node device-interface network-interface address host-service subnet-options` + +The DHCP server options for subnet. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `clone` | Clone a list item | +| [`custom`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-custom) | Custom DHCP options to be provided to clients. | +| `delete` | Delete configuration data | +| [`domain-name`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-domain-name) | Domain name provided to clients. | +| [`domain-server`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-domain-server) | Domain name server address(es) provided to clients in priority order. | +| [`interface-mtu`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-interface-mtu) | Interface MTU provided to clients. | +| `move` | Move list items | +| [`ntp-server`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-ntp-server) | NTP server address(es) provided to clients in priority order. | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`pop-server`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-pop-server) | POP server address(es) provided to clients in priority order. | +| [`router`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-router) | Gateway router address(es) provided to clients in priority order. | +| `show` | Show configuration data for 'subnet-options' | +| [`smtp-server`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-smtp-server) | SMTP server address(es) provided to clients in priority order. | +| [`static-route`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-static-route) | Static route(s) provided to clients. Note that for default routes the router option should be used. | +| [`tenant`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-tenant) | Tenant to which clients will be assigned. | +| [`vendor-identifying-vendor-specific-information`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-identifying-vendor-specific-information) | Vendor-Identifying Vendor-Specific Information Options (Option 125) to be provided to clients [RFC3925]. | +| [`vendor-specific-information`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-specific-information) | Vendor-Specific Information Options (Option 43) to be provided to clients [RFC2132]. | + +## `configure authority router node device-interface network-interface address host-service subnet-options custom` + +Custom DHCP options to be provided to clients. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options custom +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| code | The code of the custom DHCP option. | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`code`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-custom-code) | The code of the custom DHCP option. | +| `delete` | Delete configuration data | +| [`description`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-custom-description) | A description of the custom DHCP option. | +| [`encoded-type`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-custom-encoded-type) | The encoded type of the custom option. | +| `move` | Move list items | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`quantity`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-custom-quantity) | The allowed quantity of the custom option values. | +| `show` | Show configuration data for 'custom' | +| [`value`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-custom-value) | The value(s) of custom option to be provided to clients. | + +## `configure authority router node device-interface network-interface address host-service subnet-options custom code` + +The code of the custom DHCP option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options custom code [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint16 | The value to set for this field | + +#### Description + +##### uint16 + +An unsigned 16-bit integer. + +Range: 0-65535 + +## `configure authority router node device-interface network-interface address host-service subnet-options custom description` + +A description of the custom DHCP option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options custom description [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| string | The value to set for this field | + +#### Description + +##### string + +A text value. + +## `configure authority router node device-interface network-interface address host-service subnet-options custom encoded-type` + +The encoded type of the custom option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options custom encoded-type [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| enumeration | The value to set for this field | + +#### Description + +Default: string + +##### enumeration + +A value from a set of predefined names. + +Options: + +- string: +- uint8: +- uint16: +- uint32: +- boolean: +- ipv4-address: +- int32: +- binary: A continuous string of hexadecimal digits with a '0x' prefix. Valid examples are '0xabcdef' and '0x123456'. + +## `configure authority router node device-interface network-interface address host-service subnet-options custom quantity` + +The allowed quantity of the custom option values. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options custom quantity [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| enumeration | The value to set for this field | + +#### Description + +Default: singular + +##### enumeration + +A value from a set of predefined names. + +Options: + +- singular: +- array: + +## `configure authority router node device-interface network-interface address host-service subnet-options custom value` + +The value(s) of custom option to be provided to clients. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options custom value [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| string | Value to add to this list | + +#### Description + +The order of elements matters. + +##### string (required) + +A text value. + +## `configure authority router node device-interface network-interface address host-service subnet-options domain-name` + +Domain name provided to clients. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options domain-name [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| string | The value to set for this field | + +#### Description + +##### string + +A text value. + +## `configure authority router node device-interface network-interface address host-service subnet-options domain-server` + +Domain name server address(es) provided to clients in priority order. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options domain-server [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| ip-address | Value to add to this list | + +#### Description + +The order of elements matters. + +##### ip-address (union) + +The ip-address type represents an IP address and is IP version neutral. The format of the textual representations implies the IP version. + +Must be one of the following types: + +##### (0) ipv4-address (string) + +The ipv4-address type represents an IPv4 address in dotted-quad notation. + +Must be a valid IPv4 address. + +##### (1) ipv6-address (string) + +The ipv6-address type represents an IPv6 address in full, +mixed, shortened, and shortened-mixed notation. + +The canonical format of IPv6 addresses uses the compressed +format described in RFC 4291, Section 2.2, item 2 with the +following additional rules: the :: substitution must be +applied to the longest sequence of all-zero 16-bit chunks +in an IPv6 address. If there is a tie, the first sequence +of all-zero 16-bit chunks is replaced by ::. Single +all-zero 16-bit chunks are not compressed. The canonical +format uses lowercase characters and leading zeros are +not allowed. + +Must be a valid IPv6 address. +Must be a valid IPv6 address. + +## `configure authority router node device-interface network-interface address host-service subnet-options interface-mtu` + +Interface MTU provided to clients. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options interface-mtu [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint16 | The value to set for this field | + +#### Description + +##### uint16 + +An unsigned 16-bit integer. + +Range: 68-9198 + +## `configure authority router node device-interface network-interface address host-service subnet-options ntp-server` + +NTP server address(es) provided to clients in priority order. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options ntp-server [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| ip-address | Value to add to this list | + +#### Description + +The order of elements matters. + +##### ip-address (union) + +The ip-address type represents an IP address and is IP version neutral. The format of the textual representations implies the IP version. + +Must be one of the following types: + +##### (0) ipv4-address (string) + +The ipv4-address type represents an IPv4 address in dotted-quad notation. + +Must be a valid IPv4 address. + +##### (1) ipv6-address (string) + +The ipv6-address type represents an IPv6 address in full, +mixed, shortened, and shortened-mixed notation. + +The canonical format of IPv6 addresses uses the compressed +format described in RFC 4291, Section 2.2, item 2 with the +following additional rules: the :: substitution must be +applied to the longest sequence of all-zero 16-bit chunks +in an IPv6 address. If there is a tie, the first sequence +of all-zero 16-bit chunks is replaced by ::. Single +all-zero 16-bit chunks are not compressed. The canonical +format uses lowercase characters and leading zeros are +not allowed. + +Must be a valid IPv6 address. +Must be a valid IPv6 address. + +## `configure authority router node device-interface network-interface address host-service subnet-options pop-server` + +POP server address(es) provided to clients in priority order. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options pop-server [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| ip-address | Value to add to this list | + +#### Description + +The order of elements matters. + +##### ip-address (union) + +The ip-address type represents an IP address and is IP version neutral. The format of the textual representations implies the IP version. + +Must be one of the following types: + +##### (0) ipv4-address (string) + +The ipv4-address type represents an IPv4 address in dotted-quad notation. + +Must be a valid IPv4 address. + +##### (1) ipv6-address (string) + +The ipv6-address type represents an IPv6 address in full, +mixed, shortened, and shortened-mixed notation. + +The canonical format of IPv6 addresses uses the compressed +format described in RFC 4291, Section 2.2, item 2 with the +following additional rules: the :: substitution must be +applied to the longest sequence of all-zero 16-bit chunks +in an IPv6 address. If there is a tie, the first sequence +of all-zero 16-bit chunks is replaced by ::. Single +all-zero 16-bit chunks are not compressed. The canonical +format uses lowercase characters and leading zeros are +not allowed. + +Must be a valid IPv6 address. +Must be a valid IPv6 address. + +## `configure authority router node device-interface network-interface address host-service subnet-options router` + +Gateway router address(es) provided to clients in priority order. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options router [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| ip-address | Value to add to this list | + +#### Description + +The order of elements matters. + +##### ip-address (union) + +The ip-address type represents an IP address and is IP version neutral. The format of the textual representations implies the IP version. + +Must be one of the following types: + +##### (0) ipv4-address (string) + +The ipv4-address type represents an IPv4 address in dotted-quad notation. + +Must be a valid IPv4 address. + +##### (1) ipv6-address (string) + +The ipv6-address type represents an IPv6 address in full, +mixed, shortened, and shortened-mixed notation. + +The canonical format of IPv6 addresses uses the compressed +format described in RFC 4291, Section 2.2, item 2 with the +following additional rules: the :: substitution must be +applied to the longest sequence of all-zero 16-bit chunks +in an IPv6 address. If there is a tie, the first sequence +of all-zero 16-bit chunks is replaced by ::. Single +all-zero 16-bit chunks are not compressed. The canonical +format uses lowercase characters and leading zeros are +not allowed. + +Must be a valid IPv6 address. +Must be a valid IPv6 address. + +## `configure authority router node device-interface network-interface address host-service subnet-options smtp-server` + +SMTP server address(es) provided to clients in priority order. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options smtp-server [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| ip-address | Value to add to this list | + +#### Description + +The order of elements matters. + +##### ip-address (union) + +The ip-address type represents an IP address and is IP version neutral. The format of the textual representations implies the IP version. + +Must be one of the following types: + +##### (0) ipv4-address (string) + +The ipv4-address type represents an IPv4 address in dotted-quad notation. + +Must be a valid IPv4 address. + +##### (1) ipv6-address (string) + +The ipv6-address type represents an IPv6 address in full, +mixed, shortened, and shortened-mixed notation. + +The canonical format of IPv6 addresses uses the compressed +format described in RFC 4291, Section 2.2, item 2 with the +following additional rules: the :: substitution must be +applied to the longest sequence of all-zero 16-bit chunks +in an IPv6 address. If there is a tie, the first sequence +of all-zero 16-bit chunks is replaced by ::. Single +all-zero 16-bit chunks are not compressed. The canonical +format uses lowercase characters and leading zeros are +not allowed. + +Must be a valid IPv6 address. +Must be a valid IPv6 address. + +## `configure authority router node device-interface network-interface address host-service subnet-options static-route` + +Static route(s) provided to clients. Note that for default routes the router option should be used. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options static-route +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| destination-address | Destination address of static route. | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `delete` | Delete configuration data | +| [`destination-address`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-static-route-destination-address) | Destination address of static route. | +| [`gateway`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-static-route-gateway) | Gateway address of static route. | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'static-route' | + +## `configure authority router node device-interface network-interface address host-service subnet-options static-route destination-address` + +Destination address of static route. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options static-route destination-address [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| non-default-ip-address | The value to set for this field | + +#### Description + +##### non-default-ip-address (union) + +A non-default IPv4 or IPv6 address + +Must be one of the following types: + +##### (0) non-default-ipv4-address (string) + +A non-default IPv4 address + +Must be a valid IPv4 address. + +##### (1) non-default-ipv6-address (string) + +A non-default IPv6 address + +Must be a valid IPv4 address. + +## `configure authority router node device-interface network-interface address host-service subnet-options static-route gateway` + +Gateway address of static route. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options static-route gateway [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| ip-address | The value to set for this field | + +#### Description + +##### ip-address (union) (required) + +The ip-address type represents an IP address and is IP version neutral. The format of the textual representations implies the IP version. + +Must be one of the following types: + +##### (0) ipv4-address (string) (required) + +The ipv4-address type represents an IPv4 address in dotted-quad notation. + +Must be a valid IPv4 address. + +##### (1) ipv6-address (string) (required) + +The ipv6-address type represents an IPv6 address in full, +mixed, shortened, and shortened-mixed notation. + +The canonical format of IPv6 addresses uses the compressed +format described in RFC 4291, Section 2.2, item 2 with the +following additional rules: the :: substitution must be +applied to the longest sequence of all-zero 16-bit chunks +in an IPv6 address. If there is a tie, the first sequence +of all-zero 16-bit chunks is replaced by ::. Single +all-zero 16-bit chunks are not compressed. The canonical +format uses lowercase characters and leading zeros are +not allowed. + +Must be a valid IPv6 address. +Must be a valid IPv6 address. + +## `configure authority router node device-interface network-interface address host-service subnet-options tenant` + +Tenant to which clients will be assigned. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options tenant [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| tenant-ref | The value to set for this field | + +#### Description + +##### tenant-ref (leafref) + +This type is used by other entities that need to reference configured tenants. + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information` + +Vendor-Identifying Vendor-Specific Information Options (Option 125) to be provided to clients [RFC3925]. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| enterprise-number | The vendor's registered 32-bit Enterprise Number as registered with IANA. | +| code | The code of the custom DHCP option. | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`code`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-identifying-vendor-specific-information-code) | The code of the custom DHCP option. | +| `delete` | Delete configuration data | +| [`description`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-identifying-vendor-specific-information-description) | A description of the custom DHCP option. | +| [`encoded-type`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-identifying-vendor-specific-information-encoded-type) | The encoded type of the custom option. | +| [`enterprise-number`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-identifying-vendor-specific-information-enterprise-number) | The vendor's registered 32-bit Enterprise Number as registered with IANA. | +| `move` | Move list items | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`quantity`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-identifying-vendor-specific-information-quantity) | The allowed quantity of the custom option values. | +| `show` | Show configuration data for 'vendor-identifying-vendor-specific-information' | +| [`value`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-identifying-vendor-specific-information-value) | The value(s) of custom option to be provided to clients. | + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information code` + +The code of the custom DHCP option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information code [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint16 | The value to set for this field | + +#### Description + +##### uint16 + +An unsigned 16-bit integer. + +Range: 0-65535 + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information description` + +A description of the custom DHCP option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information description [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| string | The value to set for this field | + +#### Description + +##### string + +A text value. + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information encoded-type` + +The encoded type of the custom option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information encoded-type [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| enumeration | The value to set for this field | + +#### Description + +Default: string + +##### enumeration + +A value from a set of predefined names. + +Options: + +- string: +- uint8: +- uint16: +- uint32: +- boolean: +- ipv4-address: +- int32: +- binary: A continuous string of hexadecimal digits with a '0x' prefix. Valid examples are '0xabcdef' and '0x123456'. + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information enterprise-number` + +The vendor's registered 32-bit Enterprise Number as registered with IANA. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information enterprise-number [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint32 | The value to set for this field | + +#### Description + +##### uint32 (required) + +An unsigned 32-bit integer. + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information quantity` + +The allowed quantity of the custom option values. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information quantity [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| enumeration | The value to set for this field | + +#### Description + +Default: singular + +##### enumeration + +A value from a set of predefined names. + +Options: + +- singular: +- array: + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information value` + +The value(s) of custom option to be provided to clients. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-identifying-vendor-specific-information value [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| string | Value to add to this list | + +#### Description + +The order of elements matters. + +##### string (required) + +A text value. + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information` + +Vendor-Specific Information Options (Option 43) to be provided to clients [RFC2132]. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| code | The code of the custom DHCP option. | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`code`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-specific-information-code) | The code of the custom DHCP option. | +| `delete` | Delete configuration data | +| [`description`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-specific-information-description) | A description of the custom DHCP option. | +| [`encoded-type`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-specific-information-encoded-type) | The encoded type of the custom option. | +| `move` | Move list items | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`quantity`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-specific-information-quantity) | The allowed quantity of the custom option values. | +| `show` | Show configuration data for 'vendor-specific-information' | +| [`value`](#configure-authority-router-node-device-interface-network-interface-address-host-service-subnet-options-vendor-specific-information-value) | The value(s) of custom option to be provided to clients. | + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information code` + +The code of the custom DHCP option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information code [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| uint16 | The value to set for this field | + +#### Description + +##### uint16 + +An unsigned 16-bit integer. + +Range: 0-65535 + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information description` + +A description of the custom DHCP option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information description [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| string | The value to set for this field | + +#### Description + +##### string + +A text value. + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information encoded-type` + +The encoded type of the custom option. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information encoded-type [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| enumeration | The value to set for this field | + +#### Description + +Default: string + +##### enumeration + +A value from a set of predefined names. + +Options: + +- string: +- uint8: +- uint16: +- uint32: +- boolean: +- ipv4-address: +- int32: +- binary: A continuous string of hexadecimal digits with a '0x' prefix. Valid examples are '0xabcdef' and '0x123456'. + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information quantity` + +The allowed quantity of the custom option values. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information quantity [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| enumeration | The value to set for this field | + +#### Description + +Default: singular + +##### enumeration + +A value from a set of predefined names. + +Options: + +- singular: +- array: + +## `configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information value` + +The value(s) of custom option to be provided to clients. + +#### Usage + +``` +configure authority router node device-interface network-interface address host-service subnet-options vendor-specific-information value [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| string | Value to add to this list | + +#### Description + +The order of elements matters. + +##### string (required) + +A text value. + ## `configure authority router node device-interface network-interface address host-service transport` The transport protocol(s) and port(s) for the service. @@ -21942,6 +23204,10 @@ configure authority router node ssh-keepalive asset-inter-conductor-router-serve Default: 5 +:::warning +`interval` is deprecated and will be removed in a future software version +::: + ##### ssh-keepalive-interval (uint8) Timeout interval in seconds to send keepalive when an SSH connection is idle. @@ -21968,6 +23234,10 @@ configure authority router node ssh-keepalive asset-inter-conductor-router-serve Default: 4 +:::warning +`max-attempts` is deprecated and will be removed in a future software version +::: + ##### ssh-keepalive-max-attempts (uint8) Number of keepalive messages sent before disconnecting an SSH connection. @@ -24589,8 +25859,16 @@ Routing engine debug commands. | [`bfd`](#configure-authority-router-routing-debug-bfd) | Debug BFD commands. | | [`bgp`](#configure-authority-router-routing-debug-bgp) | Debug BGP commands. | | `delete` | Delete configuration data | +| [`igmp`](#configure-authority-router-routing-debug-igmp) | Debug igmp. | +| [`igmp-events`](#configure-authority-router-routing-debug-igmp-events) | Debug igmp events. | +| [`igmp-packets`](#configure-authority-router-routing-debug-igmp-packets) | Debug igmp packets. | +| [`igmp-trace`](#configure-authority-router-routing-debug-igmp-trace) | Debug igmp trace. | +| [`msdp`](#configure-authority-router-routing-debug-msdp) | Debug msdp. | +| [`msdp-events`](#configure-authority-router-routing-debug-msdp-events) | Debug msdp events. | +| [`msdp-packets`](#configure-authority-router-routing-debug-msdp-packets) | Debug msdp packets. | | [`ospf`](#configure-authority-router-routing-debug-ospf) | Debug OSPF commands. | | `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`pim`](#configure-authority-router-routing-debug-pim) | Debug PIM commands. | | [`rib`](#configure-authority-router-routing-debug-rib) | Debug RIB Manager commands. | | `show` | Show configuration data for 'debug' | | [`static-route`](#configure-authority-router-routing-debug-static-route) | Debug static route commands. | @@ -24984,6 +26262,83 @@ Debug BGP leak to VRF events. | `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | | `show` | Show configuration data for 'leak-to-vrf' | +## `configure authority router routing debug igmp` + +Debug igmp. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'igmp' | + +## `configure authority router routing debug igmp-events` + +Debug igmp events. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'igmp-events' | + +## `configure authority router routing debug igmp-packets` + +Debug igmp packets. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'igmp-packets' | + +## `configure authority router routing debug igmp-trace` + +Debug igmp trace. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'igmp-trace' | + +## `configure authority router routing debug msdp` + +Debug msdp. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'msdp' | + +## `configure authority router routing debug msdp-events` + +Debug msdp events. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'msdp-events' | + +## `configure authority router routing debug msdp-packets` + +Debug msdp packets. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'msdp-packets' | + ## `configure authority router routing debug ospf` Debug OSPF commands. @@ -25044,6 +26399,139 @@ Debug OSPF graceful restart. | `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | | `show` | Show configuration data for 'graceful-restart' | +## `configure authority router routing debug pim` + +Debug PIM commands. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `delete` | Delete configuration data | +| [`events`](#configure-authority-router-routing-debug-pim-events) | Debug PIM Events, Traces, Traces Detail, and Zebra | +| [`mroute`](#configure-authority-router-routing-debug-pim-mroute) | Debug mroute, mroute detail | +| [`nht`](#configure-authority-router-routing-debug-pim-nht) | Debug PIM Nexthop Tracker (NHT). | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`packet-dump`](#configure-authority-router-routing-debug-pim-packet-dump) | Debug PIM packet-dump. | +| [`packets-general`](#configure-authority-router-routing-debug-pim-packets-general) | Debug PIM packets. | +| [`packets-hello`](#configure-authority-router-routing-debug-pim-packets-hello) | Debug PIM hello packets. | +| [`packets-joins`](#configure-authority-router-routing-debug-pim-packets-joins) | Debug PIM Join/Prune packets. | +| [`packets-register`](#configure-authority-router-routing-debug-pim-packets-register) | Debug PIM Register/Reg-Stop packets. | +| `show` | Show configuration data for 'pim' | + +## `configure authority router routing debug pim events` + +Debug PIM Events, Traces, Traces Detail, and Zebra + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'events' | + +## `configure authority router routing debug pim mroute` + +Debug mroute, mroute detail + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'mroute' | + +## `configure authority router routing debug pim nht` + +Debug PIM Nexthop Tracker (NHT). + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'nht' | + +## `configure authority router routing debug pim packet-dump` + +Debug PIM packet-dump. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `delete` | Delete configuration data | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`receive`](#configure-authority-router-routing-debug-pim-packet-dump-receive) | Debug PIM received packets. | +| [`send`](#configure-authority-router-routing-debug-pim-packet-dump-send) | Debug PIM sent packets. | +| `show` | Show configuration data for 'packet-dump' | + +## `configure authority router routing debug pim packet-dump receive` + +Debug PIM received packets. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'receive' | + +## `configure authority router routing debug pim packet-dump send` + +Debug PIM sent packets. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'send' | + +## `configure authority router routing debug pim packets-general` + +Debug PIM packets. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'packets-general' | + +## `configure authority router routing debug pim packets-hello` + +Debug PIM hello packets. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'packets-hello' | + +## `configure authority router routing debug pim packets-joins` + +Debug PIM Join/Prune packets. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'packets-joins' | + +## `configure authority router routing debug pim packets-register` + +Debug PIM Register/Reg-Stop packets. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| `show` | Show configuration data for 'packets-register' | + ## `configure authority router routing debug rib` Debug RIB Manager commands. @@ -39148,6 +40636,7 @@ System group configuration. Lets administrators configure system-wide properties | [`log-category`](#configure-authority-router-system-log-category) | Log category configuration lets administrators configure the SSR's log level for specific log categories, overriding the default log-level setting. | | [`log-level`](#configure-authority-router-system-log-level) | The log level is the degree to which the SSR writes information into its log files, by default. WARNING: using the 'trace' level will significantly impact system performance and is not recommended for production environments. The 'log-category' configuration should be used instead for 'trace' level of specific categories. | | [`metrics`](#configure-authority-router-system-metrics) | Parameters controlling metric configuration and collection. Governs various aspects of the SSR's data sampling for analytics purposes. | +| [`minion-watchdog-settings`](#configure-authority-router-system-minion-watchdog-settings) | Per-router override for minion watchdog settings. | | [`ntp`](#configure-authority-router-system-ntp) | NTP configuration lets administrators configure information about the NTP servers within their management network. | | `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | | [`radius`](#configure-authority-router-system-radius) | Configure Radius | @@ -40568,6 +42057,330 @@ A signed 8-bit integer. Range: 1-60 +## `configure authority router system minion-watchdog-settings` + +Per-router override for minion watchdog settings. + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`check-interval`](#configure-authority-router-system-minion-watchdog-settings-check-interval) | Interval to check whether the salt-minion is wedged. | +| [`consecutive-failures`](#configure-authority-router-system-minion-watchdog-settings-consecutive-failures) | Number of consecutive failures before salt-minion restart. | +| `delete` | Delete configuration data | +| [`enabled`](#configure-authority-router-system-minion-watchdog-settings-enabled) | Enable or disable the minion watchdog. When not configured, uses the authority-level setting. | +| [`ha-consecutive-failures`](#configure-authority-router-system-minion-watchdog-settings-ha-consecutive-failures) | The number of consecutive failures for HA conductor alarms recorded before salt-minion restart. | +| [`job-timeout`](#configure-authority-router-system-minion-watchdog-settings-job-timeout) | Timeout before a running job is considered stuck and the minion is restarted. | +| [`log-level`](#configure-authority-router-system-minion-watchdog-settings-log-level) | Watchdog log level. | +| [`max-memory`](#configure-authority-router-system-minion-watchdog-settings-max-memory) | Maximum memory threshold the salt-minion is allowed to consume. | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`override-master-count`](#configure-authority-router-system-minion-watchdog-settings-override-master-count) | Override expected number of salt-master connections instead of auto-detecting from the salt-minion configuration file. | +| `show` | Show configuration data for 'minion-watchdog-settings' | + +## `configure authority router system minion-watchdog-settings check-interval` + +Interval to check whether the salt-minion is wedged. + +#### Usage + +``` +configure authority router system minion-watchdog-settings check-interval [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| union | The value to set for this field | + +#### Description + +Units: minutes + +Default: use-authority-setting + +##### union + +A value that corresponds to one of its member types. + +Must be one of the following types: + +##### (0) uint8 + +An unsigned 8-bit integer. + +Range: 1-10 + +##### (1) enumeration + +A value from a set of predefined names. + +Options: + +- use-authority-setting: Use the authority-level setting. + +## `configure authority router system minion-watchdog-settings consecutive-failures` + +Number of consecutive failures before salt-minion restart. + +#### Usage + +``` +configure authority router system minion-watchdog-settings consecutive-failures [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| union | The value to set for this field | + +#### Description + +Default: use-authority-setting + +##### union + +A value that corresponds to one of its member types. + +Must be one of the following types: + +##### (0) uint16 + +An unsigned 16-bit integer. + +Range: 1-1000 + +##### (1) enumeration + +A value from a set of predefined names. + +Options: + +- use-authority-setting: Use the authority-level setting. + +## `configure authority router system minion-watchdog-settings enabled` + +Enable or disable the minion watchdog. When not configured, uses the authority-level setting. + +#### Usage + +``` +configure authority router system minion-watchdog-settings enabled [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| boolean | The value to set for this field | + +#### Description + +##### boolean + +A true or false value. + +Options: true or false + +## `configure authority router system minion-watchdog-settings ha-consecutive-failures` + +The number of consecutive failures for HA conductor alarms recorded before salt-minion restart. + +#### Usage + +``` +configure authority router system minion-watchdog-settings ha-consecutive-failures [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| union | The value to set for this field | + +#### Description + +Default: use-authority-setting + +##### union + +A value that corresponds to one of its member types. + +Must be one of the following types: + +##### (0) uint16 + +An unsigned 16-bit integer. + +Range: 1-1000 + +##### (1) enumeration + +A value from a set of predefined names. + +Options: + +- use-authority-setting: Use the authority-level setting. + +## `configure authority router system minion-watchdog-settings job-timeout` + +Timeout before a running job is considered stuck and the minion is restarted. + +#### Usage + +``` +configure authority router system minion-watchdog-settings job-timeout [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| union | The value to set for this field | + +#### Description + +Units: minutes + +Default: use-authority-setting + +##### union + +A value that corresponds to one of its member types. + +Must be one of the following types: + +##### (0) uint16 + +An unsigned 16-bit integer. + +Range: 1-1440 + +##### (1) enumeration + +A value from a set of predefined names. + +Options: + +- use-authority-setting: Use the authority-level setting. + +## `configure authority router system minion-watchdog-settings log-level` + +Watchdog log level. + +#### Usage + +``` +configure authority router system minion-watchdog-settings log-level [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| enumeration | The value to set for this field | + +#### Description + +Default: use-authority-setting + +##### enumeration + +A value from a set of predefined names. + +Options: + +- fatal +- error +- warning +- info +- debug +- trace +- use-authority-setting: Use the authority-level setting. + +## `configure authority router system minion-watchdog-settings max-memory` + +Maximum memory threshold the salt-minion is allowed to consume. + +#### Usage + +``` +configure authority router system minion-watchdog-settings max-memory [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| union | The value to set for this field | + +#### Description + +Units: MB + +Default: use-authority-setting + +##### union + +A value that corresponds to one of its member types. + +Must be one of the following types: + +##### (0) uint16 + +An unsigned 16-bit integer. + +Range: 500-5000 + +##### (1) enumeration + +A value from a set of predefined names. + +Options: + +- use-authority-setting: Use the authority-level setting. + +## `configure authority router system minion-watchdog-settings override-master-count` + +Override expected number of salt-master connections instead of auto-detecting from the salt-minion configuration file. + +#### Usage + +``` +configure authority router system minion-watchdog-settings override-master-count [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| union | The value to set for this field | + +#### Description + +Default: use-authority-setting + +##### union + +A value that corresponds to one of its member types. + +Must be one of the following types: + +##### (0) uint8 + +An unsigned 8-bit integer. + +Range: 0-2 + +##### (1) enumeration + +A value from a set of predefined names. + +Options: + +- use-authority-setting: Use the authority-level setting. + ## `configure authority router system ntp` NTP configuration lets administrators configure information about the NTP servers within their management network. @@ -45706,6 +47519,8 @@ Options: - aes-cbc-128: AES Cipher Block Chaining 128-bit Encryption Mode. - aes-cbc-256: AES Cipher Block Chaining 256-bit Encryption Mode. +- aes-gcm-128: AES Galois Counter Mode 128-bit Encryption. +- aes-gcm-256: AES Galois Counter Mode 256-bit Encryption. ## `configure authority security encryption-iv` @@ -46482,6 +48297,7 @@ configure authority service access-policy | [`permission`](#configure-authority-service-access-policy-permission) | Whether or not to allow access to the service. | | `show` | Show configuration data for 'access-policy' | | [`source`](#configure-authority-service-access-policy-source) | The source QSN or address(es) to which the policy applies. For a QSN, this may be a tenant, service-group, or service, or a combination there of. The following forms are valid: tenant tenant/service-group/ tenant/service-group/service tenant/service /service-group/ /service-group/service /service | +| [`ssl-proxy-profile`](#configure-authority-service-access-policy-ssl-proxy-profile) | User-defined profile for ssl-proxy. | | [`syslog`](#configure-authority-service-access-policy-syslog) | Configure Syslog | ## `configure authority service access-policy anti-virus-policy` @@ -46702,6 +48518,28 @@ A string identifier for a tenant prefix. Consists of a valid tenant name, follow Must contain a valid tenant name, followed by @ and a valid IP Address. Length: 0-280 +## `configure authority service access-policy ssl-proxy-profile` + +User-defined profile for ssl-proxy. + +#### Usage + +``` +configure authority service access-policy ssl-proxy-profile [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| leafref | The value to set for this field | + +#### Description + +##### leafref + +A reference to an existing value in the instance data. + ## `configure authority service access-policy syslog` Configure Syslog @@ -50218,6 +52056,184 @@ replaced by ::. Single all-zero 16-bit chunks are not compressed. The canonical format uses lowercase characters and leading zeros are not allowed. +## `configure authority ssl-proxy-profile` + +User defined SSL proxy profiles. + +#### Usage + +``` +configure authority ssl-proxy-profile +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| name | unique name of the profile. | + +##### Subcommands + +| command | description | +| ------- | ----------- | +| [`allowed-domains`](#configure-authority-ssl-proxy-profile-allowed-domains) | allowed domains for ssl proxy. | +| [`client-certificate`](#configure-authority-ssl-proxy-profile-client-certificate) | Client certificate for ssl proxy. | +| `delete` | Delete configuration data | +| [`ignore-server-authentication`](#configure-authority-ssl-proxy-profile-ignore-server-authentication) | If this option is not set, all the sessions where the server sends self-signed certificates are dropped when errors are encountered. | +| [`name`](#configure-authority-ssl-proxy-profile-name) | unique name of the profile. | +| `override-generated` | Force auto-generated configuration and any modifications to it to persist on commit | +| [`policy`](#configure-authority-ssl-proxy-profile-policy) | policy for ssl proxy config. | +| [`root-ca-certificate`](#configure-authority-ssl-proxy-profile-root-ca-certificate) | Root CA certificate for ssl proxy. | +| `show` | Show configuration data for 'ssl-proxy-profile' | + +## `configure authority ssl-proxy-profile allowed-domains` + +allowed domains for ssl proxy. + +#### Usage + +``` +configure authority ssl-proxy-profile allowed-domains [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| domain-name-not-ipv4 | Value to add to this list | + +#### Description + +##### domain-name-not-ipv4 (string) + +A subset of domain-name that are not IPv4 addresses + +Length: 1-253 + +## `configure authority ssl-proxy-profile client-certificate` + +Client certificate for ssl proxy. + +#### Usage + +``` +configure authority ssl-proxy-profile client-certificate [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| client-certificate-ref | The value to set for this field | + +#### Description + +##### client-certificate-ref (leafref) (required) + +This type is used by other entities that need to reference configured client certificate. + +## `configure authority ssl-proxy-profile ignore-server-authentication` + +If this option is not set, all the sessions where the server sends self-signed certificates are dropped when errors are encountered. + +#### Usage + +``` +configure authority ssl-proxy-profile ignore-server-authentication [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| boolean | The value to set for this field | + +#### Description + +Default: false + +##### boolean + +A true or false value. + +Options: true or false + +## `configure authority ssl-proxy-profile name` + +unique name of the profile. + +#### Usage + +``` +configure authority ssl-proxy-profile name [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| name-id | The value to set for this field | + +#### Description + +##### name-id (string) + +A string identifier which only uses alphanumerics, underscores, or dashes, and cannot exceed 63 characters. + +Must contain only alphanumeric characters or any of the following: _ - +Length: 0-63 + +## `configure authority ssl-proxy-profile policy` + +policy for ssl proxy config. + +#### Usage + +``` +configure authority ssl-proxy-profile policy [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| ssl-proxy-policy | The value to set for this field | + +#### Description + +##### ssl-proxy-policy (enumeration) (required) + +Predefined policies for ssl forward proxy + +Options: + +- none: No SSL Proxy policy. +- weak: Weak cipher SSL Proxy policy. +- medium: Medium cipher SSL Proxy policy. +- strong: Strong cipher SSL Proxy policy. + +## `configure authority ssl-proxy-profile root-ca-certificate` + +Root CA certificate for ssl proxy. + +#### Usage + +``` +configure authority ssl-proxy-profile root-ca-certificate [] +``` + +##### Positional Arguments + +| name | description | +| ---- | ----------- | +| trusted-ca-certificate-ref | The value to set for this field | + +#### Description + +##### trusted-ca-certificate-ref (leafref) (required) + +This type is used by other entities that need to reference configured trusted ca certificate. + ## `configure authority step` Configure Step diff --git a/docs/config_custom_certs.md b/docs/config_custom_certs.md index 3d5ca718b60..f69e2a024f0 100644 --- a/docs/config_custom_certs.md +++ b/docs/config_custom_certs.md @@ -7,7 +7,8 @@ sidebar_label: Configure Certificate Management | Release | Modification | | ------- | --------------------------- | -| 7.0.0 | Certificate Management support added. | +| 7.0.0 | Certificate Management support added. | +| 7.2.0 | Subject Alternative Name support added to CSR generation. | Security is a critical component of SD-WAN products. The effectiveness of any security strategy relies on the strength of the security algorithm and how related information is exchanged between participants. @@ -51,8 +52,8 @@ The following are some details of certificate security. ## Provisioning Process -:::important -It is necessary for all of the REST APIs to use the name `custom_ssr_peering` in order for this private key and certificate to be visible and usable by Enhanced Security Key Management in 7.0. This is a reserved name specifically used by the Enhanced Security Key Management feature. +:::note Legacy Name +In SSR 7.0.x, the `name` field in all REST API calls was required to be `custom_ssr_peering` (a reserved name) for ESKM visibility. Starting with SSR 7.1.0, any consistent name may be used. The examples below use `my_peering_cert`. ::: :::tip Swagger API Reference @@ -191,7 +192,7 @@ Create the following file (update algorithm and key size to your preference): ``` { - "name": "custom_ssr_peering", + "name": "my_peering_cert", "algorithm": "RSA", "rsa_key_size": "2048" } @@ -213,7 +214,7 @@ curl -k -X POST https://10.27.35.89/api/v1/router/combo-east/node/node2/private- -d @key_request.json ``` -Upon success, `ssh` to the target SSR and verify that `/etc/128technology/pki/custom_ssr_peering.key` exists on disk. +Upon success, `ssh` to the target SSR and verify that `/etc/128technology/pki/my_peering_cert.key` exists on disk. ### Issue a `certificate-signing-request` @@ -226,11 +227,13 @@ This requirement is lifted starting with SSR 7.1.0. ::: -1. Create a file containing the CSR request body. At a minimum provide `name` and a `common_name` that is unique to this router or node: +1. Create a file containing the CSR request body. At a minimum provide `name` and a `common_name`: :::important Naming Rules -- **`name`** must be **the same value across all routers and nodes** — `custom_ssr_peering` in SSR 7.0.x (reserved). This is the authority-wide identifier required for ESKM visibility. -- **`common_name`** must be **unique per router/node** and must **exactly match** that router's configured `peering-common-name`. Using the wrong `common_name` will cause ESKM peer authentication to fail. +- **`name`** must be **the same value across all routers and nodes**. In SSR 7.1+, any consistent name may be used. +- **`common_name`** must be **unique per router/node**. It must match that router's configured `peering-common-name` — either directly, or via a `urn:ssr:peering` SAN URI in the certificate (SSR 7.2.0+). + +For full details on SAN URI peering identity, see [Enhanced Security Key Management — API Naming Rules](sec_enhanced_key_mgmt.md#api-naming-rules). Example mapping for a two-router deployment: @@ -240,15 +243,27 @@ Example mapping for a two-router deployment: | combo-west | `west-alias` | `west-alias` | ::: -**csr_request.json** +**csr_request.json** (minimum): ``` { - "name": "custom_ssr_peering", + "name": "my_peering_cert", "common_name": "east-alias" } ``` +**csr_request.json** (with Subject Alternative Name URI for HA): + +```json +{ + "name": "my_peering_cert", + "common_name": "combo-east-node1", + "subject_alt_names": [ + {"type": "urn_ssr_peering", "value": "east-alias"} + ] +} +``` + This example represents the minimum requirements. Any of the following additional details may be added to the request: - country_name (string, optional): The country name. @@ -261,6 +276,12 @@ This example represents the minimum requirements. Any of the following additiona - rsa_key_size (integer, optional): The RSA key size. Only valid when algorithm is set to “RSA”. Valid key sizes are any multiple of 256 between 2048 and 4096. - ecc_curve (string, optional): The ECC curve to use. Only valid when algorithm is set to “ECC”.Valid curves are: (SECP256R, SECP384R1, SECP521R1) - validity_period (integer, optional): The validity period in days. +- subject_alt_names (array, optional, SSR 7.2.0+): An array of Subject Alternative Name entries to include in the CSR. Each entry is an object with `type` and `value` fields. Supported types: + - `dns` — a DNS hostname (e.g., `"example.com"`) + - `ip` — an IPv4 or IPv6 address (e.g., `"192.168.1.1"`) + - `email` — an email address (e.g., `"admin@example.com"`) + - `uri` — a URI (e.g., `"https://example.com"`) + - `urn_ssr_peering` — a convenience alias that automatically expands the value to `URI:urn:ssr:peering:`. Use this type to carry the SVRv2 peering identity in the SAN extension. 2. Issue the CSR request to the SSR: @@ -301,7 +322,7 @@ When the signed certificate is returned, instruct the SSR to ingest the certific ``` POST /api/v1/router/{router_name}/node/{node_name}/certificate { - "name": "custom_ssr_peering", + "name": "my_peering_cert", "certificate": "-----BEGIN CERTIFICATE----- MIIF3DCCBESgAwIBAgIKAf9HQjJKSQd1lTANBgkqhkiG9w0BAQsFADBaMQswCQYD VQQGEwJERTERMA8GA1UECgwIT3BlblhQS0kxDDAKBgNVBAsMA1BLSTEqMCgGA1UE @@ -319,8 +340,8 @@ Once the certificate is successfully ingested, verify that the certificate was a 1. `ssh` to the SSR. 2. Log in as the root user: `sudo su`. -3. Verify that `/etc/128technology/pki/custom_ssr_peering.pem` exists on disk. - `ls -l /etc/128technology/pki/custom_ssr_peering.pem` +3. Verify that `/etc/128technology/pki/my_peering_cert.pem` exists on disk. + `ls -l /etc/128technology/pki/my_peering_cert.pem` ### Activate the Certificate in Configuration @@ -330,9 +351,9 @@ On the Conductor, configure `client-certificate` using the same `name` value use ``` config authority - client-certificate custom_ssr_peering - name custom_ssr_peering - file custom_ssr_peering + client-certificate my_peering_cert + name my_peering_cert + file my_peering_cert validation-mode strict exit exit diff --git a/docs/config_management_over_forwarding.md b/docs/config_management_over_forwarding.md index 632e6ea441c..336e3fdc190 100644 --- a/docs/config_management_over_forwarding.md +++ b/docs/config_management_over_forwarding.md @@ -154,4 +154,4 @@ exit ### User Defined Services -For any other service not defined by the default management services list, the user can configure a _service_ to best suit their needs. It is necessary to configure the [_internal_](bcp_tenants.mdx#the-internal-tenant) tenant within the `access-policy` of the service to allow traffic originating from the Linux host. +For any other service not defined by the default management services list, the user can configure a _service_ to best suit their needs. It is necessary to configure the [_internal_](bcp_tenants.md#the-internal-tenant) tenant within the `access-policy` of the service to allow traffic originating from the Linux host. diff --git a/docs/config_pmtu.md b/docs/config_pmtu.md new file mode 100644 index 00000000000..bf166c9d1a5 --- /dev/null +++ b/docs/config_pmtu.md @@ -0,0 +1,179 @@ +--- +title: Path MTU Discovery +sidebar_label: Path MTU Discovery +--- + +The SSR performs Path MTU Discovery (PMTUD) along the overlay to determine the correct maximum transmission unit (MTU) for each peer path. By default, this test runs every ten minutes. If a change in the underlay reduces the available path MTU between two SSRs, the new value is not discovered until the next PMTUD cycle. Additionally, existing sessions continue to use the previous MTU value until the next time those sessions are rebuilt. + +| Direction | Port/Proto | Client Payload (bytes) | Server Payload (bytes) | Default Interval | Notes | +| --- | --- | --- | --- | --- | --- | +| bidirectional | 1280/UDP | 2945 | 90 | 600s | Interval is configurable within `path-mtu-discovery/interval`, or disabled `path-mtu-discovery/enabled`. | + +Peering SSR routers will perform path MTU discovery on each peer path between each other. This test is run every ten (10) minutes by default, to adjust in the event of path changes between peering devices. During the test, SSR routers send packets of various sizes to discover the MTU of the path. However, in some government deployments the use of MTU discovery is not possible. + +In order to accommodate these deployments where “ICMP Destination Unreachable - Fragmentation Needed” response messages are not generated (RFC1911 is not followed), three successive non-responses are considered equivalent to ICMP responses for the purposes of driving the algorithm with an inferred MTU. + +The discovered MTU is viewable in the output of `show peers`. + +Devices in the underlay may report an ICMP Destination Unreachable / Fragmentation Needed (type 3, code 4) error, referred to here as a _TooBig_ packet, to indicate they could not forward a packet due to an undersized MTU. Prior to SSR 7.2.0, these messages were forwarded to the correct endpoint, but the SSR itself did not act on the MTU value contained in the message, leaving existing sessions with an incorrect PMTU. + +SSR 7.2.0 introduces two complementary enhancements to address the gaps mentioned above: + +1. **Underlay ICMP reaction** — When the SSR receives a TooBig packet from the underlay, it updates the affected overlay flow and generates a corrected TooBig packet toward the original packet sender, allowing the sender to adjust its segment size. + +2. **Session Refresh** - The flow which was traversed to trigger the TooBig response from the underlay is now updated to use the MTU reported in the TooBig packet. + +For TCP flows, setting `enforced-mss automatic` on the egress `network-interface` is the recommended complement to these features. It adjusts the TCP MSS advertised at the interface boundary to avoid fragmentation in the first place. See [Configuration](#configuration) for details. + +## How The SSR Reacts to Underlay ICMP TooBig Messages + +The following sequence illustrates what happens when the underlay path MTU changes after a session is already established. + +### Initial State + +```mermaid +sequenceDiagram + participant Client + participant Hub as Hub SSR + participant R1 as Spoke SSR + participant Server + + Client->>Hub: Data (MTU 1500) + Hub->>R1: SVR overlay packet (MTU 1500) + R1->>Server: Data (MTU 1500) + Note over Hub,R1: Underlay MTU = 1500. Session PMTU on both SSRs = 1500. +``` + +The client and server are communicating through two peering SSRs over the overlay. The PMTU is consistent at 1500 across all hops, and both SSRs have applied an MTU of 1500 to the forward flow actions for this session. + +### Underlay MTU Drops — First TooBig Received by Hub + +```mermaid +sequenceDiagram + participant Client + participant Hub as Hub SSR + participant R2 as Underlay Device + participant R1 as Spoke SSR + participant Server + + Note over R2,R1: Underlay MTU between Hub and R2 drops to 1300 + Hub->>R2: SVR packet hub-WAN to spoke-WAN (over 1300 bytes) + R2-->>Hub: ICMP TooBig type 3 code 4, reported MTU = 1300 + Note over Hub: DivertedPacketHandler finds reverse flow. Updates Hub-to-Spoke PMTU to 1300. + Hub-->>Server: New TooBig toward Server + Note over Server: Server adjusts MSS if TCP-capable +``` + +When R2 (an underlay device) cannot forward an oversized packet, it sends a TooBig packet to the Hub's WAN interface. The SSR processes this message and does the following: + +1. It extracts the encapsulated IP header from the TooBig body to identify the affected overlay session. +2. It finds the reverse flow using that header and updates the Hub → Spoke forward flow's PMTU to the value reported by the underlay. +3. It constructs a new TooBig packet directed toward the original packet sender (the Server), so the server's TCP stack can reduce its MSS. + +:::note +The MTU value propagated in the new TooBig packet reflects the underlay-reported value. On paths with encryption, HMAC, FEC, or BFD tunneling overhead, the effective usable MTU will be lower than the raw underlay value. The SSR accounts for these overheads when setting the MTU on forward flow actions. +::: + +## Fabric Fragmentation and Oversize Packet Behavior + +When the PMTU on an overlay (SVR/fabric) path is lower than the MTU of the segment immediately preceding the Hub, packets larger than the PMTU will require fragmentation along the overlay. The SSR always fragments fabric packets when necessary, even when the incoming packet carries the Don't Fragment (DF) bit. This preserves packet delivery but prevents the sender from learning about the smaller path MTU and adjusting its segment size. + +:::note +For TCP traffic, setting `enforced-mss automatic` on the egress `network-interface` is the most reliable way to avoid this scenario. When set, the SSR rewrites the TCP MSS at the interface boundary to match the session MTU (including the path MTU for SVR sessions). This is commonly known as `MSS Clamping` and is not the default; it must be explicitly configured. +::: + +## Configuration + +### Configuring `enforced-mss` (Recommended for TCP) + +Set `enforced-mss` to `automatic` on egress interfaces to avoid fabric fragmentation for TCP traffic. The SSR calculates the correct MSS from the interface or path MTU for SVR sessions. + +``` +config + authority + router + node + device-interface + network-interface + enforced-mss automatic + exit + exit + exit + exit + exit +exit +``` + +### Configuring PMTUD Interval + +The PMTUD interval (how frequently the SSR probes each overlay path) is configurable at the router level and can be overridden per neighborhood or per adjacency. + +``` +config + authority + router + path-mtu-discovery + enabled true + interval 600 + exit + exit + exit +exit +``` + +| Field | Default | Description | +| ----- | ------- | ----------- | +| `enabled` | `true` | Enables or disables PMTUD for this router. | +| `interval` | `600` | Seconds between PMTUD tests. Valid range: 1–86400. | + +To override the interval for a specific adjacency: + +``` +config + authority + router + node + device-interface + network-interface + adjacency + path-mtu-discovery + enabled true + interval 300 + exit + exit + exit + exit + exit + exit + exit +exit +``` + +## Verification + +Use `show peers` to confirm the currently discovered path MTU for each peer path: + +```text +admin@node1.router1# show peers +Peer Node Network Interface Destination Status Hostname Path MTU +------------------------ --------- ------------------- --------------- -------- ------------ ---------- +router2 node1 wan0 192.0.2.10 Up router2.lab 1300 +``` + +A `Path MTU` value of `0` indicates PMTUD is disabled or has not yet completed a test cycle. + +A new stat, `stats/icmp/flow-mtu-updates`, provides a count of flows that have had their MTU updated at runtime via a TooBig packet. This counter is reset when the system resets (not persisted). + +**need stat example + +## Troubleshooting + +- If the path MTU shown by `show peers` does not reflect the expected value, verify that `path-mtu-discovery > enabled` is `true` on both sides of the adjacency. +- If TCP sessions continue to fragment after configuring `enforced-mss automatic`, confirm the setting is applied to the correct egress interface and that both peers have completed a PMTUD cycle. + +## Related Topics + +- [Concepts: Machine to Machine Communication](concepts_machine_communication.md) — path MTU discovery protocol details and BFD traffic patterns. +- [Configuration Reference Guide](config_reference_guide.md) — full parameter reference for `path-mtu-discovery`, `enforced-mss`, and `session-resiliency`. +- [Configuring Session Recovery Detection](config_session_recovery.md) — session health-check and flow rebuild mechanisms. +- [Configuring Forward Error Correction](config_forward_error_correction.md) — complementary resiliency feature for packet loss. diff --git a/docs/config_webserver_certs.md b/docs/config_webserver_certs.md index b84d123fb31..c99803bb2a9 100644 --- a/docs/config_webserver_certs.md +++ b/docs/config_webserver_certs.md @@ -97,9 +97,6 @@ Which router is this certificate for? (Select all if it applies to the entire au authority client-certificate webserver content -``` - -For details on what certificate properties the SSR requires (including Extended Key Usage), see [Certificate Requirements and Validation](cert_validation_requirements.md). 2. certificate contains the following issues: does not have the extendKeyUsage extension @@ -112,6 +109,7 @@ For details on what certificate properties the SSR requires (including Extended Certificate imported successfully Would you like to clean up the temporary certificate and key files? [Y/n]: Y ``` +For details on what certificate properties the SSR requires (including Extended Key Usage), see [Certificate Requirements and Validation](cert_validation_requirements.md). The following example shows an invalid self-signed certificate being imported: diff --git a/docs/intro_basic_conductor_config.md b/docs/intro_basic_conductor_config.md index de18319278c..50ea6f83b96 100644 --- a/docs/intro_basic_conductor_config.md +++ b/docs/intro_basic_conductor_config.md @@ -44,5 +44,5 @@ In the steps below, we provide an example tenant name, _corp_, which is used in 4. Return to the top level. 5. At the top of the screen, select VALIDATE and then COMMIT. -For more information about Tenancy, please see [Tenancy Design](bcp_tenants.mdx). +For more information about Tenancy, please see [Tenancy Design](bcp_tenants.md). For more information about configuring and deploying conductors, please see [conductor Deployment](bcp_conductor_deployment.md). diff --git a/docs/intro_downloading_iso.md b/docs/intro_downloading_iso.md index e55d9b3ed45..6f4885ab329 100644 --- a/docs/intro_downloading_iso.md +++ b/docs/intro_downloading_iso.md @@ -23,7 +23,7 @@ For users installing *earlier, package-based versions of the SSR software*, the This ISO also provides different local installation methods. - **One Touch Provisioning (OTP)** is the default and preferred method of installation. OTP sets up DHCP on all interfaces and boots a Web Server GUI. After installing the Conductor and configuring routers through the Conductor, the OTP bootstrap process will install and configure the router. See the following procedures for OTP installation steps: - - [Router Installation Using OTP](intro_otp_iso_install.mdx) + - [Router Installation Using OTP](intro_otp_iso_install.md) - [Quickstart from the OTP ISO](intro_install_quickstart_otpiso.md) - **Interactive:** Beginning with SSR version 6.3.0, the use of the interactive installer is not supported, nor necessary. Software installation and upgrade activities are supported from the GUI or PCLI. With software versions earlier than 6.3.0, upgrading the SSR software on a conductor or router that is managed by a conductor using the interactive installer may result in the system becoming unresponsive. For this reason it is highly recommended that upgrades be performed through the conductor UI. For a new installation of a conductor using software prior to 6.3.0, the interactive method can be used. diff --git a/docs/intro_installation_bootable_media.mdx b/docs/intro_installation_bootable_media.mdx index b78e38b68cb..8e0b181ec29 100644 --- a/docs/intro_installation_bootable_media.mdx +++ b/docs/intro_installation_bootable_media.mdx @@ -14,7 +14,7 @@ The steps in this section describe the *interactive conductor installation* from The Conductor installation must be completed before installing a Session Smart Router or routers using the ISO. The same ISO is used for both installations. ::: -To install a router **after** installing and configuring the Conductor, use the [SSR Installation](intro_installation_bootable_media.mdx). The [Router Installation Using OTP](intro_otp_iso_install.mdx) procedure can be used for whitebox and air-gap, conductor-managed network installations. +To install a router **after** installing and configuring the Conductor, use the [SSR Installation](intro_installation_bootable_media.mdx). The [Router Installation Using OTP](intro_otp_iso_install.md) procedure can be used for whitebox and air-gap, conductor-managed network installations. :::important If you are installing SSR Version 6.3.x, use the [Universal ISO Installation process](intro_installation_univ-iso.md). diff --git a/docs/intro_installation_legacy.md b/docs/intro_installation_legacy.md index 294fd3c7adc..4b77987171f 100644 --- a/docs/intro_installation_legacy.md +++ b/docs/intro_installation_legacy.md @@ -27,7 +27,7 @@ The examples listed in this guide generally prefer running commands as a non-roo - [Perform the Interactive ISO installation](intro_installation_bootable_media.mdx) - [Install a Conductor](install_conductor_overview.md) - [Create the Router configuration with the Conductor](intro_basic_router_config.md) or [Import a Configuration](single_conductor_config.md) - - [Install the Router using the OTP ISO](intro_otp_iso_install.mdx) or [Install the Router using the Interactive Installation](intro_installation_bootable_media.mdx) + - [Install the Router using the OTP ISO](intro_otp_iso_install.md) or [Install the Router using the Interactive Installation](intro_installation_bootable_media.mdx) A Mist-redirect ZTP process for Conductor-managed deployments is supported on Juniper branded hardware devices - the SSR1x0/1x00. See [Onboard an SSR Device to a Conductor](onboard_ssr_to_conductor.md) for details about this process. diff --git a/docs/intro_otp_iso_install.mdx b/docs/intro_otp_iso_install.md similarity index 91% rename from docs/intro_otp_iso_install.mdx rename to docs/intro_otp_iso_install.md index 90c397fc54a..6e54d1b2948 100644 --- a/docs/intro_otp_iso_install.mdx +++ b/docs/intro_otp_iso_install.md @@ -3,8 +3,6 @@ title: Router Installation Using OTP sidebar_label: Router Installation Using OTP --- -import Flowchart from '../src/components/Flowchart'; - :::important If you are installing SSR Version 6.3.x, use the [Universal ISO Installation process](intro_installation_univ-iso.md). ::: @@ -178,50 +176,36 @@ Any stdout/stderr output generated from the scriptlets is logged in `/var/log/12 ### Bootstrapping Flow Chart The diagram below shows the procedure the Bootstrap utility follows during the first boot-up of the platform after the ISO installation completes. -start: Start - bs=>operation: Check for Pre-Bootstrap Scriptlet - usb1=>condition: On USB? - def1=>condition: Default? - es=>inputoutput: Execute Pre-Bootstrap Scriptlet - smh=>operation: Set Minion ID\nSet Hostname\nSynchronize Clock - sfd=>operation: Set 128T Factory Defaults - usb2=>condition: On USB? - def2=>condition: Default? - rest=>condition: REST get? - aq=>inputoutput: Apply quickstart.txt - aotpd=>inputoutput: Apply OTP Defaults - ist=>operation: Setup IFCFG\nEnable salt-minion\nEnable 128T - pbs=>operation: Check for Post-Bootstrap Scriptlet - usb3=>condition: On USB? - def3=>condition: Default? - es2=>inputoutput: Execute Post-Bootstrap Scriptlet - fin=>operation: Finalize - wbr=>subroutine: Write Bootstrap Report - reb=>operation: Reboot - e=>end: End - st->bs->usb1 - usb1(no)->def1 - usb1(yes)->es - def1(yes)->es - def1(no)->smh - es->smh - smh->sfd->usb2 - usb2(no, right)->def2 - usb2(yes, right)->aq - def2(yes)->aq - def2(no)->rest - rest(no)->aotpd - rest(yes)->aq->ist - aotpd->ist->pbs->usb3 - usb3(yes)->es2 - usb3(no)->def3 - def3(yes)->es2->fin - def3(no)->fin - fin->wbr->reb->e - `} -/> +```mermaid +flowchart TD + st([Start]) --> bs[Check for Pre-Bootstrap Scriptlet] + bs --> usb1{On USB?} + usb1 -->|yes| es[/Execute Pre-Bootstrap Scriptlet/] + usb1 -->|no| def1{Default?} + def1 -->|yes| es + def1 -->|no| smh + es --> smh["Set Minion ID
Set Hostname
Synchronize Clock"] + smh --> sfd[Set 128T Factory Defaults] + sfd --> usb2{On USB?} + usb2 -->|yes| aq[/Apply quickstart.txt/] + usb2 -->|no| def2{Default?} + def2 -->|yes| aq + def2 -->|no| rest{REST get?} + rest -->|yes| aq + rest -->|no| aotpd[/Apply OTP Defaults/] + aq --> ist["Setup IFCFG
Enable salt-minion
Enable 128T"] + aotpd --> ist + ist --> pbs[Check for Post-Bootstrap Scriptlet] + pbs --> usb3{On USB?} + usb3 -->|yes| es2[/Execute Post-Bootstrap Scriptlet/] + usb3 -->|no| def3{Default?} + def3 -->|yes| es2 + def3 -->|no| fin[Finalize] + es2 --> fin + fin --> wbr[[Write Bootstrap Report]] + wbr --> reb[Reboot] + reb --> e([End]) +``` ### QuickStart File via REST diff --git a/docs/legacy_OTP_install.md b/docs/legacy_OTP_install.md index e8929fbd86e..ba6a896252a 100644 --- a/docs/legacy_OTP_install.md +++ b/docs/legacy_OTP_install.md @@ -7,7 +7,7 @@ The steps in this section describe installing the legacy Interactive ISO from bo :::note The Conductor installation must be completed before installing a router or routers using the OTP ISO. ::: -See [Installing Using the One Touch Provisioning ISO](intro_otp_iso_install.mdx) for details to install complex router configurations **after** installing and configuring the Conductor. +See [Installing Using the One Touch Provisioning ISO](intro_otp_iso_install.md) for details to install complex router configurations **after** installing and configuring the Conductor. ## Prerequisites diff --git a/docs/onboard_ssr_device_otp.md b/docs/onboard_ssr_device_otp.md index d261587fa11..70f19c20ee6 100644 --- a/docs/onboard_ssr_device_otp.md +++ b/docs/onboard_ssr_device_otp.md @@ -79,7 +79,7 @@ Use the process specific to your device to complete the re-imaging process. 2. From the boot menu, enter the boot device number corresponding to the USB, and press Enter. ![Select Boot Device](/img/onboard_otp_boot_device.png) -3. When the USB installer boot menu is displayed, follow the [Installing SSR Using OTP](intro_otp_iso_install.mdx#installing-ssr-using-one-touch-provisioning-otp) instructions to complete the installation process. +3. When the USB installer boot menu is displayed, follow the [Installing SSR Using OTP](intro_otp_iso_install.md#installing-ssr-using-one-touch-provisioning-otp) instructions to complete the installation process. #### SSR1000 Series Devices @@ -92,5 +92,5 @@ Use the process specific to your device to complete the re-imaging process. ![Boot Override list](/img/1x00_boot-override.png) 4. Press Enter to confirm boot from the USB device. -5. When the USB installer boot menu is displayed, follow the [Installing SSR Using OTP](intro_otp_iso_install.mdx#installing-ssr-using-one-touch-provisioning-otp) instructions to complete the installation process. +5. When the USB installer boot menu is displayed, follow the [Installing SSR Using OTP](intro_otp_iso_install.md#installing-ssr-using-one-touch-provisioning-otp) instructions to complete the installation process. diff --git a/docs/plugin_sip_alg.md b/docs/plugin_sip_alg.md index 2cd3f2d5453..8de4c9ffc0a 100644 --- a/docs/plugin_sip_alg.md +++ b/docs/plugin_sip_alg.md @@ -124,7 +124,7 @@ authority exit ``` -The service `sip-outbound-dc1` captures all SIP UDP traffic towards port 5060 originating from the [`_internal_` tenant](bcp_tenants.mdx#the-internal-tenant). This is a special tenant associated with the SFC KNIs. The `sip-service > outbound` for the sip-alg configuration refers to this user configured service in the above example. In this process, the plugin will inherit all the address and transport configuration from this _service_, combined with the defined _access-policy_ on the plugin, will generate the configuration for SIP traffic received on the lan tenant. The `ingress-service-policy` can be used to provide a custom policy to be applied to the generated service. More details on service policy design can be found [here](bcp_service_and_service_policy_design.md#service-policy) +The service `sip-outbound-dc1` captures all SIP UDP traffic towards port 5060 originating from the [`_internal_` tenant](bcp_tenants.md#the-internal-tenant). This is a special tenant associated with the SFC KNIs. The `sip-service > outbound` for the sip-alg configuration refers to this user configured service in the above example. In this process, the plugin will inherit all the address and transport configuration from this _service_, combined with the defined _access-policy_ on the plugin, will generate the configuration for SIP traffic received on the lan tenant. The `ingress-service-policy` can be used to provide a custom policy to be applied to the generated service. More details on service policy design can be found [here](bcp_service_and_service_policy_design.md#service-policy) :::note If the egress service has no transport configured, the plugin assumes the default SIP port of `5060` for both TCP and UDP. @@ -193,7 +193,7 @@ authority exit ``` -The service `sip-inbound-pbx` captures all SIP UDP traffic towards port 5060 originating from the [`_internal_` tenant](bcp_tenants.mdx#the-internal-tenant). This is a special tenant associated with the SFC KNIs. The `sip-service > inbound` for the sip-alg configuration refers to this user configured service in the above example. In this process, the plugin will inherit all the address and transport configuration from this _service_, combined with the defined _access-policy_ on the plugin, will generate the configuration for SIP traffic received on the `datacenter` tenant. The `ingress-service-policy` can be used to provide a custom policy to be applied to the generated service. More details on service policy design can be found [here](bcp_service_and_service_policy_design.md#service-policy) +The service `sip-inbound-pbx` captures all SIP UDP traffic towards port 5060 originating from the [`_internal_` tenant](bcp_tenants.md#the-internal-tenant). This is a special tenant associated with the SFC KNIs. The `sip-service > inbound` for the sip-alg configuration refers to this user configured service in the above example. In this process, the plugin will inherit all the address and transport configuration from this _service_, combined with the defined _access-policy_ on the plugin, will generate the configuration for SIP traffic received on the `datacenter` tenant. The `ingress-service-policy` can be used to provide a custom policy to be applied to the generated service. More details on service policy design can be found [here](bcp_service_and_service_policy_design.md#service-policy) :::note If the ingress service has no transport configured, the plugin assumes the default SIP port of `5060` for both TCP and UDP. diff --git a/docs/plugin_wireguard.md b/docs/plugin_wireguard.md index aa182039899..8f0bc6bd1ce 100644 --- a/docs/plugin_wireguard.md +++ b/docs/plugin_wireguard.md @@ -84,7 +84,7 @@ exit ## Services and Tenants with Wireguard -Configuration of a wireguard profile on an SSR interface does **not** provide access to network services. It simply allows the endpoint to connect to the router using wireguard for secure transport, and all sessions will still be subject to the rules of [tenants and services](concepts_glossary.md#service-layer). To facilitate network tenancy being given to traffic coming from wireguard peers, a profile is configured with a neighborhood. The neighborhood in the wireguard profile will function as a named Layer 3 network, and used in defining [neighborhood based tenancy](bcp_tenants.mdx#per-neighborhood-tenancy) to provide access to services. +Configuration of a wireguard profile on an SSR interface does **not** provide access to network services. It simply allows the endpoint to connect to the router using wireguard for secure transport, and all sessions will still be subject to the rules of [tenants and services](concepts_glossary.md#service-layer). To facilitate network tenancy being given to traffic coming from wireguard peers, a profile is configured with a neighborhood. The neighborhood in the wireguard profile will function as a named Layer 3 network, and used in defining [neighborhood based tenancy](bcp_tenants.md#per-neighborhood-tenancy) to provide access to services. :::tip If you do not have a pre-defined tenant to use for wireguard endpoints, you can optionally configure a `tenant` in the profile, and one will be automatically generated for you. diff --git a/docs/release_notes_128t_6.3.md b/docs/release_notes_128t_6.3.md index 161725f40f8..cd5140e4a80 100644 --- a/docs/release_notes_128t_6.3.md +++ b/docs/release_notes_128t_6.3.md @@ -132,8 +132,6 @@ Beginning with SSR-6.3.5, conductor-managed **routers** running SSR-6.3.5 must b ------ - **I95-63676 Waypoints fail to allocate when the `service-path peer next-hop gateway` is off the subnet:** Resolved an issue where the first network-interface IP was selected as the local IP for waypoint allocation, even if that IP is not a valid waypoint. ------ -- **I95-63976 Waypoints fail to allocate when service-path peer next-hop gateway is off the subnet:** Resolved an issue with waypoint allocation failures when using BGP over SVR with multiple IP addresses on the egress SVR interface. ------- - **I95-63729 Asset state not accurately reported in conductor:** Resolved an issue where issue where the SSH authorized keys from one HA conductor node were deleted after restarting both HA conductor nodes. ## Release 6.3.6-6-sts diff --git a/docs/release_notes_128t_7.1.md b/docs/release_notes_128t_7.1.md index e4dba12661e..6953547790b 100644 --- a/docs/release_notes_128t_7.1.md +++ b/docs/release_notes_128t_7.1.md @@ -247,6 +247,10 @@ If you have an SSR400 or SSR440, it is strongly recommended that you upgrade to ### Caveats - **I95-64317 Dropped Packets Capture continues to run:** If you have initiated a packet Capture from any page in the GUI, it will continue to run on the web server even after the request is terminated, resulting in expensive per packet export overhead. The web server must be restarted to terminate the packet capture. This issue is under investigation and will be resolved in an upcoming release. +------ +- **I95-64407 Alternate SHA ciphers (256/384/512) not working properly with ESKM:** SSR 7.1.3 introduces `sha384` and `sha512` as configurable options for the `hmac-cipher` field on security policies, alongside a new internal data structure that tracks metadata keys per HMAC mode and cipher combination. + + In deployments with peers running different versions of software and sharing security policies, configuring `hmac-cipher sha384` or `hmac-cipher sha512` in a fabric where any peer has not yet been upgraded to 7.1.3, those older versions of software will not recognize `hmac-cipher sha384` or `hmac-cipher sha512`. These devices will continue to run `sha-256-128`. Currently, no alarm or warning will be generated, and there is no performance impact. ## Release 7.1.0-50r1 diff --git a/docs/release_notes_128t_7.2.md b/docs/release_notes_128t_7.2.md new file mode 100644 index 00000000000..2655bc8be31 --- /dev/null +++ b/docs/release_notes_128t_7.2.md @@ -0,0 +1,196 @@ +--- +title: SSR 7.2 Release Notes +sidebar_label: '7.2' +--- + +The SSR has moved away from the historical package-based delivery to an image-based delivery. As such, it is strongly suggested that you revisit your "standard" procedures for installation and upgrade of SSR Software. + +Beginning with SSR v6.3.0, the use of the interactive installer is not supported, or necessary. Software installation and upgrade activities are supported from the Web Interface or the Command Line Interface. + +With the image-based ISO delivered beginning with version 6.3.0, the manual installation process no longer supports the `initialize128t` command. + +Initializing devices as a conductor or conductor-managed router is easily accomplished from the GUI using the [Initialize Your Device - Web Workflow](initialize_u-iso_device.md), or from the CLI using the the `initialize conductor` and `initialize conductor-managed` commands described in the [Initialize Your Device - Advanced Workflow](initialize_u-iso_adv_workflow.md#initialize-a-conductor) documentation. + +### Installation from ISO + +When installing SSR V6.3.0 or newer on a new system, use the image-based ISO - identified by the filename prefix "SSR": `SSR-6.3.0-107.r1.el7.x86_64.ibu-v1.iso`. Installation documentation for the image-based process can be found in the [Image-based ISO Installation Overview](intro_installation_univ-iso.md). + +Offline mode conductor and router upgrades to image-based installations are detailed in the [Single-Version 6.3.0 Upgrade](upgrade_restricted_access.md#single-version-630-upgrade) instructions. + + +### Upgrade Considerations + +:::important +Before upgrading please review the [**Upgrade Considerations**](intro_upgrade_considerations.md) and the [**Rolling Back Software**](intro_rollback.md) pages. Several modifications have been made to the process for verifying configurations, which will impact existing configurations. +::: + +:::important +After installing / upgrading to SSR 7.1.3, downgrading *to an earlier version* of SSR software where Configuration Integrity (CI) is not available is NOT supported. + +Rollback to the previously installed version of software *is* supported. +::: + +**7.0.1 Conductor Upgrades** + +If you are upgrading a conductor that is currently installed with version 6.3.4 or lower, and you wish to upgrade to version 7.0.1 or higher, you must first upgrade the conductor to any version of the 6.3.x software, including and higher than 6.3.5. + +Routers running SSR software versions earlier than 6.3.5 cannot connect to conductors running SSR software version 7.0.1 and higher. A transitional step is required to enable routers running versions earlier than 6.3.5 (6.0.x, 6.1.x, 6.2.x, 6.3.4 and lower) to communicate with a conductor running 7.0.1+. + +1. Upgrade the conductor to any version of the 6.3.x software, including and higher than 6.3.5. +2. Upon completion of the install, allow all managed routers to connect and reach the **Synchronized** state. + The new keying requirements that are part of 6.3.5+ are loaded onto the routers during synchronization. These are required for routers to communicate with a 7.0.1+ conductor. If the routers do not reach the synchronized state, those routers will not be able to communicate with the 7.0.1+ conductor. +3. Once the routers are synchronized, you may upgrade the conductor to 7.0.1. All synchronized routers, regardless of version, will be able to communicate with the upgraded conductor. The routers are not required to upgrade to 7.0.1 or to 6.3.5. + +If your conductor is currently running SSR version 6.3.5+, you may upgrade to 7.0.1 normally. + +**VM Upgrades 6.2.x to 7.x** + +Users upgrading a virtual machine, including those on AWS or Azure, previously installed with package-based SSR releases (6.2 and prior on Conductor-managed deployments only) should be aware of the following: + +Due to changes in the base SSR/Linux OS in 7.X, interface naming behavior has changed for virtual machines. Older SSR versions using earlier versions of the SSR OS may have named Linux interfaces with the `ethX` naming convention. Interfaces in 7.X and above use the Linux predictable interface naming convention as seen in SSR hardware installs. This change in interface naming could prevent existing Linux interface configurations not to apply to the `ethX`-named interface. This applies to interfaces configured directly in Linux, such as dedicated management interfaces, and **not** interfaces configured via SSR configuration. + +This issue is currently being addressed by engineering. However, if your deployment requires an upgrade to 7.X on a VM configured with interfaces using the `ethX` naming convention, please ensure that console access is available, as manual updates to the Linux interface configuration may be required. + +**System Disk Considerations** + +As mentioned above, during the upgrade to an image-based installation, existing systems will go through a conversion process to support image-based delivery. This process involves resizing the existing disk partition to support writing a new disk image to the remaining disk space. As such, the usable disk space seen after this conversion will be approximately halved. The system will automatically detect if there is not enough usable disk space on the existing drive to support this partition resizing and, if so, will trigger an upgrade failure. Even if the conversion is successful and the upgrade succeeds, users may note that the system is experiencing disk space alarms after the upgrade due to the reduction in overall capacity. It is suggested to remove unnecessary large files from systems before upgrading. Old saved tech-support-info archives (check for tar.gz or zip files in `/var/log/128technology`) and uploaded ISO images are frequent contributors to used disk space and should be manually deleted. + +In certain scenarios, existing cloud routers may have been installed from images that did not use LVM for partitions. For these systems, the automatic resizing of disk partitions will fail and they cannot be upgraded. It is suggested to rebuild these instances from the official SSR BYOL image for either [AWS](intro_installation_byol_aws_conductor.md) or [Azure](intro_installation_byol_azure_conductor.md). + +When the conductor is initially upgraded to an image-based installation, it will be upgraded as a package-based system. This is because the system does not understand how to handle image-based delivery until it is running 6.3 software. Once the conductor is running 6.3 all router upgrades will be treated as image-based upgrades and any subsequent conductor upgrade will be treated as image-based. Therefore, it is possible that issues related to disk usage on conductor may not arise until a subsequent upgrade of the conductor beyond the initial step to 6.3. + +**Offline-Mode: Upgrading 6.3.x Conductor Deployments to 6.3.x+** + +An issue has been identified that may be observed in conductor deployments running version 6.3.x software, when attempting to upgrade from one 6.3.x patch release to another. This results in the message, “SSR firmware upgrade failed for the local node: SSR upgrade failed after reboot”. To work around this, run `request system software upgrade installation-service` from the command line of the Conductor, after importing the image-based ISO. Once complete, perform the full system upgrade from the Web interface. This issue will be resolved in a future release. + +**Offline-Mode: Onboarding Routers Running older SSR Software to a 6.3.x Conductor** + +An issue has been identified when onboarding SSR routers installed with older versions of software (such as 5.4.4) to Conductors running 6.3.x, when running in offline-mode. In some cases, certain software packages are not available to be installed during onboarding. To work around this issue, import the **package-based** (the "128T" prefixed) ISO for the current conductor version onto the conductor. This provides the necessary software packages to complete the onboarding process. This issue will be resolved in a future release. + +## Release 7.2.0-24r1 + +**Release Date:** June 30, 2026 + +### New Features + +- **I95-25150 AES-GCM Encryption:** AES-GCM is now supported as a higher-performance encryption and authentication algorithm, replacing the previous AES-CBC + HMAC-SHA approach. AES-GCM combines encryption and authentication in a single operation, reducing per-packet processing overhead. The implementation includes frequent key rotation, per-path unique keys to reduce the cryptographic load on any single key, and a deterministic incrementing nonce scheme to prevent nonce reuse. For more information, see [AES-GCM Encryption](sec_security_policy.md#aes-gcm-encryption). +------ +- **I95-34472 Waypoint Pool Exhaustion Monitoring:** Added visibility into waypoint pool utilization including a `show waypoint` command that allows operators to monitor,the waypoint pool. See [`show waypoints`](cli-reference.md#show-waypoints) for more information. +------ +- **I95-55344 SSL Forward Proxy:** SSL Forward Proxy uses signed, trusted certificates to allow the SSR to perform a man-in-the-middle (MITM) function that decrypts and re-encrypts HTTPS traffic, and supports IDP and AV scans of traffic at that time. For more information, see [Configure SSL Forward Proxy](sec-ssl-fwd-proxy.md). +------ +- **I95-60371 Adaptive PMTU Change Handling for Long-Lived Sessions:** The SSR performs Path MTU Discovery (PMTUD) along the overlay to determine the correct maximum transmission unit (MTU) for each peer path. Devices in the underlay may report an ICMP Destination Unreachable / Fragmentation Needed (type 3, code 4) error to indicate they could not forward a packet due to an undersized MTU. With 7.2.0, the SSR updates the affected overlay flow and generates a corrected packet toward the original packet sender, allowing the sender to adjust its segment size. The flow which was traversed to trigger the response from the underlay is now updated to use the new updated MTU. For more information, see [Path MTU Discovery](config_pmtu.md). +------ +- **I95-61066 Simplified Interface Naming:** Simplified Interface Naming for Cloud Images: Forwarding device-interfaces can now be configured using Linux interface names instead of PCI addresses or VMBus UUIDs. This simplifies deployment in Hyper-V and Azure environments, where VMBus UUIDs are randomly generated per VM instance and require manual discovery. Template-based configurations are now more portable across hardware changes and scaled deployments. +------ +- **I95-63012 AppID Scale Optimization:** Improved application identification scalability including automatic scaling of the app-id cache by platform, enhanced sessions-per-second rate with app-id enabled, and automatic tuning of service area for app-id functionality. +------ +- **I95-64149 Enhanced Security Key Management Events:** Added system audit events for all success-path PKI operations in Certificate Management — including private key generation/deletion, certificate update/deletion, and CSR deletion — complementing the existing audit coverage for CSR generation and certificate ingest. See the [Troubleshooting section of Enhanced Security Key Managament](sec_enhanced_key_mgmt.md#troubleshooting) for additional information. +------ +- **I95-61467 Show filtered-routes in `show bgp` output:** When an inbound BGP policy rejects prefixes received from a neighbor, those routes do not appear in the BGP table or the FIB. The `filtered-routes` option exposes exactly which prefixes were suppressed by the inbound policy for a given neighbor, making it straightforward to troubleshoot why expected routes are absent from the routing table. For more information, see [Viewing Filtered BGP Routes](config_bgp.md#viewing-filtered-bgp-routes). +------ +- **I95-64435 SSR400/SSR440 FIPS Compliant EEPROM:** Migrated SSR400/SSR440 devices to a FIPS-compliant EEPROM encryption scheme, replacing the previously used RSA ES cipher. Existing inventory remains forward compatible with new SSR software. +------ +- **I95-64645 Certificate Management - CSR Improvements:** Starting in SSR 7.2.0, the peering identity can be carried in a Subject Alternative Name (SAN) URI extension instead of the Common Name (CN). This is especially useful in **HA deployments**, where both nodes in a router share the same `peering-common-name` but enterprise PKI policies require unique CNs per certificate. See [Enhanced Security Key Management — API Naming Rules](sec_enhanced_key_mgmt.md#peering-identity-via-subject-alternative-name-uri) for details. +------ +- **I95-64845 Add Additional Audit Events for Certificate APIs:** Adds several audit events and logs for certificate activity. See the [Audit Events and Logging](sec-cert-based-encrypt.md#audit-eventslogging) section of Certificate-based Security Encryption for additional information. + +### Resolved Issues + +- **The following CVEs have been identified and resolved in this release:** CVE-2023-40403, CVE-2023-43000, CVE-2025-12084, CVE-2025-13502, CVE-2025-13601, CVE-2025-13947, CVE-2025-43272, CVE-2025-43342, CVE-2025-43343, CVE-2025-43356, CVE-2025-43368, CVE-2025-43392, CVE-2025-43419, CVE-2025-43421, CVE-2025-43425, CVE-2025-43427, CVE-2025-43429, CVE-2025-43430, CVE-2025-43431, CVE-2025-43432, CVE-2025-43434, CVE-2025-43440, CVE-2025-43443, CVE-2025-43458, CVE-2025-43480, CVE-2025-43501, CVE-2025-43529, CVE-2025-43531, CVE-2025-43535, CVE-2025-43536, CVE-2025-43541, CVE-2025-53859, CVE-2025-66287, CVE-2025-67873, CVE-2025-68114, CVE-2025-68973, CVE-2025-9230, CVE-2026-1519, CVE-2026-1642, CVE-2026-25749, CVE-2026-28417, CVE-2026-28421, CVE-2026-31431, CVE-2026-32748, CVE-2026-33412, CVE-2026-33526, CVE-2026-3497, CVE-2026-35385, CVE-2026-35386, CVE-2026-35387, CVE-2026-35388, CVE-2026-35414, CVE-2026-41242, CVE-2026-43284, CVE-2026-43500, CVE-2026-4111, CVE-2026-4424, CVE-2026-4519, CVE-2026-4786, CVE-2026-5121, CVE-2026-6100. +------ +- **I95-61693 DHCP INFORM Response Improvements:** Resolved an issue where DHCP INFORM packets were not correctly answered. The DHCP ACK response now includes the requested options, ensuring clients retain vital information such as DNS servers, domain name, and gateway. +------ +- **I95-63033 `show lte detail` crash when LTE apn-name is invalid:** Resolved an issue where executing `show lte detail` when an invalid APN name is configured caused a CLI crash due to an unhandled dictionary update error. +------ +- **I95-63035 Antivirus warning when missing tenant for AV traffic:** Resolved an issue where an antivirus alert was incorrectly raised on the passive node in an HA system, indicating AV was not active. +------ +- **I95-63547 Time-based HMAC peering issues due to unsynchronized peers:** Addressed an issue where peering using time-based HMAC encryption failed when the time delta between peers exceeded 2 seconds due to unsynchronized clocks. +------ +- **I95-63673 Peer Paths `no paths` text fix:** Resolved a styling issue on the web interface where the `no paths` text on the Peer Paths page was not displayed correctly. +------ +- **I95-63794 `show lte detail` error handling for invalid APN configuration:** Resolved an issue where executing `show lte detail` with an invalid APN configuration caused a `ValueError` crash. The CLI now handles unexpected response formats gracefully. +------ +- **I95-63965 SNMP MIB subinterfaces not reporting correct stats:** Resolved an issue where SNMP MIB statistics for VLAN sub-interfaces were incorrectly reporting the same values as the parent interface instead of per-sub-interface statistics. +------ +- **I95-63966 SNMP MIB cannot retrieve description:** Resolved an issue where the SNMP interface description field was returned as empty during SNMP walks, even though the description was configured in the SSR software. +------ +- **I95-63982 Disallow upgrades when unsigned packages are present and IMA is enabled:** Added protections to prevent upgrades to unsigned packages when IMA is enabled, avoiding scenarios where the system loses connectivity after an upgrade due to unsigned executables being denied execution. +------ +- **I95-63983 System LED does not turn off after halt or shutdown:** Resolved an issue where the system LED on SSR400/SSR440 devices did not turn off or change state after a halt or shutdown, making it difficult to determine whether the unit was still running. +------ +- **I95-63955 SSR Process Inactive After Conductor Onboarding but UI shows `Synchronized`:** Resolved an issue where, after completing the Secure ConductorOnboarding (SCO) workflow in Azure with vTPM enabled, the UI incorrectly showed the device as `Synchronized` while the SSR service was inactive, triggering a `No Connectivity` alarm. +------ +- **I95-64051 AWS inconsistent interface mapping:** Resolved an issue where interface mapping in AWS deployments was inconsistent, causing the HA fabric interface to remain in the kernel while the HA sync interface was incorrectly taken by the forwarding process, preventing HA from functioning properly. +------ +- **I95-64063 Salt Minion restarting every minute when one Conductor is Unreachable:** Resolved an issue where the Salt Minion restarted once per minute whenever one conductor in a two-conductor deployment was unreachable, causing repeated instability in the management plane connection. +------ +- **I95-64150 User defined SNMP metrics not working:** Resolved an issue where user-defined SNMP metrics were not functional due to a missing configuration file (`snmpMetricsConfig.json`) and missing references in the SNMP object agent. +------ +- **I95-64152 Conductor connectivity blocked by stale SSH control sockets:** Resolved a condition where, after a router reboot (particularly following an unclean shutdown), the router could remain **Disconnected** in the Conductor due to stale SSH control sockets. The SSH coordination logic now cleans up stale control sockets automatically, restoring Conductor–router connectivity. +------ +- **I95-64221 TPM firmware update capsule support:** Added TPM firmware update capsule support in the SSR400/SSR440 firmware, enabling in-field TPM firmware updates. +------ +- **I95-64238 RADIUS Authentication Non-Functional:** Resolved an issue where RADIUS authentication produced no traffic toward the configured server. The `radsec proxy` configuration file is now placed inside an encrypted directory so that RADIUS shared secrets are protected at rest. +------ +- **I95-64250 BGP routes received but not installed in BGP table or RIB:** Resolved an issue where BGP routes from specific neighbors were received but not installed in the BGP table or RIB, requiring neighbor reconfiguration to restore route installation. +------ +- **I95-64306 Optimize ICMP probe profile update on config change:** Resolved an issue where ICMP probe profiles were unnecessarily restarted on every configuration update even when no actual changes occurred, causing excessive work and log noise. +------ +- **I95-64341 SSR400/SSR440 front panel port LEDs not turned off on reset:** Resolved an issue where the SSR400/SSR440 front panel port LEDs were not turned off when the system was reset or halted. +------ +- **I95-64344 Extended multicast traffic loss during HA failover:** Resolved an issue where multicast traffic experienced extended loss (37+ seconds) during an HA failover. +------ +- **I95-64397 Cosmetic error message on SSR1500:** Resolved an issue where cosmetic error messages about `rc.local` and `telegraf` systemd unit files were displayed on the CLI of SSR1500 devices. +------ +- **I95-64408 TCP timers for syslog connections too relaxed:** Resolved an issue where TCP connection timers for syslog were either not set or too relaxed. This resulted in excessive retransmit attempts when a syslog receiver became unavailable, delaying failover to an alternate server. +------ +- **I95-64412 Factory reset to include removal of salt cache:** Added recursive cleanup of the salt cache directory and smart sync hashes in the platform cleanup script to ensure a more complete reset. +------ +- **I95-64448 Metrics retrieval failing for node1 when HA is down:** Resolved an issue where empty data was returned when HA links were down. Peer node system metrics (CPU, memory, disk) now return an error response instead of silently returning empty data. +------ +- **I95-64479 Invalid application WEBEX not recognized:** Resolved an issue where the WEBEX application was not being recognized by the application identification module after an upgrade, resulting in `invalid application` events and missing FIB entries for the associated service. +------ +- **I95-64541 Node disconnection during upgrade:** Resolved an issue where upgrading HA router nodes could result in one node entering a disconnected state with stale SSH control sockets, while the other node became stuck in the upgrading state, requiring a manual reboot to recover. +------ +- **I95-64542 Highway crash during service path refresh:** Resolved a highway crash that occurred during service path load-balanced route refresh operations. Protections have been added to prevent the crash. +------ +- **I95-64549 Onboarding routers cannot install salt packages:** Resolved an issue where routers being onboarded to a conductor could not install the required salt packages, preventing successful onboarding. +------ +- **I95-64566 CSR generation ignores camelCase parameters:** Resolved an issue where the certificate signing request (CSR) API silently ignored camelCase parameter names (e.g., `commonName` instead of `common_name`). +------ +- **I95-64567 SSR router status Disconnected on Conductor:** Resolved an issue where configuring a loopback address on a router node caused the router to become Disconnected from the Conductor due to incorrect source NAT behavior on internal sessions. +------ +- **I95-64575 Unable to login to SSR routers from conductor in Cloud deployment:** Resolved an issue where the SSH configuration on cloud-deployed routers disabled password authentication, preventing login from the conductor. +------ +- **I95-64619 Config validate rejects DHCP network-interface when VRRP is present:** Resolved an issue where configuration validation incorrectly rejected a DHCP-enabled network-interface if VRRP was present in the configuration, even when VRRP was not enabled. +------ +- **I95-64687 Factory Reset Does Not Recursively Clean /var/cache/salt/:** Resolved an issue where factory reset operations did not recursively remove the /var/cache/salt/ directory, leaving stale salt cache files behind. The cleanup process now removes this directory recursively. +------ +- **I95-64696 Salt connectivity issues after Conductor upgrade:** Resolved an issue where salt-minion lost connectivity to the salt-master after a Conductor upgrade, affecting approximately 20% of routers. The minion-connector service now correctly manages the salt master address. +------ +- **I95-64703 Swagger Documentation for Private-Key, Certificate, and Certificate Request APIs:** Updated the Swagger API documentation to include router-level and node-level paths (`/router/{router}/node/{node}/...`) for the `private-key`, `certificate`, and `certificate-request` endpoints, which were previously documented at the top level only. +------ +- **I95-64709 Premature route installation complete notification during Graceful Restart:** Resolved a documentation discrepancy and corrected the behavior of the `stale-routes-time` parameter and its relationship to RFC 4724's `Selection_Deferral_Timer`, ensuring proper Graceful Restart route handling. +------ +- **I95-64732 Update `show peers certificate` date format:** Updated the `show peers certificate` command to use a newer API for certificate date rendering, providing a more user-friendly output format. +------ +- **I95-64829 Device disconnected from MIST and stopped processing sessions:** Resolved a highway crash triggered by a config change that caused the device to go offline and stop processing sessions, requiring a power cycle to recover. +------ +- **I95-64835 Remove UI checkbox for Rollback on Failure during Conductor migration:** Removed the erroneous `Rollback on Failure` checkbox from the Conductor migration UI, as the underlying feature was never implemented. This prevents user confusion during migration operations. +------ +- **I95-64877 Changes to guard against L7 security stack crash:** Resolved an issue where the IDP attack database was lost on reboot. The database is now stored persistently, and additional safeguards have been added for AV engine health checks, SSL certificate staging retries, and error code accuracy. +------ +- **I95-64929 Peer certificate expiration timer overflow at 49 days:** Resolved an issue where the seconds-to-milliseconds conversion for peer certificate expiration timers used unsigned 32-bit arithmetic, causing silent overflow and premature timer firing for certificates with expiration periods greater than 49 days. +------ +- **I95-64977 Certificate ingestion ignores expiry and revocation validation:** Resolved an issue where certificate ingestion did not properly enforce expiry and revocation validation results, allowing expired or revoked certificates to be ingested. +------ +- **I95-65019 TLS client peer-verification skipped when no CA certificate is configured:** Resolved a critical issue where TLS client connections without a configured CA certificate silently skipped peer verification. + +### Caveats + +- **I95-64407 Alternate SHA ciphers (256/384/512) not working properly with ESKM:** SSR 7.1.3 and 7.2.0 introduce `sha384` and `sha512` as configurable options for the `hmac-cipher` field on security policies, alongside a new internal data structure that tracks metadata keys per HMAC mode and cipher combination. + + In deployments with peers running different versions of software and sharing security policies, configuring `hmac-cipher sha384` or `hmac-cipher sha512` in a fabric where any peer has not yet been upgraded to 7.2.0 or 7.1.3, those older versions of software will not recognize `hmac-cipher sha384` or `hmac-cipher sha512`. These devices will continue to run `sha-256-128`. Currently, no alarm or warning will be generated, and there is no performance impact. + + diff --git a/docs/sec-cert-based-encrypt.md b/docs/sec-cert-based-encrypt.md index 74e52c6b9c9..0c14953f9de 100644 --- a/docs/sec-cert-based-encrypt.md +++ b/docs/sec-cert-based-encrypt.md @@ -6,7 +6,8 @@ sidebar_label: Certificate-based Security Encryption | Release | Modification | | ------- | --------------------------- | -| 7.1.0 | Certificate-based Security Encryption support added. | +| 7.1.0 | Certificate-based Security Encryption support added. | +| 7.2.0 | Subject Alternative Name support added to CSR generation. New audit events for certificate lifecycle. | In addition to Enhanced Security Key Management, the SSR offers certificate based security encryption to encrypt, validate, and exchange certificates between devices within the network. @@ -191,7 +192,7 @@ Create the following file (updated to the customers algorithm/key size preferenc ``` { - "name": "custom_ssr_peering", + "name": "my_peering_cert", "algorithm": "RSA", "rsa_key_size": "2048" } @@ -206,19 +207,19 @@ curl -k -X POST https://10.27.35.89/api/v1/private-key -d @key_request.json ``` -Upon success, you can verify that the key was created by logging on to the SSR, `ssh` into a linux shell, and ensuring that `/etc/128technology/pki/custom_ssr_peering.key` exists on disk. +Upon success, you can verify that the key was created by logging on to the SSR, `ssh` into a linux shell, and ensuring that `/etc/128technology/pki/my_peering_cert.key` exists on disk. ### Issue a `certificate-signing-request` In order to create a signed certificate by the CA for the SSR, the CA needs a `certificate-signing-request`. Instruct the SSR to create the request using the values provided; at a minimum the `name` and `common-name`. The SSR must sign the request with its private-key. -1. Create a file that contains the body of the CSR-request. At a minimum this must include the name `custom_ssr_peering`, and the common name: +1. Create a file that contains the body of the CSR-request. At a minimum this must include the `name` and the `common_name`: **csr_request.json** ``` { - "name": "custom_ssr_peering", + "name": "my_peering_cert", "common_name": "SSR_12345679" } ``` @@ -235,6 +236,7 @@ This example represents the minimum requirements. Any of the following additiona - rsa_key_size (integer, optional): The RSA key size. Only valid when algorithm is set to “RSA”. Valid key sizes are any multiple of 256 between 2048 and 4096. - ecc_curve (string, optional): The ECC curve to use. Only valid when algorithm is set to “ECC”.Valid curves are: (SECP256R, SECP384R1, SECP521R1) - validity_period (integer, optional): The validity period in days. +- subject_alt_names (array, optional, SSR 7.2.0+): An array of Subject Alternative Name entries to include in the CSR. Each entry is an object with `type` and `value` fields. Supported types: `dns`, `ip`, `email`, `uri`, `urn_ssr_peering`. For details, see [Configure Certificate Management](config_custom_certs.md#issue-a-certificate-signing-request). 2. Issue the CSR request to the SSR: @@ -270,7 +272,7 @@ When the signed certificate is returned, instruct the SSR to ingest the certific ``` { - "name": "custom_ssr_peering", + "name": "my_peering_cert", "certificate": "-----BEGIN CERTIFICATE----- MIIF3DCCBESgAwIBAgIKAf9HQjJKSQd1lTANBgkqhkiG9w0BAQsFADBaMQswCQYD VQQGEwJERTERMA8GA1UECgwIT3BlblhQS0kxDDAKBgNVBAsMA1BLSTEqMCgGA1UE @@ -288,8 +290,8 @@ Once the certificate is successfully ingested, verify that the certificate was a 1. `ssh` to the SSR. 2. Log in as the root user: `sudo su`. -3. Verify that `/etc/128technology/pki/custom_ssr_peering.pem` exists on disk. - `ls -l /etc/128technology/pki/custom_ssr_peering.pem` +3. Verify that `/etc/128technology/pki/my_peering_cert.pem` exists on disk. + `ls -l /etc/128technology/pki/my_peering_cert.pem` ### Configure the Certificate @@ -380,7 +382,20 @@ Audit events and logs are generated for the following events: Node: test-1 Description: Generated CSR for: TestCertificate Json Event Detail: {"name":"TestCertificate","common_name":"example.com","country_name":"US","state_province_name":"California","locality_name":"San - Francisco","organization_name":"ExampleOrg","organizational_unit_name":"IT","email_address":"admin@example.com","validity_period_days":365} + Francisco","organization_name":"ExampleOrg","organizational_unit_name":"IT","email_address":"admin@example.com","validity_period_days":365,"subject_alt_names":[]} + Permitted: True +``` + +- Generate Private Key + +``` +======================================================================================================================================================= + 2025-03-19T20:50:35.173Z Generated private key. +======================================================================================================================================================= + Type: system.generate_private_key + Node: test-1 + Description: Generated private key for: TestCertificate + Json Event Detail: {"name":"TestCertificate","algorithm":"RSA","rsa_key_size":2048} Permitted: True ``` @@ -409,3 +424,55 @@ Audit events and logs are generated for the following events: GMT","crl_url":"http://10.27.39.143/testCrl.pem","size":14162,"total_entries":279,"added_entries":0,"removed_entries":0,"success":true,"certificate_authority":"/C=US/O=Google Trust Services/CN=WR2"} Permitted: True ``` + +- Update Certificate + +``` +======================================================================================================================================================= + 2025-03-26T21:22:43.108Z Updated a certificate. +======================================================================================================================================================= + Type: system.update_certificate + Node: test-1 + Description: Updated certificate: TestCertificate + Json Event Detail: {"purpose":"TLS Web Client Authentication","common_name":"example.com","crl_urls":[],"certificate_authority":"N/A","fingerprint":"6D:C7:8E:48:4F:55:63:D9:AB:70:66:CD:29:4E:1C:37:CF:89:17:B0"} + Permitted: True +``` + +- Delete Certificate + +``` +======================================================================================================================================================= + 2025-03-26T21:22:43.108Z Deleted a certificate. +======================================================================================================================================================= + Type: system.delete_certificate + Node: test-1 + Description: Deleted certificate: TestCertificate + Json Event Detail: {"name":"TestCertificate"} + Permitted: True +``` + +- Delete Private Key + +``` +======================================================================================================================================================= + 2025-03-26T21:22:43.108Z Deleted a private key. +======================================================================================================================================================= + Type: system.delete_private_key + Node: test-1 + Description: Deleted private key: TestCertificate + Json Event Detail: {"name":"TestCertificate"} + Permitted: True +``` + +- Delete CSR + +``` +======================================================================================================================================================= + 2025-03-26T21:22:43.108Z Deleted a certificate signing request. +======================================================================================================================================================= + Type: system.delete_csr + Node: test-1 + Description: Deleted CSR: TestCertificate + Json Event Detail: {"name":"TestCertificate"} + Permitted: True +``` diff --git a/docs/sec-ssl-fwd-proxy.md b/docs/sec-ssl-fwd-proxy.md new file mode 100644 index 00000000000..7c760048db5 --- /dev/null +++ b/docs/sec-ssl-fwd-proxy.md @@ -0,0 +1,146 @@ +--- +title: Configure SSL Forward Proxy +sidebar_label: Configure SSL Forward Proxy +--- + +SSL Forward Proxy uses signed, trusted certificates to allow the SSR to perform a man-in-the-middle (MitM) function that decrypts and re-encrypts HTTPS traffic. This allows IDP and AV scans of the traffic to be performed at that time. By installing CA signed certificates into the Trusted Root Certification Authorities store of all client end-users' browsers and devices, malicious servers are prevented from performing MITM impersonation attacks against the client endpoints. + +SSL Forward Proxy is used in conjuction with the IDP and Anti-Virus features available with the SSR, and can be applied on the same access policy and service. Configuring an SSL forward proxy security profile (Strong, Medium, or Weak) indicates which security cipher suite is used. For more information about the available security cipher suites, see the [Supported SSL Ciper List](https://www.juniper.net/documentation/us/en/software/junos/application-identification/topics/topic-map/security-ssl-cipher-suites-for-ssl-proxy.html#id-digital-certificates-and-certificate-authorities__supported_ciphers). + +The following are the high level steps necessary to configure SSL Forward Proxy: + +- Acquire a CA-Signed Certificate: For use with SSL Forward Proxy, a self-signed certificate will not work. It must be signed by a public, trusted CA. +- Distribute Certificates: Install the proxy's CA certificate into the Trusted Root Certification Authorities store of all client end-users' browsers and devices. If this step is missed, users will receive severe certificate trust warnings. +- Configure Security Policies: Create an SSL Proxy profile and attach it to your WAN edge. The device will begin intercepting designated HTTPS traffic. + +:::note +Conductor-managed deplpoyments using SSL Forward Proxy are currently only supported on SSR1200, SSR1300, SSR1400, and SSR1500. +::: + +## Configuration Using the Conductor GUI + +Use the following steps to configure SSL Forward Proxy using the SSR Conductor GUI. + +1. From the Configuration menu, select Authority, and then click on the Authority tile. + +![Authority Level](/img/fwd-proxy-authority1.png) + +2. Scroll down to the Trusted CA Certificate, and click **ADD**. + +![Add Trusted Certificate](/img/fwd-proxy-trustedca-cert2.png) + +3. Enter a name for the certificate and click **SAVE**. + +![Name the Certificate](/img/fwd-proxy-catest3.png) + +4. In the **Trusted CA Certificate** details, under Validation Mode select `warn` from the drop down. + +5. Select **Content** from the drop down under **Certificate Details** + +6. In the Certififcate Content field, paste the contents of the certificate, including the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` lines. + +![Certificate Content](/img/fwd-proxy-add-cert-content.png) + +7. Click Validate and Commit. + +8. Scroll down to the **Client Certificate** field below Trusted CA Certificate, and click **ADD**. + +9. Enter a Name for the client certificate. + +![Client Certificate](/img/fwd-proxy-add-client1.png) + +10. In the Client Certificate details, under Validation Mode select `warn` from the drop down. + +11. Select **Content** from the drop down under **Certificate Details** + +12. In the Certififcate Content field, paste the contents of the certificate, including the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` lines. + +![Client Certificate Details](/img/fwd-proxy-add-client2.png) + +### Create the Profile + +Create SSL-Proxy Profile using the uploaded certificates and other details. + +1. Scroll down to SSL Profiles and click **ADD**. + +![SSL profile creation](/img/fwd-proxy-ssl-profiles.png) + +2. Enter the profile name. + +![Profile Name](/img/fwd-proxy-ssl-profilename.png) + +3. In the SSL Proxy Profile screen, select the policy level for the profile, and add the Root CA and Intermediate Certificates. These are available under the drop down for each field. + +![Profile settings](/img/fwd-proxy-ssl-profile-settings.png) + +### Add the SSL Profile to the Access Policy + +Add the SSL Profile to the Access Policy of the service. + +1. Return to the Authority level. + +![Return to Authority](/img/fwd-proxy-return-authority.png) + +2. Scroll down to **Services**. Select or create the Service that will use the SSL forward proxy. + +3. Under the Service, scroll down to **Access Policies** and click **ADD**. + +4. In the New Access Policy window, enter the Source name. + +![New Access Policy](/img/fwd-proxy-access-policy-name.png) + +5. Define the Access policy to suit your needs, and under **SSL Proxy Profile** select the proxy profile defined earlier. + +![Access Policy Defined](/img/fwd-proxy-define-access-policy.png) + +6. If the Access policy you want to associate with the SSL proxy profile already exists, select it, and under **SSL Proxy Profile** select the proxy profile defined earlier. + +7. Click **Validate**, and **Commit**. + +## CLI Configuration Example + +The following is the above configuration shown in the CLI. + +``` +config + authority + trusted-ca-certificate ssl-proxy-cert + name ssl-proxy-cert + content + (text/plain) + validation-mode warn + exit + + client-certificate ssl-client-proxy-cert + name ssl-client-proxy-cert + content + (text/plain) + validation-mode warn + exit + + ssl-proxy-profile ssl-fwdproxy-profile1 + name ssl-fwdproxy-profile1 + policy medium + client-certificate ssl-client-proxy-cert + root-ca-certificate ssl-proxy-cert + ignore-server-authentication false + exit + + service idp-service + name idp-service + enabled true + scope private + + access-policy Branch-idp + ssl-proxy-profile ssl-fwdproxy-profile1 + source Branch-idp + permission allow + exit + exit + +``` + + + + + diff --git a/docs/sec_enhanced_key_mgmt.md b/docs/sec_enhanced_key_mgmt.md index b29455f9c61..15d2d385f79 100644 --- a/docs/sec_enhanced_key_mgmt.md +++ b/docs/sec_enhanced_key_mgmt.md @@ -9,6 +9,7 @@ sidebars-label: Enhanced Security Key Management | ------- | --------------------------- | | 7.0.1 | Enhanced Security Key Management support added. | | 7.1.3 | Support for ML-KEM added. | +| 7.2.0 | Subject Alternative Name (SAN) URI support for peering identity. | Security is a critical component of [SD-WAN (software-defined wide area network)](https://www.juniper.net/us/en/products/routers/session-smart-router.html) products in today’s market. [The SSR (Session Smart Router)](about_128t.md) offers several means of ensuring the integrity of data transmitted through the router, such as encrypting application payload content, encrypting SVR (Secure Vector Routing) metadata, and authentication for metadata. @@ -69,7 +70,7 @@ When using CA-signed certificates, the end-to-end provisioning sequence must be 1. Authenticate to the Conductor REST API (`POST /api/v1/login`) and store the bearer token. 2. Generate a private key on the target router's node (`POST /api/v1/router//node//private-key`) — the key never leaves the SSR. -3. Generate a CSR on the same target (`GET /api/v1/router//node//certificate-request`) using a `common_name` that matches that router's `peering-common-name`. +3. Generate a CSR on the same target (`GET /api/v1/router//node//certificate-request`) using a `common_name` that matches that router's `peering-common-name`, or alternatively, using any unique `common_name` with a `urn:ssr:peering` SAN URI that matches the `peering-common-name`. See [API Naming Rules](#api-naming-rules) for details. 4. Submit the CSR to your Certificate Authority and obtain a signed certificate. 5. Ingest the signed certificate back into the SSR (`POST /api/v1/router//node//certificate`). 6. **Activate the certificate in configuration** — having the file on disk is not sufficient. Configure `authority client-certificate` with a `name` and `file` matching the API artifact name. See [Activating the Certificate in Configuration](#activating-the-certificate-in-configuration). @@ -84,16 +85,54 @@ Consistent naming across all API calls and configuration is critical: | Field | Scope | Rule | |---|---|---| -| `name` (in all API requests) | Authority-wide | **Must be identical across all routers and nodes.** Use `custom_ssr_peering` in SSR 7.0.x (reserved name). In SSR 7.1+, any consistent name may be used. | -| `common_name` (in CSR request) | Per-router / per-node | **Must be unique per router or HA node**, and must **exactly match** that router's configured `peering-common-name`. | -| `peering-common-name` (in config) | Per-router | Unique alias per router. Must match the `common_name` used in that router's CSR. | +| `name` (in all API requests) | Authority-wide | **Must be identical across all routers and nodes.** In SSR 7.1+, any consistent name may be used. | +| `common_name` (in CSR request) | Per-router / per-node | **Must be unique per router or HA node.** Must match the router's configured `peering-common-name` — unless a `urn:ssr:peering` SAN URI is used to carry the peering identity instead (see below). | +| `peering-common-name` (in config) | Per-router | Unique alias per router. Must match either the `common_name` or a `urn:ssr:peering` SAN URI in that router's certificate. | -**Example mapping for a two-router deployment:** +:::note Legacy Name +In SSR 7.0.x, the `name` field was required to be `custom_ssr_peering` (a reserved name). This is no longer required in SSR 7.1+. If no certificate is configured, the SSR will fall back to searching for certificates named `custom_ssr_peering` on disk for backward compatibility. +::: + +#### Peering Identity via Subject Alternative Name URI + +Starting in SSR 7.2.0, the peering identity can be carried in a Subject Alternative Name (SAN) URI extension instead of the Common Name (CN). This is especially useful in **HA deployments**, where both nodes in a router share the same `peering-common-name` but enterprise PKI policies require unique CNs per certificate. + +When verifying a peer's identity, the SSR checks the certificate CN first. If the CN does not match the configured `peering-common-name`, the SSR falls back to checking for a SAN URI of the form: + +``` +urn:ssr:peering: +``` + +If a matching SAN URI is found, the certificate is accepted. This allows each HA node to have a unique CN while sharing the same peering identity through the SAN URI. -| Router | `peering-common-name` in config | `common_name` in CSR | `name` in all API requests | -|---|---|---|---| -| combo-east | `east-alias` | `east-alias` | `custom_ssr_peering` | -| combo-west | `west-alias` | `west-alias` | `custom_ssr_peering` | +To include a SAN URI in a CSR, add a `subject_alt_names` array to the CSR request body using the `urn_ssr_peering` convenience type: + +```json +{ + "name": "my_peering_cert", + "common_name": "combo-east-node1", + "subject_alt_names": [ + {"type": "urn_ssr_peering", "value": "east-alias"} + ] +} +``` + +The `urn_ssr_peering` type automatically expands the value to `URI:urn:ssr:peering:`. For the full list of supported SAN types, see [Configure Certificate Management](config_custom_certs.md#issue-a-certificate-signing-request). + +**Example: Traditional CN-based identity (single node per router)** + +| Router | `peering-common-name` | `common_name` in CSR | SAN URI | `name` in API | +|---|---|---|---|---| +| combo-east | `east-alias` | `east-alias` | *(not needed)* | `my_peering_cert` | +| combo-west | `west-alias` | `west-alias` | *(not needed)* | `my_peering_cert` | + +**Example: SAN URI identity (HA — unique CN per node)** + +| Router | Node | `peering-common-name` | `common_name` in CSR | SAN URI | `name` in API | +|---|---|---|---|---|---| +| combo-east | node1 | `east-alias` | `combo-east-node1` | `urn:ssr:peering:east-alias` | `my_peering_cert` | +| combo-east | node2 | `east-alias` | `combo-east-node2` | `urn:ssr:peering:east-alias` | `my_peering_cert` | +| combo-west | node1 | `west-alias` | `combo-west-node1` | `urn:ssr:peering:west-alias` | `my_peering_cert` | #### Activating the Certificate in Configuration @@ -196,6 +235,10 @@ When provisioning certificates for an HA router, you must execute the private-ke The same node-scoped pattern applies to the `/certificate-request` and `/certificate` endpoints. The request body — including the `name` field — is identical for both nodes. Consult the Swagger documentation at `https:///api/v1/swagger` for the full per-node endpoint schema. ::: +:::tip Unique Common Names in HA (SSR 7.2.0+) +Because both HA nodes share the same `peering-common-name`, earlier releases required both nodes to use an identical `common_name` in their certificates. Starting in SSR 7.2.0, you can use a [SAN URI](#peering-identity-via-subject-alternative-name-uri) to carry the peering identity, allowing each node to have a unique CN — for example, `combo-east-node1` and `combo-east-node2` — while both certificates include the same `urn:ssr:peering:east-alias` SAN URI. +::: + When two nodes are configured as a redundant pair, the keys are exchanged between nodes. This avoids rekeying on flow migration due to node failures. Keys can be safely exchanged between nodes as the HA sync interfaces are connected point to point over an SSH connection. ### Certificate Replacement or Revocation @@ -210,7 +253,13 @@ When a certificate is revoked, expired, or invalid, the SSR generates an alarm. Peer validation is done whenever a new certificate is added, or peer configuration has changed. When a certificate is received, a cached validation response is used. If configured, the received certificate is validated against the `trusted-ca-certificate` list. -When receiving a certificate from a peer router and performing validation, the receiving router extracts and saves the peer router's public key. This is used for validating the authenticity of any subsequent Peer Key/Rekey requests. +When receiving a certificate from a peer router and performing validation, the receiving router checks the certificate's identity against the peer's configured `peering-common-name` using the following order: + +1. **Common Name (CN) check** — if the certificate's CN matches the peer's `peering-common-name`, the certificate is accepted. +2. **SAN URI fallback (SSR 7.2.0+)** — if the CN does not match, the SSR checks for a `urn:ssr:peering:` SAN URI in the certificate's Subject Alternative Name extension. If found, the certificate is accepted. +3. **Rejection** — if neither the CN nor any SAN URI matches, the certificate is rejected. How the SSR handles the certificate rejection is defined using the `invalid-certificate-behavior` setting (`fail-soft` or `fail-hard`). + +After successful validation, the receiving router extracts and saves the peer router's public key. This is used for validating the authenticity of any subsequent Peer Key/Rekey requests. ### Requirements @@ -233,7 +282,7 @@ config 2. Configure a unique `peering-common-name` on each router. In a secure environment, the router name should never be sent between routers as plaintext in BFD messages. The `peering-common-name` is a **unique alias per router** that identifies the router and is configured at the router level. When `enhanced-security-key-management` is configured, it is validated against the `peering-common-name` from the certificate, and integrated into the auto-generated adjacencies list for the peers of the router from the neighborhood configuration. :::note -The `peering-common-name` must exactly match the `common_name` field used in the certificate signing request (CSR) generated for that router. See [API Naming Rules](#api-naming-rules) for the full field mapping. +The `peering-common-name` must match either the `common_name` field or a `urn:ssr:peering` SAN URI in the certificate generated for that router. See [API Naming Rules](#api-naming-rules) for the full field mapping. ::: When the SSR generates the CSR, it embeds the `peering-common-name` into a Subject Alternative Name (SAN) of type URI, formatted as `urn:ssr:peering:`. During HA peering, each node validates its peer by matching this SAN URI. Each node still uses its own unique certificate and private key; the certificates are not shared between nodes. Because the `peering-common-name` is configured per router, every node in an HA router carries the same `urn:ssr:peering:` URI in its individual certificate, which is what allows the peer to validate either node against the expected identity. diff --git a/docs/sec_security_policy.md b/docs/sec_security_policy.md index f667db0a4ed..a726c8f1b20 100644 --- a/docs/sec_security_policy.md +++ b/docs/sec_security_policy.md @@ -131,3 +131,144 @@ Retrieving session information... Attributes: Metadata Security Policy: ``` + +## AES-GCM Encryption + +:::note +AES-GCM encryption is available in SSR version 7.2.0 and above. +::: + +### Overview + +The SSR supports **AES-GCM** (Advanced Encryption Standard – Galois/Counter Mode) as an additional encryption option for session traffic. AES-GCM is an Authenticated Encryption with Associated Data (AEAD) cipher, meaning it provides both **confidentiality** and **integrity** protection in a single cryptographic operation, rather than combining a separate cipher and HMAC as with AES-CBC modes. + +AES-GCM is applied per-packet after SSR session encapsulation. Both SSR metadata and session payload are independently protected, and authentication failures cause the packet to be silently discarded. No changes to routing, session establishment, or service policy behavior are introduced by enabling AES-GCM. + +### Behavior And Compatibility + +| Property | Behavior | +|---|---| +| Confidentiality | Per-packet encryption of SSR metadata and payload. | +| Integrity | Authenticated; authentication failure causes immediate packet discard. | +| HMAC settings | Ignored when AES-GCM is selected — authentication is inherent to GCM. | +| Peer compatibility | If the remote peer does not support AES-GCM, the session falls back to the mutually supported cipher according to existing SSR negotiation behavior. | +| Mixed-version fabrics | Supported, provided peers negotiate a mutually supported cipher. | +| Platform requirement | Requires OpenSSL with GCM capability; supported on existing SSR hardware platforms. | + +### Configuring AES-GCM + +AES-GCM is selected by setting the `encryption-cipher` field of a security policy to the appropriate AES-GCM value, either `aes-gcm-128` or `aes-gcm-256`. The security policy is then applied in the same locations as any other cipher: + +- `service > security-policy` — payload encryption for sessions +- `network-interface > inter-router-security` — metadata decryption on received SVR traffic +- `network-interface > adjacency > inter-router-security` — metadata encryption for SVR traffic sent to a peer +- `router > inter-node-security` — encryption for HA inter-node communication + +``` +configure authority security + encryption-cipher aes-gcm-256 + encrypt true + hmac-mode disabled +``` + +:::note +Because AES-GCM provides built-in authentication, `hmac-mode` should be set to `disabled`. Any HMAC configuration is ignored at runtime when AES-GCM is the selected cipher. +::: + +:::caution +Changing an encryption cipher is a service-impacting event. Existing sessions cannot be re-keyed in-place. Follow the guidance in [Changing A Security Policy](#changing-a-security-policy) and perform the change during a maintenance window. +::: + +### Verifying AES-GCM Is In Use + +After applying the new policy, use `show sessions by-id` to confirm the cipher is active on new sessions. The **Payload Security Policy** and **Metadata Security Policy** fields identify which security policy is applied per flow. The **Action List** fields include the GCM encryption and `decryption actions: `AesGcmEncrypt`, `AesGcmDecrypt`, `AesGcmEncryptSvr2`, and `AesGcmDecryptSvr2. Confirm that the policy you configured with AES-GCM is listed for the expected flows. + +``` +admin@test1.combo1# sho sessions by-id 37ed5241-d5d5-4120-b168-884c619935a4 +Thu 2026-05-14 12:00:14 UTC +Retrieving session information... + +============================================================================================================================================================================ + combo1.test1 Session ID: 37ed5241-d5d5-4120-b168-884c619935a4 +============================================================================================================================================================================ + Service Name: east + Service Route Name: + Session Source: SourceType: INTER_ROUTER + Session Type: HTTPS + Service Class: Standard + Source Tenant: red + Destination Peer Name: N/A + Source Peer Name: combo2 + Inter Node: N/A + Inter Router: N/A + Ingress Source Nat: N/A + Payload Security Policy: aes1 + Payload Encrypted: True + Common Name Info: N/A + Tcp Time To Establish: N/A + Tls Time To Establish: N/A + Domain Name: N/A + Uri: N/A + Category: N/A + Override Service Name: N/A + App Stats Tracking Key: N/A + Session Keys: + Forward Session Key: [discriminator 4294967297, tenant red, peer combo2, src ip 172.16.2.201, dest ip 172.16.1.201, src port 443, dest port 10000, proto 17] + Reverse Session Key: [discriminator 4294967297, tenant red, peer combo2, src ip 172.16.1.201, dest ip 172.16.2.201, src port 10000, dest port 443, proto 17] + State Info: + Session State: ESTABLISHED + Redundancy State: SYNCED + Time Info: + Start Time: 0 days 0:00:12 + Ttl Duration For Database: 1900 + Forward Flows: + Key: [src ip 172.16.3.2, dest ip 172.16.3.1, src port 16384, dest port 16385, proto 17, interface 2.0] + Direction: forward + Tcp State: N/A + Packets Received: 999 + Packets Sent: 999 + Bytes Received: 152563 + Bytes Sent: 123876 + Tcp Retransmission Count: N/A + Decrypt Security Policy: interfabric + Action List: Ingress AesGcmDecryptMetadata ForwardMetadataRemove AesGcmDecrypt TtlValidateIpv4 IpHeaderTransform EthernetHeaderTransform AppForward + Time To Live: 1897 + Path Index: 5 + Attributes: + Path Key: NextHop : 1-1.0=172.16.1.201, destination Ip 172.16.1.0/24 + Arp Status: Valid + Waypoint Key: + Source Nat Key: + Metadata Security Policy: + Reverse Flows: + Key: [src ip 172.16.1.201, dest ip 172.16.2.201, src port 10000, dest port 443, proto 17, interface 1.0] + Direction: reverse + Tcp State: N/A + Packets Received: 995 + Packets Sent: 995 + Bytes Received: 123380 + Bytes Sent: 151464 + Tcp Retransmission Count: N/A + Decrypt Security Policy: + Action List: Ingress TtlValidateIpv4 IpHeaderTransform AesGcmEncrypt AppMetadataAdd AesGcmEncryptMetadata EthernetHeaderTransform AppForward + Time To Live: 1897 + Path Index: 5 + Attributes: + Path Key: NextHop : 1-2.0=172.16.3.2, destination Ip 172.16.3.2/32 + Arp Status: Valid + Waypoint Key: + Source Nat Key: + Metadata Security Policy: interfabric + App Identification: + Application: east + Domain Name: N/A + Uri: N/A + Category: N/A + Subcategory: N/A + Override Service Name: N/A + App Stats Tracking Key: N/A + +Completed in 0.07 seconds +``` + + diff --git a/docusaurus.config.js b/docusaurus.config.js index 1959f84cd39..d48f1f277bb 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,4 +1,4 @@ -module.exports = { +const config = { title: 'SSN Docs', tagline: 'The documentation source for the Session Smart Networking Platform', url: 'https://docs.128technology.com', @@ -117,7 +117,7 @@ module.exports = { }; if (process.env.OFFLINE_DOCS) { - module.exports.themeConfig.announcementBar = { + config.themeConfig.announcementBar = { id: 'offline_docs', content: 'You are viewing a local version of this documentation. ' + @@ -127,3 +127,5 @@ if (process.env.OFFLINE_DOCS) { isCloseable: true, }; } + +module.exports = config; diff --git a/sidebars.js b/sidebars.js index 62516699e34..4c8c8bdbce0 100644 --- a/sidebars.js +++ b/sidebars.js @@ -33,6 +33,7 @@ module.exports = { "type": "category", "label": "SSR", "items": [ + "release_notes_128t_7.2", "release_notes_128t_7.1", "release_notes_128t_7.0", "release_notes_128t_6.3", @@ -205,7 +206,7 @@ module.exports = { "label": "Router Installation", "items": [ "intro_installation_bootable_media", - "intro_basic_router_config", + "intro_basic_router_config", "intro_otp_iso_install", "intro_install_quickstart_otpiso", "onboard_ssr_to_conductor", @@ -313,6 +314,7 @@ module.exports = { "config_prefix_delegation", "config_session_recovery", "config_forward_error_correction", + "config_pmtu", "config_management_over_forwarding", "config_domain-based_web_filter", "config_EthoSVR", @@ -393,6 +395,7 @@ module.exports = { "config_syslog_tls", "config_webserver_certs", "howto_trusted_ca_certificate", + "sec-ssl-fwd-proxy", "config_password_security", "config_password_policies", "howto_reset_user_password", diff --git a/src/components/Flowchart.jsx b/src/components/Flowchart.jsx deleted file mode 100644 index 6f758111fd1..00000000000 --- a/src/components/Flowchart.jsx +++ /dev/null @@ -1,41 +0,0 @@ -import React from 'react'; -import PropTypes from 'prop-types'; -import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment'; - -class Flowchart extends React.Component { - constructor(props) { - super(props); - - this.state = {}; - } - - componentDidMount() { - if (ExecutionEnvironment.canUseDOM) { - this.setState({ - Flowchart: require('react-simple-flowchart').default, - }); - } - } - - render() { - const {Flowchart} = this.state; - const {chartCode, scale = 0.7} = this.props; - - if (!ExecutionEnvironment.canUseDOM || !Flowchart) { - return

; - } - - return ( -
- -
- ); - } -} - -Flowchart.propTypes = { - chartCode: PropTypes.string.isRequired, - scale: PropTypes.number, -}; - -export default Flowchart; diff --git a/src/theme/Mermaid.js b/src/theme/Mermaid.js deleted file mode 100644 index 7d6376db3ee..00000000000 --- a/src/theme/Mermaid.js +++ /dev/null @@ -1,15 +0,0 @@ -import React, { useEffect } from "react"; -import mermaid from "mermaid"; - -mermaid.initialize({ - startOnLoad: true -}); - -const Mermaid = ({ chart }) => { - useEffect(() => { - mermaid.contentLoaded(); - }, []); - return
{chart}
; -}; - -export default Mermaid; \ No newline at end of file diff --git a/static/img/fwd-proxy-access-policy-name.png b/static/img/fwd-proxy-access-policy-name.png new file mode 100644 index 00000000000..792f2136433 Binary files /dev/null and b/static/img/fwd-proxy-access-policy-name.png differ diff --git a/static/img/fwd-proxy-add-cert-content.png b/static/img/fwd-proxy-add-cert-content.png new file mode 100644 index 00000000000..e7c5b9b68d2 Binary files /dev/null and b/static/img/fwd-proxy-add-cert-content.png differ diff --git a/static/img/fwd-proxy-add-client1.png b/static/img/fwd-proxy-add-client1.png new file mode 100644 index 00000000000..76d4c268fc5 Binary files /dev/null and b/static/img/fwd-proxy-add-client1.png differ diff --git a/static/img/fwd-proxy-add-client2.png b/static/img/fwd-proxy-add-client2.png new file mode 100644 index 00000000000..bff18a8bc93 Binary files /dev/null and b/static/img/fwd-proxy-add-client2.png differ diff --git a/static/img/fwd-proxy-authority1.png b/static/img/fwd-proxy-authority1.png new file mode 100644 index 00000000000..ec7b82df2d7 Binary files /dev/null and b/static/img/fwd-proxy-authority1.png differ diff --git a/static/img/fwd-proxy-catest3.png b/static/img/fwd-proxy-catest3.png new file mode 100644 index 00000000000..9cdebed1c1a Binary files /dev/null and b/static/img/fwd-proxy-catest3.png differ diff --git a/static/img/fwd-proxy-define-access-policy.png b/static/img/fwd-proxy-define-access-policy.png new file mode 100644 index 00000000000..7d3e56d5979 Binary files /dev/null and b/static/img/fwd-proxy-define-access-policy.png differ diff --git a/static/img/fwd-proxy-return-authority.png b/static/img/fwd-proxy-return-authority.png new file mode 100644 index 00000000000..1df00372c9c Binary files /dev/null and b/static/img/fwd-proxy-return-authority.png differ diff --git a/static/img/fwd-proxy-ssl-profile-settings.png b/static/img/fwd-proxy-ssl-profile-settings.png new file mode 100644 index 00000000000..5a010fdbced Binary files /dev/null and b/static/img/fwd-proxy-ssl-profile-settings.png differ diff --git a/static/img/fwd-proxy-ssl-profilename.png b/static/img/fwd-proxy-ssl-profilename.png new file mode 100644 index 00000000000..ea50ba2a9fc Binary files /dev/null and b/static/img/fwd-proxy-ssl-profilename.png differ diff --git a/static/img/fwd-proxy-ssl-profiles.png b/static/img/fwd-proxy-ssl-profiles.png new file mode 100644 index 00000000000..f7b93c7a9ae Binary files /dev/null and b/static/img/fwd-proxy-ssl-profiles.png differ diff --git a/static/img/fwd-proxy-trustedca-cert2.png b/static/img/fwd-proxy-trustedca-cert2.png new file mode 100644 index 00000000000..b159c6a80a7 Binary files /dev/null and b/static/img/fwd-proxy-trustedca-cert2.png differ