sa

Prev Next

sa add metric

sa add metric - Add a performance metric to an Service Availability instance

Description:

Add a performance metric to Service Availability instance.

Syntax:

sa add metric <sa-name> <metric-name> {
            {paa-plr <paa-id>} |
            {paa-ow-delay <paa-id>} |
            {paa-ow-dv <paa-id>} |
            {paa-tw-delay <paa-id>} |
            {paa-tw-dv <paa-id>} |
            {cfm-plr <pl-id>} |
            {dmm-ow-delay <dmm-id>} |
            {dmm-ow-dv <dmm-id>} |
            {dmm-tw-delay <dmm-id>} |
            {dmm-tw-dv <dmm-id>} | 
            {slm-near-end-plr <slm-id>} |
            {slm-far-end-plr <slm-id>} |
            {threshold <decimal>} }+
    <dmm-id>      = <decimal> | <string>
  <paa-id>      = <decimal> | <string>
  <pl-id>       = <decimal> | <string>  
  <slm-id>      = <decimal> | <string>  
  <metric-name> = <string>
  <sa-name>     = <string>

Parameters:

Parameter Description
<sa-name> The name of a service availability instance.
<metric-name> A unique name to identify a metric instance inside a service availability instance.
<paa-id> The identifier of a PAA instance. Instance number or instance name.
<pl-id> CFM packet loss instance identifier. Instance number or instance name.
<dmm-id> CFM DMM instance identifier. Instance number or instance name.
<threshold> The threshold used to determine if the metric performs correctly.
paa-plr The performance metric is packet loss from a PAA instance.
paa-ow-delay The performance metric is one-way delay from a PAA instance.
paa-ow-dv The performance metric is one-way delay variation from a PAA instance.
paa-tw-delay The performance metric is two-way delay from a PAA instance.
paa-tw-dv The performance metric is two-way delay variation from a PAA instance.
cfm-plr The performance metric is a CFM packet loss instance.
dmm-ow-delay The performance metric is one-way delay from a DMM instance.
dmm-ow-dv The performance metric is one-way delay variation from a DMM instance.
dmm-tw-delay The performance metric is two-way delay from a DMM instance.
dmm-tw-dv The performance metric is two-way delay variation from a DMM instance.
slm-near-end-plr The performance metric is near end SLM packet loss.
slm-far-end-plr The performance metric is far end SLM packet loss.

Description:

Syntax:


sa add service

sa add service - Creates a Service Availability instance

Description:

Use this command to create a new Service Availability (SA) instance. SA is used to calculate the number of seconds for which a specific service is unavailable. Each SA instance is configured with one or more SA metrics such as CFM frame loss that are used to determine the unavailable seconds.

Syntax:

sa add service <sa-name> {
                {window-size <decimal>} |
                {reporting-period <decimal>} |
                {hli-window-size <decimal>} |
                {time-interval <decimal>} |
                {client-port-cutoff-state <enable | disable>} |
                {client-port <port-name>} |
                {client-port-cutoff-delay <decimal>} |
                {client-port-restore-delay <decimal>}}+

<sa-name> = <string>
<port-name> = <string>

Parameters:

Parameter Description
<sa-name> A unique name to identify a service availability instance.
window-size The number of consecutive time intervals used to assess SA for this instance. Default value is 10.
reporting-period A reporting period over which periodic availability counters are evaluated in addition to the monotonic counters. Default value is 15 minutes.
time-interval The interval of time during which the metric is evaluated. Default value is 1 second. Allowed values are 1, 5, 10, 20, or 60 seconds.
hli-window-size The number of consecutive Time Intervals used to assess Consecutive High Loss Intervals for this instance. Default value is 3.
client-port-cutoff-state Specifies whether or not the Client Port Cut-Off feature is enabled. When enabled, it monitors SA availability and suspends traffic on the specified port if SA parameters are not met. Default: disabled.
client-port Specifies the name of the traffic port whose operations will be suspended when the SA instance is not meeting the threshold of one or more of its service metrics. Default: first traffic port (e.g., PORT-1).
client-port-cutoff-delay The amount of time to wait after experiencing a network link degradation before disabling the port. Default: 0 (immediate). Range: 0 to 120 seconds.
client-port-restore-delay The amount of time to wait after the network link recovers from a degradation before enabling the port. Default: 120 seconds. Range: 0 to 300 seconds.

sa clear service counters

sa clear service counters - Clear service availability counters

Description:

Clear service availability counters.

Syntax:

sa clear service counters [name <sa-name>] [type {periodic|monotonic|all}]
  <sa-name> = <string>

Parameters:

Parameter Description
name The name of a service availability instance. If omitted, clears all instances of the selected counters.
type The type of counter to clear:
  • periodic: Clear periodic counters. Default.
  • monotonic: Clear monotonic counters.
  • all: Clear all counters.

sa delete metric

sa delete metric - Remove a performance metric from a Service Availability instance

Description:

Remove a performance metric from a Service Availability instance.

Syntax:

sa delete metric <sa-name> <metric-name>
  <sa-name>     = <string>
  <metric-name> = <string>

Parameters:

Parameter Description
<sa-name> The name of a service availability instance.
<metric-name> The name of the metric to remove.

sa delete service

sa delete service - Delete a Service Availability instance

