saa commands
configure
— saa
— apply-groups reference
— apply-groups-exclude reference
— owner named-item test named-item
— accounting-policy reference
— admin-state keyword
— apply-groups reference
— apply-groups-exclude reference
— continuous boolean
— description description
— jitter-event keyword threshold-type keyword
— apply-groups reference
— apply-groups-exclude reference
— threshold number
— latency-event keyword threshold-type keyword
— apply-groups reference
— apply-groups-exclude reference
— threshold number
— loss-event keyword threshold-type keyword
— apply-groups reference
— apply-groups-exclude reference
— threshold number
— probe-history keyword
— type
— icmp-ping
— apply-groups reference
— apply-groups-exclude reference
— bypass-routing boolean
— count number
— destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
— do-not-fragment boolean
— interface interface-name
— interval (number | decimal-number)
— next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
— pattern (keyword | number)
— qos
— fc keyword
— tos number
— router-instance string
— size number
— source-address (ipv4-address-no-zone | ipv6-address-no-zone)
— timeout number
— trap-generation
— probe-fail boolean
— probe-fail-threshold number
— test-complete boolean
— test-fail boolean
— test-fail-threshold number
— ttl number
— lsp-ping
— apply-groups reference
— apply-groups-exclude reference
— interval number
— qos
— fc keyword
— profile keyword
— send-count number
— size number
— source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
— sub-type
— bgp-label
— path-destination
— interface interface-name
— ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
— next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
— prefix (ipv4-prefix | ipv6-prefix)
— ldp
— path-destination
— interface interface-name
— ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
— next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
— prefix (ipv4-prefix | ipv6-prefix)
— rsvp-te
— lsp-name named-item-64
— path named-item-64
— sr-isis
— igp-instance number
— path-destination
— interface interface-name
— ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
— next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
— prefix (ipv4-prefix | ipv6-prefix)
— sr-ospf
— igp-instance number
— path-destination
— interface interface-name
— ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
— next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
— prefix (ipv4-prefix | ipv6-prefix)
— sr-policy
— color number
— endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
— path-destination
— interface interface-name
— ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
— next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
— segment-list number
— sr-te
— lsp-name named-item-64
— path named-item-64
— path-destination
— interface interface-name
— ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
— next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
— timeout number
— trap-generation
— probe-fail boolean
— probe-fail-threshold number
— test-complete boolean
— test-fail boolean
— test-fail-threshold number
— ttl number
— sdp-ping
— apply-groups reference
— apply-groups-exclude reference
— count number
— interval number
— originating-sdp-identifier number
— qos
— fc keyword
— profile keyword
— responder-sdp-identifier number
— size number
— timeout number
— trap-generation
— probe-fail boolean
— probe-fail-threshold number
— test-complete boolean
— test-fail boolean
— test-fail-threshold number
saa command descriptions
saa
owner [owner-name] named-item test named-item
[owner-name] named-item
Synopsis | Optional owner name of the SAA operation | |
Context | configure saa owner named-item test named-item | |
Tree | owner | |
Description | This command configures the owner associated with the SAA operation. | |
String length | 1 to 32 | |
MD-CLI default | TiMOS CLI | |
Notes | This element is part of a list key. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
test named-item
accounting-policy reference
WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. | ||
Synopsis | Accounting policy associated with the SAA test | |
Context | configure saa owner named-item test named-item accounting-policy reference | |
Tree | accounting-policy | |
Reference | configure log accounting-policy number | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
admin-state keyword
Synopsis | Administrative state of the SAA test | |
Context | configure saa owner named-item test named-item admin-state keyword | |
Tree | admin-state | |
Options | ||
Default | disable | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
continuous boolean
WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. | ||
Synopsis | Execute the SAA tests as continuous | |
Context | configure saa owner named-item test named-item continuous boolean | |
Tree | continuous | |
Description | When configured to true, the SAA test execution is continuous, that is, it cannot be started or stopped with the oam saa test start or stop commands. The SAA test types supported by this command include the following:
| |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
description description
Synopsis | Text description | |
Context | configure saa owner named-item test named-item description description | |
Tree | description | |
String length | 1 to 80 | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
jitter-event [direction] keyword threshold-type keyword
Synopsis | Enter the jitter-event list instance | |
Context | configure saa owner named-item test named-item jitter-event keyword threshold-type keyword | |
Tree | jitter-event | |
Description | Commands in this context configure the jitter event thresholds used to evaluate the jitter event value at the termination of an SAA test probe. The system generates SAA threshold events as required. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
[direction] keyword
Synopsis | Direction for OAM ping responses for OAM ping test run | |
Context | configure saa owner named-item test named-item jitter-event keyword threshold-type keyword | |
Tree | jitter-event | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
threshold-type keyword
Synopsis | Threshold type | |
Context | configure saa owner named-item test named-item jitter-event keyword threshold-type keyword | |
Tree | jitter-event | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
threshold number
Synopsis | Threshold jitter value | |
Context | configure saa owner named-item test named-item jitter-event keyword threshold-type keyword threshold number | |
Tree | threshold | |
Description | This command specifies the threshold jitter value. The system generates an SAA threshold event when the jitter value of the test run crosses the threshold value. | |
Range | 0 to 2147483647 | |
Units | microseconds | |
Notes | This element is mandatory. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
latency-event [direction] keyword threshold-type keyword
Synopsis | Enter the latency-event list instance | |
Context | configure saa owner named-item test named-item latency-event keyword threshold-type keyword | |
Tree | latency-event | |
Description | Commands in this context configure the latency event thresholds used to evaluate the latency event value at the termination of an SAA test probe. The system generates SAA threshold events as required. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
[direction] keyword
Synopsis | Direction for OAM ping responses for OAM ping test run | |
Context | configure saa owner named-item test named-item latency-event keyword threshold-type keyword | |
Tree | latency-event | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
threshold-type keyword
Synopsis | Threshold type | |
Context | configure saa owner named-item test named-item latency-event keyword threshold-type keyword | |
Tree | latency-event | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
threshold number
Synopsis | Threshold latency value | |
Context | configure saa owner named-item test named-item latency-event keyword threshold-type keyword threshold number | |
Tree | threshold | |
Description | This command specifies the threshold latency value. The system generates an SAA threshold event when the latency value of the test run crosses the threshold value. | |
Range | 0 to 2147483647 | |
Units | microseconds | |
Notes | This element is mandatory. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
loss-event [direction] keyword threshold-type keyword
Synopsis | Enter the loss-event list instance | |
Context | configure saa owner named-item test named-item loss-event keyword threshold-type keyword | |
Tree | loss-event | |
Description | Commands in this context configure the loss event thresholds used to evaluate the loss event value at the termination of an SAA test probe. The system generates SAA threshold events as required. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
[direction] keyword
Synopsis | Direction for OAM ping responses for OAM ping test run | |
Context | configure saa owner named-item test named-item loss-event keyword threshold-type keyword | |
Tree | loss-event | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
threshold-type keyword
Synopsis | Threshold type | |
Context | configure saa owner named-item test named-item loss-event keyword threshold-type keyword | |
Tree | loss-event | |
Options | ||
Notes | This element is part of a list key. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
threshold number
Synopsis | Threshold loss event value | |
Context | configure saa owner named-item test named-item loss-event keyword threshold-type keyword threshold number | |
Tree | threshold | |
Description | This command specifies the threshold loss value. The system generates an SAA threshold event when the loss value of the test run crosses the threshold value. | |
Range | 0 to 2147483647 | |
Units | packets | |
Notes | This element is mandatory. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
probe-history keyword
WARNING: Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect. | ||
Synopsis | History probe behavior | |
Context | configure saa owner named-item test named-item probe-history keyword | |
Tree | probe-history | |
Options | ||
Default | auto | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
type
icmp-ping
Synopsis | Enable the icmp-ping context | |
Context | configure saa owner named-item test named-item type icmp-ping | |
Tree | icmp-ping | |
Description | Commands in this context configure an ICMP ping test. | |
Notes | The following elements are part of a choice: dns, eth-cfm-loopback, icmp-ping, lsp-ping, sdp-ping, or vccv-ping. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
bypass-routing boolean
Synopsis | Bypass routing table for directly connected interfaces | |
Context | configure saa owner named-item test named-item type icmp-ping bypass-routing boolean | |
Tree | bypass-routing | |
Default | false | |
Notes | The following elements are part of a choice: bypass-routing, interface, or next-hop-address. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
count number
destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
Synopsis | Destination IP address or DNS name to send ping request | |
Context | configure saa owner named-item test named-item type icmp-ping destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces) | |
Tree | destination-address | |
String length | 1 to 128 | |
Notes | This element is mandatory. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
do-not-fragment boolean
Synopsis | Do not fragment echo request packets (valid for IPv4) | |
Context | configure saa owner named-item test named-item type icmp-ping do-not-fragment boolean | |
Tree | do-not-fragment | |
Description | This command sets the Do Not Fragment (DF) bit in the IPv4 header. This prevents packet fragmentation along the path when there is an MTU mismatch. | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interface interface-name
interval (number | decimal-number)
next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Next-hop IP address to reach destination | |
Context | configure saa owner named-item test named-item type icmp-ping next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | next-hop-address | |
Notes | The following elements are part of a choice: bypass-routing, interface, or next-hop-address. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
pattern (keyword | number)
qos
fc keyword
Synopsis | Forwarding class | |
Context | configure saa owner named-item test named-item type icmp-ping qos fc keyword | |
Tree | fc | |
Options | be – Best effort l2 – Low 2 (best effort) af – Assured forwarding (assured) l1 – Low 1 (assured) h2 – High 2 (high priority) ef – Expedited forwarding (high priority) h1 – High 1 (high priority) nc – Network control (high priority) | |
Default | nc | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
tos number
router-instance string
Synopsis | Router name or VPRN service name | |
Context | configure saa owner named-item test named-item type icmp-ping router-instance string | |
Tree | router-instance | |
Default | Base | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
size number
Synopsis | Packet padding size | |
Context | configure saa owner named-item test named-item type icmp-ping size number | |
Tree | size | |
Description | This command configures the number of bytes in the combined ICMP Header (8 bytes) and ICMP Payload (variable size) of the ICMP Echo Request packets. | |
Range | 0 to 16384 | |
Units | bytes | |
Default | 56 | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
source-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Source IP address | |
Context | configure saa owner named-item test named-item type icmp-ping source-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | source-address | |
Description | This command configures the source IP address to be loaded into the IP header of the ICMP Echo Request packet. If unconfigured, the router uses a system-selected local address. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
timeout number
trap-generation
Synopsis | Enter the trap-generation context | |
Context | configure saa owner named-item test named-item type icmp-ping trap-generation | |
Tree | trap-generation | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
probe-fail boolean
Synopsis | Enable the generation of probe fail notifications | |
Context | configure saa owner named-item test named-item type icmp-ping trap-generation probe-fail boolean | |
Tree | probe-fail | |
Description | When configured to true, the system generates an SNMP trap if the consecutive probe failure threshold is reached during the execution of the SAA ping test. This command is not applicable to SAA traceroute tests. | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
probe-fail-threshold number
Synopsis | Consecutive probe failure count | |
Context | configure saa owner named-item test named-item type icmp-ping trap-generation probe-fail-threshold number | |
Tree | probe-fail-threshold | |
Description | This command configures the number of consecutive ping probe failures required to generate a trap. This command has no effect if the probe-fail command is set to false. This command is not applicable to SAA traceroute tests. | |
Range | 0 to 15 | |
Default | 1 | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
test-complete boolean
Synopsis | Enable generation of test complete notifications | |
Context | configure saa owner named-item test named-item type icmp-ping trap-generation test-complete boolean | |
Tree | test-complete | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
test-fail boolean
Synopsis | Enable the generation of test fail notifications | |
Context | configure saa owner named-item test named-item type icmp-ping trap-generation test-fail boolean | |
Tree | test-fail | |
Description | When configured to true, the system generates a trap if a test fails. In the case of a ping test, the test is considered to have failed (for trap generation) if the number of failed probes is at least the value of the test-fail-threshold setting. | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
test-fail-threshold number
Synopsis | Total probe failures for trap generation | |
Context | configure saa owner named-item test named-item type icmp-ping trap-generation test-fail-threshold number | |
Tree | test-fail-threshold | |
Description | This command configures the number of consecutive test failures required to generate a trap. This command has no effect when test-fail is set to false. This command is not applicable to SAA traceroute tests. | |
Range | 0 to 15 | |
Default | 1 | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
ttl number
lsp-ping
Synopsis | Enable the lsp-ping context | |
Context | configure saa owner named-item test named-item type lsp-ping | |
Tree | lsp-ping | |
Description | Commands in this context configure the command options to perform in-band LSP connectivity tests. LSP ping uses the protocol and data structures defined in RFC 8029, Detecting Multiprotocol Label Switched (MPLS) Data-Plane Failures. | |
Notes | The following elements are part of a choice: dns, eth-cfm-loopback, icmp-ping, lsp-ping, sdp-ping, or vccv-ping. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interval number
qos
fc keyword
Synopsis | Forwarding class | |
Context | configure saa owner named-item test named-item type lsp-ping qos fc keyword | |
Tree | fc | |
Options | be – Best effort l2 – Low 2 (best effort) af – Assured forwarding (assured) l1 – Low 1 (assured) h2 – High 2 (high priority) ef – Expedited forwarding (high priority) h1 – High 1 (high priority) nc – Network control (high priority) | |
Default | be | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
profile keyword
send-count number
Synopsis | Number of request packets to send in a sample window | |
Context | configure saa owner named-item test named-item type lsp-ping send-count number | |
Tree | send-count | |
Range | 1 to 100 | |
Units | packets | |
Default | 1 | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
size number
source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Source IP address | |
Context | configure saa owner named-item test named-item type lsp-ping source-ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | source-ip-address | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
sub-type
bgp-label
Synopsis | Enable the bgp-label context | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type bgp-label | |
Tree | bgp-label | |
Notes | The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
path-destination
Synopsis | Enter the path-destination context | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type bgp-label path-destination | |
Tree | path-destination | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interface interface-name
Synopsis | Egress router interface used with the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type bgp-label path-destination interface interface-name | |
Tree | interface | |
String length | 1 to 32 | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | IP address of the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type bgp-label path-destination ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | ip-address | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Egress IP next hop address used with path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type bgp-label path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | next-hop | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
prefix (ipv4-prefix | ipv6-prefix)
ldp
path-destination
Synopsis | Enter the path-destination context | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type ldp path-destination | |
Tree | path-destination | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interface interface-name
Synopsis | Egress router interface used with the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type ldp path-destination interface interface-name | |
Tree | interface | |
String length | 1 to 32 | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | IP address of the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type ldp path-destination ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | ip-address | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Egress IP next hop address used with path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type ldp path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | next-hop | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
prefix (ipv4-prefix | ipv6-prefix)
rsvp-te
lsp-name named-item-64
path named-item-64
sr-isis
igp-instance number
Synopsis | IGP instance for the SR IS-IS test | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-isis igp-instance number | |
Tree | igp-instance | |
Range | 0 to 127 | |
Default | 0 | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
path-destination
Synopsis | Enter the path-destination context | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-isis path-destination | |
Tree | path-destination | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interface interface-name
Synopsis | Egress router interface used with the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-isis path-destination interface interface-name | |
Tree | interface | |
String length | 1 to 32 | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | IP address of the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-isis path-destination ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | ip-address | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Egress IP next hop address used with path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-isis path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | next-hop | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
prefix (ipv4-prefix | ipv6-prefix)
sr-ospf
igp-instance number
Synopsis | IGP instance for the SR OSPF test | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-ospf igp-instance number | |
Tree | igp-instance | |
Range | 0 to 31 | |
Default | 0 | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
path-destination
Synopsis | Enter the path-destination context | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-ospf path-destination | |
Tree | path-destination | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interface interface-name
Synopsis | Egress router interface used with the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-ospf path-destination interface interface-name | |
Tree | interface | |
String length | 1 to 32 | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | IP address of the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-ospf path-destination ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | ip-address | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Egress IP next hop address used with path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-ospf path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | next-hop | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
prefix (ipv4-prefix | ipv6-prefix)
sr-policy
Synopsis | Enable the sr-policy context | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-policy | |
Tree | sr-policy | |
Notes | The following elements are part of a choice: bgp-label, ldp, rsvp-te, sr-isis, sr-ospf, sr-ospf3, sr-policy, or sr-te. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
color number
endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
path-destination
Synopsis | Enter the path-destination context | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-policy path-destination | |
Tree | path-destination | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interface interface-name
Synopsis | Egress router interface used with the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-policy path-destination interface interface-name | |
Tree | interface | |
String length | 1 to 32 | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | IP address of the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-policy path-destination ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | ip-address | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Egress IP next hop address used with path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-policy path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | next-hop | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
segment-list number
Synopsis | Segment Routing segment list for the test | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-policy segment-list number | |
Tree | segment-list | |
Range | 1 to 32 | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
sr-te
lsp-name named-item-64
path named-item-64
path-destination
Synopsis | Enter the path-destination context | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-te path-destination | |
Tree | path-destination | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interface interface-name
Synopsis | Egress router interface used with the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-te path-destination interface interface-name | |
Tree | interface | |
String length | 1 to 32 | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | IP address of the path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-te path-destination ip-address (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | ip-address | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis | Egress IP next hop address used with path destination | |
Context | configure saa owner named-item test named-item type lsp-ping sub-type sr-te path-destination next-hop (ipv4-address-no-zone | ipv6-address-no-zone) | |
Tree | next-hop | |
Notes | The following elements are part of a choice: interface or next-hop. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
timeout number
trap-generation
Synopsis | Enter the trap-generation context | |
Context | configure saa owner named-item test named-item type lsp-ping trap-generation | |
Tree | trap-generation | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
probe-fail boolean
Synopsis | Enable the generation of probe fail notifications | |
Context | configure saa owner named-item test named-item type lsp-ping trap-generation probe-fail boolean | |
Tree | probe-fail | |
Description | When configured to true, the system generates an SNMP trap if the consecutive probe failure threshold is reached during the execution of the SAA ping test. This command is not applicable to SAA traceroute tests. | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
probe-fail-threshold number
Synopsis | Consecutive probe failure count | |
Context | configure saa owner named-item test named-item type lsp-ping trap-generation probe-fail-threshold number | |
Tree | probe-fail-threshold | |
Description | This command configures the number of consecutive ping probe failures required to generate a trap. This command has no effect if the probe-fail command is set to false. This command is not applicable to SAA traceroute tests. | |
Range | 0 to 15 | |
Default | 1 | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
test-complete boolean
Synopsis | Enable generation of test complete notifications | |
Context | configure saa owner named-item test named-item type lsp-ping trap-generation test-complete boolean | |
Tree | test-complete | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
test-fail boolean
Synopsis | Enable the generation of test fail notifications | |
Context | configure saa owner named-item test named-item type lsp-ping trap-generation test-fail boolean | |
Tree | test-fail | |
Description | When configured to true, the system generates a trap if a test fails. In the case of a ping test, the test is considered to have failed (for trap generation) if the number of failed probes is at least the value of the test-fail-threshold setting. | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
test-fail-threshold number
Synopsis | Total probe failures for trap generation | |
Context | configure saa owner named-item test named-item type lsp-ping trap-generation test-fail-threshold number | |
Tree | test-fail-threshold | |
Description | This command configures the number of consecutive test failures required to generate a trap. This command has no effect when test-fail is set to false. This command is not applicable to SAA traceroute tests. | |
Range | 0 to 15 | |
Default | 1 | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
ttl number
sdp-ping
Synopsis | Enable the sdp-ping context | |
Context | configure saa owner named-item test named-item type sdp-ping | |
Tree | sdp-ping | |
Description | Commands in this context configure tests on SDPs for unidirectional or round-trip connectivity, as well as for performing SDP MTU path tests. | |
Notes | The following elements are part of a choice: dns, eth-cfm-loopback, icmp-ping, lsp-ping, sdp-ping, or vccv-ping. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
count number
Synopsis | Number of SDP echo request packets to send | |
Context | configure saa owner named-item test named-item type sdp-ping count number | |
Tree | count | |
Description | This command specifies the number of echo request packets to send. Each request must either time out or receive a reply before the next message request is sent. The interval value must expire before the next message request is sent. | |
Range | 1 to 100 | |
Units | packets | |
Default | 1 | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
interval number
originating-sdp-identifier number
Synopsis | SDP ID used to send packets | |
Context | configure saa owner named-item test named-item type sdp-ping originating-sdp-identifier number | |
Tree | originating-sdp-identifier | |
Description | This command specifies the SDP ID that is used by SDP ping. The far-end address of the specified SDP ID is the expected responder ID within each reply received. The SDP ID defines the SDP tunnel encapsulation used to reach the far end. This can be IP/GRE or MPLS. If this ID is invalid, administratively down, or otherwise unavailable, the SDP echo request message is not sent, and an error message is displayed. After the interval timer expires, the SDP ping attempts to send the next request, if required. | |
Range | 1 to 32767 | |
Notes | This element is mandatory. | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
qos
fc keyword
Synopsis | FC for the transmitted SDP echo request packets | |
Context | configure saa owner named-item test named-item type sdp-ping qos fc keyword | |
Tree | fc | |
Options | be – Best effort l2 – Low 2 (best effort) af – Assured forwarding (assured) l1 – Low 1 (assured) h2 – High 2 (high priority) ef – Expedited forwarding (high priority) h1 – High 1 (high priority) nc – Network control (high priority) | |
Default | be | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
profile keyword
responder-sdp-identifier number
Synopsis | SDP ID used by the far-end to reply to the request | |
Context | configure saa owner named-item test named-item type sdp-ping responder-sdp-identifier number | |
Tree | responder-sdp-identifier | |
Description | This command configures the return SDP ID to be used by the far-end router for the message reply for round-trip SDP connectivity testing. If this ID does not exist on the far-end router, or terminates on a different router from the originating router, or another issue prevents the far-end router from using this ID, the SDP echo reply is sent using generic IP or GRE OAM encapsulation. The received FC (as mapped on the ingress network interface for the far end) defines the FC encapsulation for the reply message. | |
Range | 1 to 32767 | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
size number
Synopsis | Size of the SDP echo request packets | |
Context | configure saa owner named-item test named-item type sdp-ping size number | |
Tree | size | |
Description | This command configures the size of the SDP echo request packets, which includes the SDP header and payload. The size does not include the SDP encapsulation, VC label (if applied), or any DLC headers or trailers. | |
Range | 72 to 9786 | |
Units | bytes | |
Default | 72 | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
timeout number
Synopsis | Maximum time to wait for SDP echo reply packets | |
Context | configure saa owner named-item test named-item type sdp-ping timeout number | |
Tree | timeout | |
Description | This command configures the time the router waits for a message reply after sending the last probe for a specific test. When the timeout expires, the test is marked complete and no more packets are processed. | |
Range | 1 to 10 | |
Units | seconds | |
Default | 5 | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
trap-generation
Synopsis | Enter the trap-generation context | |
Context | configure saa owner named-item test named-item type sdp-ping trap-generation | |
Tree | trap-generation | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
probe-fail boolean
Synopsis | Enable the generation of probe fail notifications | |
Context | configure saa owner named-item test named-item type sdp-ping trap-generation probe-fail boolean | |
Tree | probe-fail | |
Description | When configured to true, the system generates an SNMP trap if the consecutive probe failure threshold is reached during the execution of the SAA ping test. This command is not applicable to SAA traceroute tests. | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
probe-fail-threshold number
Synopsis | Consecutive probe failure count | |
Context | configure saa owner named-item test named-item type sdp-ping trap-generation probe-fail-threshold number | |
Tree | probe-fail-threshold | |
Description | This command configures the number of consecutive ping probe failures required to generate a trap. This command has no effect if the probe-fail command is set to false. This command is not applicable to SAA traceroute tests. | |
Range | 0 to 15 | |
Default | 1 | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |
test-complete boolean
Synopsis | Enable generation of test complete notifications | |
Context | configure saa owner named-item test named-item type sdp-ping trap-generation test-complete boolean | |
Tree | test-complete | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
test-fail boolean
Synopsis | Enable the generation of test fail notifications | |
Context | configure saa owner named-item test named-item type sdp-ping trap-generation test-fail boolean | |
Tree | test-fail | |
Description | When configured to true, the system generates a trap if a test fails. In the case of a ping test, the test is considered to have failed (for trap generation) if the number of failed probes is at least the value of the test-fail-threshold setting. | |
Default | false | |
Introduced | 25.3.R2 | |
Platforms | 7705 SAR Gen 2 |
test-fail-threshold number
Synopsis | Total probe failures for trap generation | |
Context | configure saa owner named-item test named-item type sdp-ping trap-generation test-fail-threshold number | |
Tree | test-fail-threshold | |
Description | This command configures the number of consecutive test failures required to generate a trap. This command has no effect when test-fail is set to false. This command is not applicable to SAA traceroute tests. | |
Range | 0 to 15 | |
Default | 1 | |
Introduced | 25.3.R2 | |
Platforms |
7705 SAR Gen 2 |