Description:

Delete a Service Availability instance.

Syntax:

sa delete service <sa-name>
  <sa-name> = <string>

Parameters:

Parameter Description
<sa-name> A unique name identifying a service availability instance.

sa edit metric

sa edit metric - Modify a performance metric on a Service Availability instance

Description:

Modify a performance metric on a Service Availability instance.

Syntax:

sa edit metric <sa-name> <metric-name> {
         name <metric-name> threshold {<plr-thld> | <delay-thld>}}

  <sa-name>     = <string>
  <metric-name> = <string>
  <delay-thrld> = <decimal>
  <plr-thld>    = <decimal>

Parameters:

Parameter Description
<sa-name> The name of a service availability instance.
<metric-name> The name of a metric instance inside the service availability instance.
name The new name to assign to the metric instance.
threshold A packet loss ratio threshold or a delay threshold, depending on the metric type.

sa edit service

sa edit service - Modify a Service Availability instance

Description:

Use this command to edit an existing Service Availability (SA) instance. SA is used to calculate the number of seconds for which a specific service is unavailable. Each SA instance is configured with one or more SA metrics such as CFM frame loss that are used to determine the unavailable seconds.

Syntax:

sa edit service <sa-name> {{name <string>} |
                 {window-size <decimal>} |
                 {time-interval <decimal>} |
                 {hli-window-size <decimal>} |
                 {reporting-period <decimal>} |
                 {state <is | oos>} |
                 {client-port-cutoff-state <enable | disable>} |
                 {client-port <port-name>} |
                 {client-port-cutoff-delay <decimal>} |
                 {client-port-restore-delay <decimal>}}+

  <sa-name> = <string>
  <port-name> = <string>

Parameters:

Parameter Description
<sa-name> The name of the SA instance.
name A new name to assign to the service instance.
window-size The number of consecutive seconds over which to assess availability. Default is 10.
time-interval The interval of time during which the metric is evaluated. Default value is 1 second. Allowed values are 1, 5, 10, 20, or 60 seconds.
hli-window-size The number of consecutive time intervals used to assess Consecutive High Loss Intervals for this instance. Default value is 3.
reporting-period A reporting period over which availability counters are evaluated in addition to the monotonic counters. Default value is 15 minutes.
state The instance state:
  • is (In Service): Availability must be assessed.
  • oos (Out of Service): Availability assessment is suspended. This is the default state.
client-port-cutoff-state Specifies whether or not the Client Port Cut-Off feature is enabled. When enabled, it monitors SA availability and suspends traffic on the specified port if SA parameters are not met. Default: disabled.
client-port Specifies the name of the traffic port whose operations will be suspended when the SA instance is not meeting the threshold of one or more of its service metrics. Default: first traffic port (e.g., PORT-1).
client-port-cutoff-delay The amount of time to wait after experiencing a network link degradation before disabling the port. Default: 0 (immediate). Range: 0 to 120 seconds.
client-port-restore-delay The amount of time to wait after the network link recovers from a degradation before enabling the port. Default: 120 seconds. Range: 0 to 300 seconds.

sa show metric configuration

sa show metric configuration - Display detailed performance metric configuration

Description:

Display detailed performance metric configuration.

Syntax:

sa show metric configuration <sa-name> <metric-name>
  <metric-name> = <string>
  <sa-name>     = <string>

Parameters:

Parameter Description
<sa-name> The name of a service availability instance.
<metric-name> The name of the metric to display.

sa show metric counters

sa show metric counters - Display metric counters for a service availability instance

Description:

Display metric counters for a service availability instance. When a metric instance name is specified, detailed availability counters are displayed for the specified instance. Otherwise, a summary of all metric counters for the service instance are displayed.

Syntax:

sa show metric counters <sa-name> [<metric-name>] [type historic 
                          {buckets | period } value]

<sa-name> = The name of a service availability instance.

Parameters:

Parameter Description
<metric-name> An optional metric instance name to display.
type historic The type of history statistics to retrieve. Options are buckets or periods.
value The period index or the number of buckets to display.

sa show service configuration

sa show service configuration - Display service availability configuration

Description:

Display service availability configuration. When an instance name specified, a detailed configuration report is displayed for the specified instance. Otherwise, a configuration summary for all instances is displayed.

Syntax:

sa show service configuration [<sa-name>]
  <sa-name> = <string>

Parameters:

Parameter Description
<sa-name> Optional service instance name to display.

sa show service counters

sa show service counters - Display service availability counters

Description:

Display service availability counters. When an instance name is specified, detailed availability counters are displayed for the specified instance. Otherwise, a summary of all availability counters for all instances are displayed. Additionally, if the history feature is enabled, history information may be displayed by specifying the type.

Syntax:

sa show service counters [<sa-name>] [type historic {buckets | period } 
                            value]

  <sa-name> = <string> 

Parameters:

Parameter Description
<sa-name> An optional instance name to display.
type historic The type of history statistics to retrieve. Options are buckets or periods.
value The period index or the number of buckets to display.

© 2025 Cisco and/or its affiliates. All rights reserved.
 
For more information about trademarks, please visit: Cisco trademarks
For more information about legal terms, please visit: Cisco legal terms

For legal information about Accedian Skylight products, please visit: Accedian legal terms and tradmarks