s Commands
s-pmsi
s-pmsi
Syntax
s-pmsi [{vpnSrcAddr [vpnGrpAddr]} [mdSrcAddr]]
no s-pmsi
Context
[Tree] (debug>router>pim s-pmsi)
Full Context
debug router pim s-pmsi
Description
This command enables debugging for PIM selective provider multicast service interface.
The no form of this command disables the debugging.
Parameters
- vpnSrcAddr
-
Specifies the VPN source address.
- vpnGrpAddr
-
Specifies the VPN group address.
- mdSrcAddr
-
Specifies the source address of the multicast domain.
Platforms
All
s-tag
s-tag
Syntax
s-tag qtag1 c-tag-range qtag2 [to qtag2]
no s-tag qtag1 c-tag-range qtag2
Context
[Tree] (config>service>system>bgp-evpn>eth-seg>qinq s-tag)
Full Context
configure service system bgp-evpn ethernet-segment qinq s-tag
Description
This command determines the inner VIDs (for a specified outer VID) associated with the virtual Ethernet Segment on a specific qinq port or LAG based on the following:
-
Values *, null, 0 to 4094 are allowed.
-
Any SAP for which the outer and inner service-delimiting qtags match the range is associated with the virtual ES, and only those, for example, SAP 1/1/1:10.* will not match port 1/1/1, s-tag 10 c-tag-range 10 to 100.
-
A maximum of 8 ranges (including the s-tag ranges) are allowed in the qinq context.
-
A c-tag range can be comprised of a single qtag.
-
Shutting down the ES is not required prior to making changes.
-
A qtag included in the s-tag-range command cannot be included in the s-tag qtag of this command.
Not all qtag1 and qtag2 combinations are valid for values 0, *, and null. The following combinations are allowed:
-
s-tag 0 c-tag-range *
-
s-tag * c-tag-range *
-
s-tag * c-tag-range null
-
s-tag null c-tag-range null
-
s-tag X c-tag-range 0 (where: X=1 to 4094)
-
s-tag X c-tag-range * (where: X=1 to 4094)
The no form of the command removes the configured range. Only the first qtag1 value is required to remove the range.
Parameters
- qtag1
-
Specifies the outer VID for the c-tag range.
- qtag2
-
Specifies the inner VID for the c-tag range. When configuring a range of qtags (and not a single value), the second qtag1 value must be greater than the value of the first qtag1.
Platforms
All
s-tag-range
s-tag-range
Syntax
s-tag-range qtag1 [to qtag1]
no s-tag-range qtag1
Context
[Tree] (config>service>system>bgp-evpn>eth-seg>qinq s-tag-range)
Full Context
configure service system bgp-evpn ethernet-segment qinq s-tag-range
Description
This command determines the VIDs associated with the virtual Ethernet Segment on a specific qinq port or LAG based on the following considerations:
-
Values *, 0 to 4094 are allowed.
-
Any SAP for which the service-delimiting qtag matches the range is associated with the virtual ES, and only those, for example, SAP 1/1/1:0.* will not match port 1/1/1, s-tag-range 100.
-
Maximum 8 ranges are allowed in the qinq context.
-
A range can be comprised of a single qtag.
-
Shutting down the ES is not required prior to making changes in the q-tag-range.
The no form of the command removes the configured range. Only the first qtag1 value is required to remove the range.
Parameters
- qtag1
-
Specifies the outer VID. When configuring a range of qtags (and not a single value), the second qtag1 value must be greater than the first qtag1.
Platforms
All
s11
s11
s2l-path
s2l-path
Syntax
[no] s2l-path path-name to ip-address
Context
[Tree] (config>router>mpls>lsp>primary-p2mp-instance s2l-path)
Full Context
configure router mpls lsp primary-p2mp-instance s2l-path
Description
This command creates a root-to-leaf (S2L) sub-LSP path for the primary instance of a P2MP LSP. The primary instance of a P2MP LSP is modeled as a set of root-to-leaf (S2L) sub-LSPs. The root, for example, head-end node, triggers signaling using one path message per S2L path. The leaf sub-LSP paths are merged at branching points.
Each S2L sub-LSP is signaled in a separate path message. Each leaf node will respond with its own RESV message. A branch LSR node will forward the path message of each S2L sub-LSP to the downstream LSR without replicating it. It will also forward the RESV message of each S2L sub-LSP to the upstream LSR without merging it with the RESV messages of other S2L sub-LSPs of the same P2MP LSP. The same is done for subsequent refreshes of the path and RESV states.
The S2L paths can be empty paths or can specify a list of explicit hops. The path name must exist and must have been defined using the config>router>mpls>path command. The same path name can be re-used by more than one S2L of the primary P2MP instance. However, the to keyword must have a unique argument per S2L as it corresponds to the address of the egress LER node.
This command is not supported on the 7450 ESS.
Parameters
- path-name
-
Specifies the name of the path which consists of up to 32 alphanumeric characters.
- to ip-address
-
Specifies the IP address of the egress router.
Platforms
All
sa-db
sa-db
Syntax
sa-db [group grpAddr] [source srcAddr] [rp rpAddr]
no sadb
Context
[Tree] (debug>router>msdp sa-db)
Full Context
debug router msdp sa-db
Description
This command enables debugging for Multicast Source Discovery Protocol (MSDP) source-active requests.
The no form of the command disables the MSDP source-active database debugging.
Parameters
- grpAddr
-
Debugs the IP address of the group.
- srcAddr
-
Debugs the source IP address.
- rpAddr
-
Debugs the specified rendezvous point RP address.
Platforms
All
sa-mac
sa-mac
Syntax
sa-mac ieee-address da-mac ieee-address
no sa-mac
Context
[Tree] (config>mirror>mirror-dest>sap>egress>ip-mirror sa-mac)
Full Context
configure mirror mirror-dest sap egress ip-mirror sa-mac
Description
This command configures the source and destination MAC addresses for IP mirroring.
The no form of this command reverts to the default.
Parameters
- sa-mac ieee-address
-
Specifies the source MAC address. Multicast, Broadcast and zeros are not allowed.
- da-mac ieee-address
-
Specifies the destination MAC address. Zeros are not allowed.
Platforms
All
sa-timeout
sa-timeout
Syntax
sa-timeout seconds
no sa-timeout
Context
[Tree] (config>service>vprn>msdp sa-timeout)
Full Context
configure service vprn msdp sa-timeout
Description
This command configures the value for the SA entries in the cache. If these entries are not refreshed within the timeout value, they are removed from the cache. Normally, the entries are refreshed at least once a minute. But under high load with many of MSDP peers, the refresh cycle could be incomplete. A higher timeout value (more then 90) could be useful to prevent instabilities in the MSDP cache.
Default
90
Parameters
- seconds
-
Specifies the time, in seconds, to wait for a response from the peer before declaring the peer unavailable.
Platforms
All
sa-timeout
Syntax
sa-timeout seconds
no sa-timeout
Context
[Tree] (config>router>msdp sa-timeout)
Full Context
configure router msdp sa-timeout
Description
This command configures the value for the SA entries in the cache. If these entries are not refreshed within the timeout value, they are removed from the cache. Normally, the entries are refreshed at least once a minute. But under high load with many of MSDP peers, the refresh cycle could be incomplete. A higher timeout value (more than 90) could be useful to prevent instabilities in the MSDP cache.
Default
sa-timeout 90
Parameters
- seconds
-
Specifies the time, in seconds, to wait for a response from the peer before declaring the peer unavailable.
Platforms
All
saa
saa
Syntax
saa
Context
[Tree] (config saa)
Full Context
configure saa
Description
Commands in this context configure the Service Assurance Agent (SAA) tests.
Platforms
All
saa
Syntax
saa test-name [owner test-owner] {start | stop} [no-accounting]
Context
[Tree] (oam saa)
Full Context
oam saa
Description
This command starts or stops an SAA test that is not configured as continuous.
Parameters
- test-name
-
Specifies the name of the SAA test, up to 32 characters. The test name must already be configured in the config>saa>test context.
- test-owner
-
Specifies the owner of an SAA operation, up to 32 characters. If a test-owner value is not specified, the default owner is used.
- start
-
Starts the test. A test cannot be started if the same test is still running.
A test cannot be started if it is in a shut-down state. An error message and log event is generated to indicate a failed attempt to start an SAA test run. A test cannot be started if it is in a continuous state.
- stop
-
Stops a test in progress. A test cannot be stopped if it is not in progress. A log message is generated to indicate that an SAA test run has been aborted. A test cannot be stopped if it is in a continuous state.
- no-accounting
-
Disables the recording results in the accounting policy. When specifying no-accounting the MIB record produced at the end of the test is not added to the accounting file. It uses one of the three MIB rows available for the accounting module for collection.
Platforms
All
saii-type2
saii-type2
Syntax
saii-type2 global-id:node-id:ac-id
no saii-type2
Context
[Tree] (config>service>apipe>spoke-sdp>pw-path-id saii-type2)
[Tree] (config>service>cpipe>spoke-sdp>pw-path-id saii-type2)
[Tree] (config>service>vpls>spoke-sdp>pw-path-id saii-type2)
[Tree] (config>service>epipe>spoke-sdp>pw-path-id saii-type2)
Full Context
configure service apipe spoke-sdp pw-path-id saii-type2
configure service cpipe spoke-sdp pw-path-id saii-type2
configure service vpls spoke-sdp pw-path-id saii-type2
configure service epipe spoke-sdp pw-path-id saii-type2
Description
This command configures the Source Individual Attachment Identifier (SAII) for an MPLS-TP spoke-sdp. If this is configured on a spoke-sdp for which vc-switching is also configured (for example, it is at an S-PE), then the values must match those of the taii-type2 of the mate spoke-sdp.
Parameters
- global-id
-
Specifies the global ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP.
- node-id
-
Specifies the node ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP.
- ac-id
-
Specifies the attachment circuit ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP. If this node is the source of the PW, then the AC ID must be set to a locally unique value.
Platforms
7450 ESS, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e, 7950 XRS
- configure service apipe spoke-sdp pw-path-id saii-type2
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
- configure service cpipe spoke-sdp pw-path-id saii-type2
- configure service epipe spoke-sdp pw-path-id saii-type2
- configure service vpls spoke-sdp pw-path-id saii-type2
saii-type2
Syntax
saii-type2 global-id:prefix:ac-id
no saii-type2
Context
[Tree] (config>service>epipe>spoke-sdp-fec saii-type2)
Full Context
configure service epipe spoke-sdp-fec saii-type2
Description
This command configures the source attachment individual identifier for the spoke-sdp. This is only applicable to FEC129 AII type 2.
Parameters
- global-id
-
A Global ID of this router T-PE. This value must correspond to one of the global_id values configured for a local-prefix under config>service>pw-routing>local-prefix context.
- prefix
-
The prefix on this router T-PE that the spoke-sdp SDP is associated with. This value must correspond to one of the prefixes configured under config>service>pw-routing>local-prefix context.
- ac-id
-
An unsigned integer representing a locally unique identifier for the spoke SDP.
Platforms
All
saii-type2
Syntax
saii-type2 global-id:node-id:ac-id
no saii-type2
Context
[Tree] (config>service>vprn>if>spoke-sdp>pw-path-id saii-type2)
[Tree] (config>service>vprn>red-if>spoke-sdp>pw-path-id saii-type2)
Full Context
configure service vprn interface spoke-sdp pw-path-id saii-type2
configure service vprn redundant-interface spoke-sdp pw-path-id saii-type2
Description
This command configures the source individual attachment identifier (SAII) for an MPLS-TP spoke SDP. If this is configured on a spoke SDP for which vc-switching is also configured (for example, it is at an S-PE), then the values must match those of the taii-type2 of the mate spoke SDP.
Parameters
- global-id
-
Specifies the global ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP.
- node-id
-
Specifies the node ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP.
- ac-id
-
Specifies the attachment circuit ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP. If this node is the source of the PW, then the AC ID must be set to a locally unique value.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
- configure service vprn interface spoke-sdp pw-path-id saii-type2
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s
- configure service vprn redundant-interface spoke-sdp pw-path-id saii-type2
saii-type2
Syntax
saii-type2 global-id:node-id:ac-id
no saii-type2
Context
[Tree] (config>mirror>mirror-dest>spoke-sdp>pw-path-id saii-type2)
[Tree] (config>mirror>mirror-dest>remote-src>spoke-sdp>pw-path-id saii-type2)
Full Context
configure mirror mirror-dest spoke-sdp pw-path-id saii-type2
configure mirror mirror-dest remote-source spoke-sdp pw-path-id saii-type2
Description
This command configures the source individual attachment identifier (SAII) for an MPLS-TP spoke SDP. If this is configured on a spoke SDP for which vc-switching is also configured (for example, it is at an S-PE), then the values must match those of the taii-type2 of the mate spoke SDP.
Parameters
- global-id
-
Specifies the global ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP.
- node-id
-
Specifies the node ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP.
- ac-id
-
Specifies the attachment circuit ID at the source PE or T-PE for the MPLS-TP PW for a spoke SDP. If this node is the source of the PW, then the AC ID must be set to a locally unique value.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
same-recipnonce-for-pollreq
same-recipnonce-for-pollreq
Syntax
[no] same-recipnonce-for-pollreq
Context
[Tree] (config>system>security>pki>ca-profile>cmpv2 same-recipnonce-for-pollreq)
Full Context
configure system security pki ca-profile cmpv2 same-recipnonce-for-pollreq
Description
This command enables the system to use same recipNonce as the last CMPv2 response for poll request.
Default
no same-recipnonce-for-pollreq
Platforms
All
same-recipnonce-for-pollreq
Syntax
[no] same-recipnonce-for-pollreq
Context
[Tree] (config>system>security>pki>ca-profile>cmp2 same-recipnonce-for-pollreq)
Full Context
configure system security pki ca-profile cmp2 same-recipnonce-for-pollreq
Description
This command enables the system to use same recipNonce as the last CMPv2 response for poll request.
The no form of this command disables system to use same recipNonce as the last CMPv2 response for poll request.
Default
no same-recipnonce-for-pollreq
sample-interval
sample-interval
Syntax
sample-interval interval
Context
[Tree] (config>router>rsvp>dbw-accounting sample-interval)
Full Context
configure router rsvp dbw-accounting sample-interval
Description
This command sets the dark bandwidth sample interval to the specified value. Changing this parameter in the course of dark bandwidth accounting restarts the accounting cycle. The user is encouraged to specify values as multiples of 10. Selecting other values may lead to inconsistent estimation of Dark Bandwidth.
Default
sample-interval 30
Parameters
- interval
-
Specifies the sample interval, expressed in seconds.
Platforms
7750 SR, 7750 SR-s, 7950 XRS, VSR
sample-interval
Syntax
sample-interval sample-period
no sample-interval
Context
[Tree] (config>qos>adv-config-policy>child-control>offered-measurement sample-interval)
Full Context
configure qos adv-config-policy child-control offered-measurement sample-interval
Description
This command is used to define the number of intervening sample periods before a new offered rate is measured and is only applicable when the policy is applied to a policer. By decreasing the sampling interval, the system will measure a child’s new offered rate more frequently. Inversely, increasing the sampling interval causes the child’s offered rate to be measured less frequently.
The overall number of offered rate measurements the system attempts within a given timeframe is not affected by the sample-interval command. If the system is asked to perform offered rate measurements more often on some policers, it will take longer to get to all children.
When this command is not specified or removed, the system evaluates the offered rate of each child after 1 sampling period.
The no form of this command is used to restore the sampling interval default of 1 sample period.
Parameters
- sample-period
-
The sample-periods parameter is specified as a whole number between 1 and 8. The value '1’ represents the fastest sampling rate available and the value '8’ represents the slowest sampling period available.
Platforms
All
sample-interval
Syntax
sample-interval interval
Context
[Tree] (config>system>telemetry>persistent-subscriptions>subscription sample-interval)
Full Context
configure system telemetry persistent-subscriptions subscription sample-interval
Description
This command configures the sample interval for persistent subscription.
This sampling interval only applies when the mode command is set to either target-defined or sample.
Default
sample-interval 10000
Parameters
- interval
-
Specifies the sample interval, in milliseconds.
Platforms
All
sample-multiplier
sample-multiplier
Syntax
sample-multiplier multiplier
Context
[Tree] (config>router>rsvp>dbw-accounting sample-multiplier)
Full Context
configure router rsvp dbw-accounting sample-multiplier
Description
This command sets the dark bandwidth sample interval multiplier to the specified value. Changing this parameter in the course of dark bandwidth accounting restarts the accounting cycle.
Default
sample-multiplier 3
Parameters
- multiplier
-
Specifies the sample interval multiplier, expressed as an integer.
Platforms
7750 SR, 7750 SR-s, 7950 XRS, VSR
sample-profile
sample-profile
Syntax
sample-profile profile-id [create]
no sample-profile profile-id
Context
[Tree] (config>cflowd sample-profile)
Full Context
configure cflowd sample-profile
Description
Commands in this context create and define sampling parameters.
The no form of this command removes the associated sample-profile. sample-profile 1 cannot be deleted.
Parameters
- profile-id
-
Specifies the rate profile.
- create
-
Mandatory keyword when creating a sample profile. The create keyword requirement can be enabled or disabled in the environment>create context.
Platforms
All
sample-profile
Syntax
sample-profile sample-profile-id
no sample-profile
Context
[Tree] (config>filter>ipv6-filter>entry sample-profile)
[Tree] (config>filter>ip-filter>entry sample-profile)
Full Context
configure filter ipv6-filter entry sample-profile
configure filter ip-filter entry sample-profile
Description
This command allows traffic matching of an IPv4 or IPv6 filter to be sampled for cflowd processing using a specific sample profile.
This command is only compatible if the associated interface is configured for interface-based sampling and is only supported for ingress sampling.
An IP filter can only specify a single alternate sample profile for cflowd sampling, but that sample profile can be used in multiple entries.
The no form of this command removes the specified sampling profile from the configuration. Cflowd continues to process traffic based on the default or configured interface cflowd sampling profile.
Default
no sample-profile
Parameters
- sample-profile-id
-
Specifies the cflowd sample profile to be used for packets matching this filter entry.
Platforms
All
sample-rate
sample-rate
Syntax
sample-rate [rate]
Context
[Tree] (config>cflowd>sample-profile sample-rate)
Full Context
configure cflowd sample-profile sample-rate
Description
This command defines the cflowd sampling rate for the sample profile ID.
The sample rate indicates that the associated interface samples 1 in N packets for cflowd analysis. Only one rate profile below 1:256 with a specific IOM, IMM, or XMA can be associated.
Default
sample-rate 1000
Parameters
- rate
-
Specifies the rate at which traffic is sampled and forwarded for cflowd analysis.
Platforms
All
sample-window
sample-window
Syntax
sample-window seconds
no sample-window
Context
[Tree] (config>oam-pm>streaming>delay-template sample-window)
Full Context
configure oam-pm streaming delay-template sample-window
Description
This command specifies the sample window duration in seconds for the template. This configuration option represents time over which the average will be calculated and subsequently streamed.
The no form of this command reverts to the default.
Default
sample-window 60
Parameters
- seconds
-
Specifies the sample window duration.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
sample-window
Syntax
sample-window
Context
[Tree] (config>test-oam>link-meas>template sample-window)
Full Context
configure test-oam link-measurement measurement-template sample-window
Description
Commands in this context configure sample window parameters to be used when the measurement-template is assigned to an IP interface. The sample window is the collection of individual probe results, over a defined period.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
sampling
sampling
Syntax
sampling {unicast | multicast} type {acl | interface} [direction { ingress-only | egress-only | both}] [sample-profile [profile-id]]
no sampling {unicast | multicast}
Context
[Tree] (config>service>vprn>nw-if>cflowd-parameters sampling)
[Tree] (config>service>ies>if>cflowd-parameters sampling)
[Tree] (config>service>ies>sub-if>grp-if>cflowd-parameters sampling)
[Tree] (config>service>vprn>if>cflowd-parameters sampling)
[Tree] (config>service>vprn>sub-if>grp-if>cflowd-parameters sampling)
Full Context
configure service vprn network-interface cflowd-parameters sampling
configure service ies interface cflowd-parameters sampling
configure service ies subscriber-interface group-interface cflowd-parameters sampling
configure service vprn interface cflowd-parameters sampling
configure service vprn subscriber-interface group-interface cflowd-parameters sampling
Description
This command enables and configures the cflowd sampling behavior to collect traffic flow samples through a router for analysis.
This command can be used to configure the sampling parameters for unicast and multicast traffic separately. If sampling is not configured for either unicast or multicast traffic, then that type of traffic will not be sampled.
If cflowd is enabled without either egress-only or both keywords specified or with the ingress-only keyword specified, then only ingress sampling is enabled on the associated IP interface.
The no form of this command disables the associated type of traffic sampling.
Parameters
- unicast | multicast
-
Specifies unicast or multicast sampling.
- type
-
Specifies the cflowd sampling type on the given virtual router interface.
- direction
-
Specifies the direction of the cflowd analysis that is applied to the given virtual router interface.
- profile-id
-
Defines the sampling rate profile to be associated with this interface.
Platforms
All
- configure service ies interface cflowd-parameters sampling
- configure service vprn network-interface cflowd-parameters sampling
- configure service vprn interface cflowd-parameters sampling
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
- configure service ies subscriber-interface group-interface cflowd-parameters sampling
- configure service vprn subscriber-interface group-interface cflowd-parameters sampling
sampling
Syntax
sampling {unicast | multicast} type {acl | interface} [direction { ingress-only | egress-only | both}] [sample-profile profile]
no sampling {unicast | multicast}
Context
[Tree] (config>router>if>cflowd-parameters sampling)
Full Context
configure router interface cflowd-parameters sampling
Description
This command enables and configures the cflowd sampling behavior to collect traffic flow samples through a router for analysis.
This command can be used to configure the sampling parameters for unicast and multicast traffic separately. If sampling is not configured for either unicast or multicast traffic, then that type of traffic will not be sampled.
If cflowd is enabled without either egress-only or both specified or with the ingress-only keyword specified, then only ingress sampling will be enabled on the associated IP interface.
The no form of this command disables the associated type of traffic sampling on the associated interface.
Default
no sampling
Parameters
- unicast
-
Specifies that the sampling command will control the sampling of unicast traffic on the associated interface/SAP.
- multicast
-
Specifies that the sampling command will control the sampling of multicast traffic on the associated interface/SAP.
- type
-
Specifies whether the traffic sampling is based on an acl match, or all traffic entering or exiting the associated interface.
- direction
-
Specifies the direction to collect traffic flow samples.
- profile
-
Specifies the sampling profile to be associated with this interface.
Platforms
All
sampling-rate
sampling-rate
Syntax
sampling-rate sampling-rate
no sampling-rate
Context
[Tree] (config>mirror>mirror-dest sampling-rate)
Full Context
configure mirror mirror-dest sampling-rate
Description
This command configures the packet sampling rate for mirrored traffic and is supported with config and debug mirror sources. The sampling rate is common to all endpoints on a specified line card FP per mirror destination service.
The no form of this command disables the packet sampling rate for mirrored traffic.
Default
no sampling-rate
Parameters
- sampling-rate
-
Specifies the sampling rate.
Platforms
All
sap
sap
Syntax
sap sap-id [split-horizon-group group-name] [create] [capture-sap] [eth-ring ring-index]
sap sap-id [split-horizon-group group-name] [create] [capture-sap] [eth-ring ring-index] leaf-ac
sap sap-id [split-horizon-group group-name] [create] [capture- sap] [eth-ring ring-index] root-leaf-tag leaf-tag leaf-tag
no sap sap-id
Context
[Tree] (config>service>vpls sap)
Full Context
configure service vpls sap
Description
This command creates a Service Access Point (SAP) within a service. A SAP is a combination of port and encapsulation parameters which identifies the service access point on the interface and within the 7450 ESS or 7750 SR. Each SAP must be unique. All SAPs must be explicitly created within a service or on an IP interface.
Enter an existing SAP without the create keyword to edit SAP parameters. The SAP is owned by the service in which it was created.
A SAP can only be associated with a single service. A SAP can only be defined on a port that has been configured as an access port using the config interface port-type port-id mode access command. Channelized TDM ports are always access ports (TDM applies to the 7750 SR only).
If a port is shut down, all SAPs on that port become operationally down. When a service is shut down, SAPs for the service are not displayed as operationally down although all traffic traversing the service is discarded. The operational state of a SAP is relative to the operational state of the port on which the SAP is defined.
The no form of this command deletes the SAP with the specified port. When a SAP is deleted, all configuration parameters for the SAP are also deleted. For Internet Ethernet Service (IES), the IP interface must be shut down before the SAP on that interface may be removed.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
- port-id
-
Specifies the physical port ID in the slot/mda/port format.
If the card in the slot has Media Dependent Adapters (MDAs) installed, the port-id must be in the slot_number/MDA_number/port_number [.channel] format. For example 6/2/3 specifies port 3 on MDA 2 in slot 6.
The port-id must reference a valid port type. When the port-id parameter represents SONET/SDH and TDM channels, the port ID must include the channel ID. A period ".” separates the physical port from the channel-id. The port must be configured as an access port.
If the SONET/SDH port is configured as clear-channel then only the port is specified.
- group-name
-
Specifies the name of the split horizon group to which the SAP belongs. This parameter applies to the 7450 ESS or 7750 SR only.
- capture-sap
-
Specifies a capturing SAP in which triggering packets are sent to the CPM. Non-triggering packets captured by the capture SAP are dropped. This parameter applies to the 7450 ESS or 7750 SR only.
- create
-
Keyword used to create a SAP instance. The create keyword requirement can be enabled or disabled in the environment>create context.
- root-leaf-tag
-
Specifies a SAP as a root leaf tag SAP. Only SAPs of the form dot1q (for example, 1/1/1:X) or qinq (for example, 1/1/1:X.Y, 1/1/1:X.*) are supported. The default E-Tree SAP type is a root AC, if root-leaf-tag (or leaf-ac) is not specified at SAP creation. This option is only available when the VPLS is designated as an E-Tree VPLS.
- leaf-tag-vid
-
Specifies to replace the outer SAP-ID for leaf traffic. The leaf tag VID is only significant between peering VPLS but the values must be consistent on each end.
- leaf-ac
-
Specifies a SAP as a leaf access (AC) SAP. The default E-Tree SAP type is root AC if leaf-ac (or root-leaf-tag) is not specified at SAP creation. This option is only available when the VPLS is designated as an E-Tree VPLS.
Platforms
All
sap
Syntax
[no] sap sap-id
Context
[Tree] (config>service>vpls>pbb>backbone-vpls sap)
Full Context
configure service vpls pbb backbone-vpls sap
Description
This command configures attributes of a SAP on the B-VPLS service.
Platforms
All
sap
Syntax
sap sap-id [create] [no-endpoint]
sap sap-id [create] endpoint endpoint-name
no sap sap-id
Context
[Tree] (config>service>cpipe sap)
[Tree] (config>service>epipe sap)
[Tree] (config>service>ipipe sap)
[Tree] (config>service>apipe sap)
[Tree] (config>service>fpipe sap)
Full Context
configure service cpipe sap
configure service epipe sap
configure service ipipe sap
configure service apipe sap
configure service fpipe sap
Description
This command creates a Service Access Point (SAP) within a service. A SAP is a combination of port and encapsulation parameters which identifies the service access point on the interface and within the device. Each SAP must be unique.
All SAPs must be explicitly created. If no SAPs are created within a service or on an IP interface, a SAP will not exist on that object.
Enter an existing SAP without the create keyword to edit SAP parameters. The SAP is owned by the service in which it was created.
A SAP can only be associated with a single service. A SAP can only be defined on a port that has been configured as an access port. Channelized TDM ports are always access ports.
If a port is shutdown, all SAPs on that port become operationally down. When a service is shutdown, SAPs for the service are not displayed as operationally down although all traffic traversing the service will be discarded.
The operational state of a SAP is relative to the operational state of the port on which the SAP is defined.
The following are supported on the 7750 SR only:
-
ATM VPI/VCI on an ATM port for vc-type atm-vcc and atm-sdu
-
ATM VPI on an ATM port for vc-type atm-vpc
-
ATM virtual trunk - a range of VPIs on an ATM port for vc-type atm-cell
-
ATM port for vc-type atm-cell
-
ATM connection profile for vc-type atm-cell
-
Frame Relay DLCI on a port for vc-type atm-sdu
-
ATM SAP carries the IPv4 packet using RFC 2684, VC-Mux or LLC/SNAP routed PDU encapsulation for an Ipipe service
-
Frame Relay SAP RFC 2427, routed PDU encapsulation for an Ipipe service
-
Ethernet SAP RFC 1332, PPP IPCP encapsulation of an IPv4 packet for an Ipipe service
-
Ethernet SAP HDLC SAP uses the routed IPv4 encapsulation for an Ipipe service
-
ATM - Frame Relay, PPP/IPCP - PPP/IPCP
-
Frame Relay-Frame Relay, ATM - ATM
-
Ethernet-Ethernet
-
cHDLC-cHDLC
-
An ATM SAP can be part of an IMA bundle.
-
A PPP SAP can be part of an MLPPP bundle.
-
A FR SAP can be part of a MLFR bundle.
Ethernet SAPs support null, dot1q, and qinq is supported for all routers.
The no form of this command deletes the SAP with the specified port. When a SAP is deleted, all configuration parameters for the SAP will also be deleted. For Internet Enhanced Service (IES), the IP interface must be shutdown before the SAP on that interface may be removed.
By default, no SAPs are defined.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP.
- port-id
-
Specifies the physical port ID.
If the card in the slot has Media Dependent Adapters (MDAs) installed, the port-id must be in the slot_number/MDA_number/port_number format. For example 6/2/3 specifies port 3 on MDA 2 in slot 6.
The port-id must reference a valid port type. When the port-id parameter represents SONET/SDH and TDM channels, the port ID must include the channel ID. A period ".” separates the physical port from the channel-id. The port must be configured as an access port.
If the SONET/SDH port is configured as clear-channel then only the port is specified.
port-id
slot/mda/port [.channel]
eth-sat-id
esat-id/slot/port
esat
keyword
id
1 to 20
pxc-id
pxc-id.sub-port
pxc
keyword
id
1 to 64
sub-port
a, b
- endpoint
-
Adds a SAP endpoint association.
- no endpoint
-
Removes the association of a SAP or a spoke SDP with an explicit endpoint name.
- create
-
Keyword used to create a SAP instance. The create keyword requirement can be enabled/disabled in the environment>create context.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
- configure service fpipe sap
- configure service cpipe sap
All
- configure service epipe sap
- configure service ipipe sap
7450 ESS, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e, 7950 XRS
- configure service apipe sap
Output
The following is an example of VLL SAP information.
Sample Output*A:bksim2801>config>service>apipe>sap$
=================================================================
ATM PVCs, Port 1/1/1
=================================================================
VPI/VCI Owner Type Ing.TD Egr.TD Adm OAM Opr
-----------------------------------------------------------------
2/102 SAP PVC 1 1 up ETE-AIS dn
10/100 SAP PVC 1 1 up ETE-AIS dn
=================================================================
*A:bksim2801#
*A:test>config>service>epipe 200 name "200" customer 1 info detail
=================================================================
sap 1/1/c5/1:200.200 create
no shutdown
exit
sap pw-21:200.200 create
no shutdown
exit
no shutdown
exit
exit
=================================================================
sap
Syntax
sap sap-id [create]
no sap sap-id
Context
[Tree] (config>service>ies>sub-if>grp-if sap)
[Tree] (config>service>ies>if sap)
[Tree] (config>service>vprn>sub-if>grp-if sap)
[Tree] (config>service>vprn sap)
[Tree] (config>service>vprn>if sap)
[Tree] (config>service>ies sap)
Full Context
configure service ies subscriber-interface group-interface sap
configure service ies interface sap
configure service vprn subscriber-interface group-interface sap
configure service vprn sap
configure service vprn interface sap
configure service ies sap
Description
This command creates a Service Access Point (SAP) within a service. A SAP is a combination of port and encapsulation parameters which identifies the service access point on the interface and within the router. Each SAP must be unique.
All SAPs must be explicitly created. If no SAPs are created within a service or on an IP interface, a SAP will not exist on that object.
Enter an existing SAP without the create keyword to edit SAP parameters. The SAP is owned by the service in which it was created.
A SAP can only be associated with a single service. A SAP can only be defined on a port that has been configured as an access port using the config interface port-type port-id mode access command. For the 7750 SR, channelized TDM ports are always access ports.
If a port is shutdown, all SAPs on that port become operationally down. When a service is shutdown, SAPs for the service are not displayed as operationally down although all traffic traversing the service will be discarded. The operational state of a SAP is relative to the operational state of the port on which the SAP is defined.
Configure an IES interface as a loopback interface by issuing the loopback command instead of the sap sap-id command. The loopback flag cannot be set on an interface where a SAP is already defined and a SAP cannot be defined on a loopback interface.
The no form of this command deletes the SAP with the specified port. When a SAP is deleted, all configuration parameters for the SAP are also deleted. For Internet Enhanced Service (IES), the IP interface must be shutdown before the SAP on that interface may be removed. The no form of this command causes the ptp-hw-assist to be disabled.
Default
No SAPs are defined.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
- port-id
-
Specifies the physical port ID in the slot/mda/port format.
If the card in the slot has Media Dependent Adapters (MDAs) installed, the port-id must be in the slot_number/MDA_number/port_number format. For example 61/2/3 specifies port 3 on MDA 2 in slot 61.
Table 1. Port ID Syntax null
port-id | lag-id
dot1q
{port-id | lag-id}:{qtag1 | cp-conn-prof-id
qinq
{port-id | lag-id}:{qtag1 | cp-conn-prof-id}.{qtag2 | cp-conn-prof-id}
cp: keyword
conn-prof-id: 1 to 8000
port-id
slot/mda/port [.channel]
eth-sat-id
esat-id/slot/port
esat: keyword
id: 1 to20
pxc-id
psc-id.sub-port
pxc psc-id.sub-port
pxc: keyword
id: 1 to 64
sub-port: a, b
lag-id
lag-id
lag: keyword
id: 1 to 800
qtag1
0 to 4094
qtag2
* | null | 0 to 4094
The port-id must reference a valid port type. When the port-id parameter represents SONET/SDH and TDM channels (7750 SR), the port ID must include the channel ID. A period ".” separates the physical port from the channel-id. The port must be configured as an access port.
If the SONET/SDH port is configured as clear-channel then only the port is specified.
- create
-
Keyword used to create a SAP instance. The create keyword requirement can be enabled/disabled in the environment>create context.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
- configure service vprn subscriber-interface group-interface sap
- configure service ies subscriber-interface group-interface sap
All
- configure service vprn sap
- configure service ies interface sap
- configure service ies sap
- configure service vprn interface sap
sap
Syntax
sap sap-id [create]
no sap sap-id
Context
[Tree] (config>service>vprn>sub-if>grp-if sap)
Full Context
configure service vprn subscriber-interface group-interface sap
Description
This command creates a SAP for the interface.
The no form of this command removes the SAP.
Parameters
- sap-id
-
Specifies the SAP ID.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap
Syntax
sap sap-id [create]
no sap sap-id
Context
[Tree] (config>service>vprn>if sap)
Full Context
configure service vprn interface sap
Description
This command creates a Service Access Point (SAP) within a service. A SAP is a combination of port and encapsulation parameters which identifies the service access point on the interface and within the router. Each SAP must be unique.
All SAPs must be explicitly created. If no SAPs are created within a service or on an IP interface, a SAP will not exist on that object. Enter an existing SAP without the create keyword to edit SAP parameters. The SAP is owned by the service in which it was created.
A SAP can only be associated with a single service. A SAP can only be defined on a port that has been configured as an access port using the config interface port-type port-id mode access command. Channelized TDM ports are always access ports.
If a port is shut down, all SAPs on that port become operationally down. When a service is shut down, SAPs for the service are not displayed as operationally down although all traffic traversing the service will be discarded. The operational state of a SAP is relative to the operational state of the port on which the SAP is defined.
The no form of this command deletes the SAP with the specified port. When a SAP is deleted, all configuration parameters for the SAP will also be deleted. The no form of this command causes the ptp-h-assist to be disabled.
Default
No SAPs are defined.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
- port-id
-
Specifies the physical port ID.
If the card in the slot has Media Dependent Adapters (MDAs) installed, the port-id must be in the slot_number/MDA_number/port_number format. For example 6/2/3 specifies port 3 on MDA 2 in slot 6.
The port-id must reference a valid port type. When the port-id parameter represents SONET/SDH and TDM channels the port ID must include the channel ID. A period ".” separates the physical port from the channel-id. The port must be configured as an access port.
If the SONET/SDH port is configured as clear-channel then only the port is specified.
port-id
slot/mda/port [.channel]
eth-sat-id
esat-id/slot/port
esat
keyword
id
1 to 20
pxc-id
pxc-id.sub-port
pxc
keyword
id
1 to 64
sub-port
a, b
- create
-
Keyword used to create a SAP instance.
- split-horizon-group group-name
-
Specifies the name of the split horizon group to which the SAP belongs.
Platforms
All
sap
Syntax
[no] sap sap-id
Context
[Tree] (debug>service>id>ppp sap)
Full Context
debug service id ppp sap
Description
This command enables PPP debug output for the specified SAP, this command allow multiple instances.
The no form of this command disables debugging.
Parameters
- sap-id
-
Specifies the SAP ID.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap
Syntax
sap sap-id
no sap
Context
[Tree] (config>service>vpls>site sap)
Full Context
configure service vpls site sap
Description
This command configures a SAP for the site.
The no form of this command removes the SAP ID from the configuration.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition
Platforms
All
sap
Syntax
[no] sap sap-id
Context
[Tree] (debug>service>id>mrp sap)
Full Context
debug service id mrp sap
Description
This command filters debug events and only shows events for the particular SAP.
The no form of this command removes the debug filter.
Parameters
- sap-id
-
The SAP ID.
Platforms
All
sap
Syntax
sap sap-id
no sap
Context
[Tree] (config>service>epipe>site sap)
Full Context
configure service epipe site sap
Description
This command configures a SAP for the site.
The no form of this command removes the SAP ID from the configuration.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
Platforms
All
sap
Syntax
[no] sap sap-id
Context
[Tree] (debug>service>id sap)
[Tree] (debug>service>id>stp sap)
[Tree] (debug>service>id>dhcp sap)
Full Context
debug service id sap
debug service id stp sap
debug service id dhcp sap
Description
This command enables STP debugging for a specific SAP.
The no form of the command disables debugging.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
Platforms
All
sap
Syntax
sap [split-horizon-group group-name] [create] [capture-sap]
no sap sap-id
Context
[Tree] (config>service>vpls>mac-move>secondary-ports sap)
[Tree] (config>service>vpls>mac-move>primary-ports sap)
Full Context
configure service vpls mac-move secondary-ports sap
configure service vpls mac-move primary-ports sap
Description
This command declares a specified SAP as a primary (or secondary) VPLS port.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition
Platforms
All
sap
Syntax
[no] sap sap-id
Context
[Tree] (debug>service>id>arp-host sap)
Full Context
debug service id arp-host sap
Description
This command displays ARP host events for a particular SAP.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap
Syntax
[no] sap sap-id
Context
[Tree] (debug>service>id>igmp-snooping sap)
Full Context
debug service id igmp-snooping sap
Description
This command shows IGMP packets for a specific SAP.
The no form of this command disables the debugging for the SAP.
Platforms
All
sap
Syntax
[no] sap sap-id
Context
[Tree] (debug>service>id>mld sap)
Full Context
debug service id mld-snooping sap
Description
This command shows MLD packets for a specific SAP.
The no form of this command disables the debugging for the SAP.
Platforms
All
sap
Syntax
[no] sap sap-id
Context
[Tree] (debug>service>id>host-connectivity-verify sap)
Full Context
debug service id host-connectivity-verify sap
Description
This command displays Subscriber Host Connectivity Verification (SHCV) events for a particular SAP.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap
Syntax
sap card/mda/aa-svc:vlan [create]
no sap
Context
[Tree] (config>service>vprn>aa-if sap)
Full Context
configure service vprn aa-interface sap
Description
This commands specifies which ISA card and which VLAN is used by a given AA Interface.
Default
no sap
Parameters
- card/mda/aa-svc:vlan
-
Specifies the AA ISA card slot/port and VLAN information.
- create
-
Keyword used to create the AARP instance.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
sap
Syntax
sap sap-id [create]
no sap sap-id
Context
[Tree] (config>service>vprn>aa-interface sap)
[Tree] (config>service>ies>aa-interface sap)
Full Context
configure service vprn aa-interface sap
configure service ies aa-interface sap
Description
This command configures the AA interface SAP.
Parameters
- sap-id
-
specifies the physical port identifier portion of the SAP definition.
- create
-
creates the SAP instance.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
sap
Syntax
sap sap-id [create] [no-endpoint]
sap sap-id [create] endpoint name
no sap
Context
[Tree] (config>mirror>mirror-dest sap)
Full Context
configure mirror mirror-dest sap
Description
This command creates a service access point (SAP) within a mirror destination service. The SAP is owned by the mirror destination service ID.
The SAP is defined with port and encapsulation parameters to uniquely identify the (mirror) SAP on the interface and within the box. The specified SAP may be defined on an Ethernet access port with a dot1q, null, or q-in-q encapsulation type.
Only one SAP can be created within a mirror-dest service ID. If the defined SAP has not been created on any service within the system, the SAP is created and the context of the CLI will change to the newly created SAP. In addition, the port cannot be a member of a multi-link bundle, APS group or IMA bundle.
If the defined SAP exists in the context of another service ID, mirror-dest or any other type, an error is generated.
Mirror destination SAPs can be created on Ethernet interfaces that have been defined as an access interface. If the interface is defined as network, the SAP creation returns an error.
When the no form of this command is used on a SAP created by a mirror destination service ID, the SAP with the specified port and encapsulation parameters is deleted.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
- no-endpoint
-
Removes the association of a SAP or a sdp with an explicit endpoint name.
- name
-
Specifies the name of the endpoint associated with the SAP.
Platforms
All
sap
Syntax
sap sap-id {[egress] [ingress]}
no sap sap-id [egress] [ingress]
Context
[Tree] (config>mirror>mirror-source sap)
Full Context
configure mirror mirror-source sap
Description
This command enables mirroring of traffic ingressing or egressing a service access port (SAP). A SAP that is defined within a mirror destination cannot be used in a mirror source. The mirror source SAP referenced by the sap-id is owned by the service ID of the service in which it was created. The SAP is only referenced in the mirror source name for mirroring purposes. The mirror source association does not need to be removed before deleting the SAP from its service ID. If the SAP is deleted from its service ID, the mirror association is removed from the mirror source.
More than one SAP can be associated within a single mirror-source. Each SAP has its own ingress and egress parameter keywords to define which packets are mirrored to the mirror destination.
The SAP must be valid and properly configured. If the associated SAP does not exist, an error occurs and the command will not execute.
The same SAP cannot be associated with multiple mirror source definitions for ingress packets.
The same SAP cannot be associated with multiple mirror source definitions for egress packets.
If a particular SAP is not associated with a mirror source name, then that SAP will not have mirroring enabled for that mirror source.
Note that the ingress and egress options cannot be supported at the same time on a CEM encap-type SAP. The options must be configured in either the ingress or egress contexts (applies to the 7750 SR and 7950 XRS).
The no form of this command disables mirroring for the specified SAP. All mirroring for that SAP on ingress and egress is terminated. Mirroring of packets on the SAP can continue if more specific mirror criteria is configured. If the egress or ingress parameter keywords are specified in the no command, only the ingress or egress mirroring condition is removed.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
- egress
-
Specifies that packets egressing the SAP should be mirrored. Egress packets are mirrored to the mirror destination after egress packet modification.
- ingress
-
Specifies that packets ingressing the SAP should be mirrored. Ingress packets are mirrored to the mirror destination prior to ingress packet modification.
Platforms
All
sap
Syntax
sap sap-id {[ingress] [egress]}
no sap sap-id [ingress] [egress]
Context
[Tree] (config>li>li-source sap)
Full Context
configure li li-source sap
Description
This command creates a service access point (SAP) within an LI configuration. The specified SAP must define a FastE, GigE, or XGigE, or XGigE access port with a dot1q, null, or q-in-q encapsulation type.
When the no form of this command is used on a SAP, the SAP with the specified port and encapsulation parameters is deleted.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
- egress
-
Specifies that the router perform lawful intercept on egress traffic. Packets egressing the SAP are mirrored to the mirror destination after egress packet modification.
- ingress
-
Specifies that the router perform lawful intercept on ingress traffic. Packets ingressing the SAP are mirrored to the mirror destination before ingress packet modification.
Platforms
All
sap
Syntax
sap sap-id {[egress] [ingress]}
no sap sap-id [egress] [ingress]
Context
[Tree] (debug>mirror-source sap)
Full Context
debug mirror-source sap
Description
This command enables mirroring of traffic ingressing or egressing a service access port (SAP). A SAP that is defined within a mirror destination cannot be used in a mirror source. The mirror source SAP referenced by the sap-id is owned by the service ID of the service in which it was created. The SAP is only referenced in the mirror source name for mirroring purposes. The mirror source association does not need to be removed before deleting the SAP from its service ID. If the SAP is deleted from its service ID, the mirror association is removed from the mirror source.
More than one SAP can be associated within a single mirror-source. Each SAP has its own ingress and egress parameter keywords to define which packets are mirrored to the mirror destination.
The SAP must be valid and properly configured. If the associated SAP does not exist, an error occurs and the command will not execute.
The same SAP cannot be associated with multiple mirror source definitions for ingress packets.
The same SAP cannot be associated with multiple mirror source definitions for egress packets.
If a particular SAP is not associated with a mirror source name, then that SAP will not have mirroring enabled for that mirror source.
Note that the ingress and egress options cannot be supported at the same time on a CEM encap-type SAP. The options must be configured in either the ingress or egress contexts (applies to the 7750 SR and 7950 XRS).
The no form of this command disables mirroring for the specified SAP. All mirroring for that SAP on ingress and egress is terminated. Mirroring of packets on the SAP can continue if more specific mirror criteria is configured. If the egress or ingress parameter keywords are specified in the no command, only the ingress or egress mirroring condition is removed.
Parameters
- sap-id
-
Specifies the physical port identifier portion of the SAP definition.
- egress
-
Specifies that packets egressing the SAP should be mirrored. Egress packets are mirrored to the mirror destination after egress packet modification.
- ingress
-
Specifies that packets ingressing the SAP should be mirrored. Ingress packets are mirrored to the mirror destination prior to ingress packet modification.
Platforms
All
sap
Syntax
sap sap-id [create]
no sap sap-id
Context
[Tree] (config>system>satellite>local-forward sap)
Full Context
configure system satellite local-forward sap
Description
This command configures a Service Access Point (SAP) used in satellite local forward instances defined in the system.
The no form of this command removes the satellite access point from the local-forward instance.
Parameters
- eth-sat-id
-
Specifies the satellite access point in the local-forward instance in the esat-id/slot/port format.
- lag-id
-
Specifies the LAG identifier, expressed as an integer,
- qtag1
-
Specifies the qtag value.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
sap-egress
sap-egress
Syntax
sap-egress {policy-id | policy-name} [create] [name name]
no sap-egress {policy-id | policy-name}
Context
[Tree] (config>qos sap-egress)
Full Context
configure qos sap-egress
Description
This command is used to create or edit a Service Egress QoS policy. The egress policy defines the SLA for service packets as they egress on the SAP.
Policies are templates that can be applied to multiple services as long as the scope of the policy is template. The queues defined in the policy are not instantiated until a policy is applied to a service.
Sap-egress policies determine queue mappings based on ingress DSCP, IP precedence, dot1p, and IPv4 or IPv6 match criteria. Multiple queues can be created per forwarding class and each queue can have different CIR or PIR parameters.
Egress SAP QoS policies allow the definition of queues and the mapping of forwarding classes to those queues. Each queue needs to have a relative CIR for determining its allocation of QoS resources during periods of congestion. A PIR can also be defined that forces a hard limit on the packets transmitted through the queue. When the forwarding class is mapped to the queue, a DSCP, IP precedence, or dot1p value can optionally be specified.
The sap-egress policy with policy-id 1 is the default sap-egress QoS policy and is applied to service egress SAPs when an explicit policy is not specified or removed. The default sap-egress policy cannot be modified or deleted.
By default, all forwarding classes map to queue 1.
Any changes made to an existing policy, using any of the sub-commands, will be applied immediately to all egress SAPs where this policy is applied. For this reason, when many changes are required on a policy, it is highly recommended that the policy be copied to a work area policy-id. That work-in-progress policy can be modified until complete, then written over the original policy-id. Use the config qos copy command to maintain policies in this manner.
The no form of this command deletes the sap-egress policy. A policy cannot be deleted until it is removed from all service SAPs where it is applied. When a sap-egress policy is removed from a SAP, the SAP will revert to the default sap-egress policy-id 1.
Parameters
- policy-id
-
The policy-id uniquely identifies the policy on the router.
- policy-name
-
The policy-name uniquely identifies the policy.
- create
-
Required parameter when creating a SAP QoS egress policy.
- name
-
Configures an optional policy name, up to 64 characters in length, which adds a name identifier to a given policy to then use that policy name in configuration references as well as display and use policy names in show commands throughout the system. This helps the service provider or administrator to identify and manage sap-egress policies within the SR OS platforms.
All sap-egress policies are required to assign a policy ID to initially create a policy. However, either the policy ID or the policy name can be used to identify and reference a given policy once it is initially created.
If a name is not specified at creation time, then SR OS assigns a string version of the policy-id as the name.
Platforms
All
sap-egress
Syntax
sap-egress src-pol dst-pol [overwrite]
Context
[Tree] (config>qos>copy sap-egress)
Full Context
configure qos copy sap-egress
Description
This command copies existing QoS policy entries for a QoS policy-id to another QoS policy-id.
The copy command is a configuration-level maintenance tool used to create new policies using existing policies. It also allows bulk modifications to an existing policy with the use of the overwrite keyword.
Parameters
- overwrite
-
Specifies to replace the existing destination policy. Everything in the existing destination policy will be overwritten with the contents of the source policy. If overwrite is not specified, an error will occur if the destination policy ID exists.
- Example:
-
— SR>config>qos# copy sap-egress 1 1010
— MINOR: CLI Destination "1010" exists use {overwrite}.
— SR>config>qos# copy sap-egress 1 1010 overwrite
- src-pol dst-pol
-
Indicates that the source policy ID and the destination policy ID are SAP egress policy IDs. Specify the source policy ID that the copy command will attempt to copy from and specify the destination policy ID to which the command will copy a duplicate of the policy.
Platforms
All
sap-host-limit
sap-host-limit
Syntax
sap-host-limit max-num-hosts-sap
no sap-host-limit
Context
[Tree] (config>service>vprn>sub-if>grp-if>arp-host sap-host-limit)
[Tree] (config>service>ies>sub-if>grp-if>arp-host sap-host-limit)
Full Context
configure service vprn subscriber-interface group-interface arp-host sap-host-limit
configure service ies subscriber-interface group-interface arp-host sap-host-limit
Description
This command configures the maximum number of ARP hosts per SAP.
The no form of this command reverts to the default.
Default
sap-host-limit 1
Parameters
- max-num-hosts-sap
-
Specifies the maximum number of ARP hosts per SAP allowed on this interface.
Note:The operational maximum value may be smaller due to equipped hardware dependencies.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap-id
sap-id
Syntax
sap-id sap-id
no sap-id
Context
[Tree] (config>subscr-mgmt>loc-user-db>ipoe>host>host-ident sap-id)
[Tree] (config>subscr-mgmt>loc-user-db>ppp>host>host-identification sap-id)
Full Context
configure subscriber-mgmt local-user-db ipoe host host-identification sap-id
configure subscriber-mgmt local-user-db ppp host host-identification sap-id
Description
This command specifies the SAP ID to match for a host lookup. When the LUDB is accessed using a DHCPv4 server, the SAP-ID is matched against the Nokia vendor-specific sub-option in DHCP Option 82.
This command is used only when sap-id is configured as one of the match-list parameters.
The no form of this command removes the SAP ID from the configuration.
Parameters
- sap-id
-
Specifies a SAP ID, up to 255 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap-id
Syntax
[no] sap-id
Context
[Tree] (config>subscr-mgmt>msap-policy>vpls-only>dhcp>option>vendor sap-id)
[Tree] (config>service>vprn>sub-if>grp-if>dhcp>option>vendor sap-id)
[Tree] (config>service>vpls>sap>dhcp>option>vendor sap-id)
[Tree] (config>service>vprn>if>dhcp>option>vendor sap-id)
[Tree] (config>service>ies>sub-if>grp-if>dhcp>option>vendor sap-id)
Full Context
configure subscriber-mgmt msap-policy vpls-only-sap-parameters dhcp option vendor-specific-option sap-id
configure service vprn subscriber-interface group-interface dhcp option vendor-specific-option sap-id
configure service vpls sap dhcp option vendor-specific-option sap-id
configure service vprn interface dhcp option vendor-specific-option sap-id
configure service ies subscriber-interface group-interface dhcp option vendor-specific-option sap-id
Description
This command enables the sending of the SAP ID in the Nokia vendor-specific sub-option of the DHCP relay packet.
The no form of this command disables the sending of the SAP ID in the Nokia vendor-specific sub-option of the DHCP relay packet.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
- configure service ies subscriber-interface group-interface dhcp option vendor-specific-option sap-id
- configure subscriber-mgmt msap-policy vpls-only-sap-parameters dhcp option vendor-specific-option sap-id
- configure service vprn subscriber-interface group-interface dhcp option vendor-specific-option sap-id
All
- configure service vpls sap dhcp option vendor-specific-option sap-id
- configure service vprn interface dhcp option vendor-specific-option sap-id
sap-id
Syntax
sap-id sap-string
no sap-id
Context
[Tree] (config>service>dynsvc>ladb>user>idx sap-id)
Full Context
configure service dynamic-services local-auth-db user-name index sap-id
Description
This command specifies the dynamic data service SAP that is created. A dynamic service SAP ID uniquely identifies a dynamic data service instance. For a local authenticated dynamic service data trigger, one of the dynamic service SAP IDs must be the data trigger SAP.
The no form of this command removes the sap-id from the configuration.
Parameters
- sap-string
-
Specifies a string representing the dynamic service SAP ID (only SAPs on Ethernet ports and LAGs are valid), up to 64 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap-ingress
sap-ingress
Syntax
sap-ingress {policy-id | policy-name} [create] [name name]
no sap-ingress {policy-id | policy-name}
Context
[Tree] (config>qos sap-ingress)
Full Context
configure qos sap-ingress
Description
This command is used to create or edit the ingress policy. The ingress policy defines the SLA enforcement that service packets receive as they ingress a SAP. SLA enforcement is accomplished through the definition of queues that have Forwarding Class (FC), Fair Information Rate (FIR), Committed Information Rate (CIR), Peak Information Rate (PIR), Committed Burst Size (CBS), and Maximum Burst Size (MBS) characteristics.
Policies in effect are templates that can be applied to multiple services as long as the scope of the policy is template. Queues defined in the policy are not instantiated until they are assigned to at least one forwarding class and a policy is applied to a service SAP.
It is possible that a SAP ingress policy will include the dscp map command, the dot1p map command, and an IP or MAC match criteria. When multiple matches occur for the traffic, the order of precedence will be used to arrive at the final action. The order of precedence is as follows:
-
802.1p bits
-
DSCP
-
IP quintuple or MAC headers
The SAP ingress policy with policy-id 1 is a system-defined policy applied to services when no other policy is explicitly specified. The system SAP ingress policy cannot be modified or deleted. The default SAP ingress policy defines one unicast and one multipoint queue associated with all forwarding classes, with an FIR of zero, a CIR of zero, and a PIR of line rate.
Any changes made to the existing policy, using any of the sub-commands, are applied immediately to all services where this policy is applied. For this reason, when many changes are required on a policy, it is recommended that the policy be copied to a work area policy ID. That work-in-progress policy can be modified until complete, then written over the original policy-id. Use the config>qos>copy command to maintain policies in this manner.
The no form of this command deletes the SAP ingress policy. A policy cannot be deleted until it is removed from all services where it is applied.
Parameters
- policy-id
-
The policy-id uniquely identifies the policy.
- policy-name
-
The policy-name uniquely identifies the policy.
- create
-
Required parameter when creating a SAP QoS ingress policy.
- name name
-
Configures an optional policy name, up to 64 characters in length, which adds a name identifier to a given policy to then use that policy name in configuration references as well as display and use policy names in show commands throughout the system. This helps the service provider/administrator to identify and manage sap-ingress policies within the SR OS platforms.
All sap-ingress policies are required to assign a policy ID to initially create a policy. However, either the policy ID or the policy name can be used to identify and reference a given policy once it is initially created.
If a name is not specified at creation time, then SR OS assigns a string version of the policy-id as the name.
Platforms
All
sap-ingress
Syntax
sap-ingress src-pol dst-pol [overwrite]
Context
[Tree] (config>qos>copy sap-ingress)
Full Context
configure qos copy sap-ingress
Description
This command copies existing QoS policy entries for a QoS policy-id to another QoS policy-id.
The copy command is a configuration-level maintenance tool used to create new policies using existing policies. It also allows bulk modifications to an existing policy with the use of the overwrite keyword.
Parameters
- overwrite
-
Specifies to replace the existing destination policy. Everything in the existing destination policy will be overwritten with the contents of the source policy. If overwrite is not specified, an error will occur if the destination policy ID exists.
- Example:
-
— SR>config>qos# copy sap-egress 1 1010
— MINOR: CLI Destination "1010" exists use {overwrite}.
— SR>config>qos# copy sap-egress 1 1010 overwrite
- src-pol dst-pol
-
Indicates that the source policy ID and the destination policy ID are SAP ingress policy IDs. Specify the source policy ID that the copy command will attempt to copy from and specify the destination policy ID to which the command will copy a duplicate of the policy.
Platforms
All
sap-limit
sap-limit
Syntax
sap-limit [limit]
no sap-limit
Context
[Tree] (config>service>dynsvc>policy sap-limit)
Full Context
configure service dynamic-services dynamic-services-policy sap-limit
Description
This command specifies a limit for the number of dynamic data service instances (SAPs) that can be setup simultaneously using a given dynamic services policy.
A value of zero (0) means the policy is drained: existing dynamic data services can be modified and torn down but no new dynamic data services can be setup.
Default
sap-limit 1
Parameters
- limit
-
Specifies the number of dynamic data service SAPs that can be setup simultaneously using this dynamic services policy.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap-parameters
sap-parameters
Syntax
sap-parameters
Context
[Tree] (config>service>ies>sub-if>grp-if sap-parameters)
[Tree] (config>service>vprn>sub-if>grp-if sap-parameters)
Full Context
configure service ies subscriber-interface group-interface sap-parameters
configure service vprn subscriber-interface group-interface sap-parameters
Description
Commands in this context configure parameters that can be applied to automatically-generated internal SAPs.
Platforms
7750 SR, 7750 SR-e, 7750 SR-s, VSR
sap-session-index
sap-session-index
Syntax
[no] sap-session-index
Context
[Tree] (config>subscr-mgmt>auth-policy>include-radius-attribute sap-session-index)
Full Context
configure subscriber-mgmt authentication-policy include-radius-attribute sap-session-index
Description
This command includes sap-session-index attributes.
The no form of this command excludes sap-session-index attributes.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap-session-limit
sap-session-limit
Syntax
sap-session-limit sap-session-limit
no sap-session-limit
Context
[Tree] (config>service>ies>sub-if>grp-if>pppoe sap-session-limit)
[Tree] (config>service>vprn>sub-if>grp-if>pppoe sap-session-limit)
Full Context
configure service ies subscriber-interface group-interface pppoe sap-session-limit
configure service vprn subscriber-interface group-interface pppoe sap-session-limit
Description
This command specifies the number of PPPoE hosts per SAP allowed for this group-interface.
The no form of this command reverts to the default.
Default
sap-session-limit 1
Parameters
- sap-session-limit
-
Specifies the number of PPPoE hosts per SAP allowed.
Note:The operational maximum value may be smaller due to equipped hardware dependencies.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap-session-limit
Syntax
sap-session-limit sap-session-limit
no sap-session-limit
Context
[Tree] (config>service>ies>sub-if>grp-if>ipoe-session sap-session-limit)
[Tree] (config>service>vprn>sub-if>grp-if>ipoe-session sap-session-limit)
Full Context
configure service ies subscriber-interface group-interface ipoe-session sap-session-limit
configure service vprn subscriber-interface group-interface ipoe-session sap-session-limit
Description
This command specifies the number of IPoE sessions per SAP allowed for this group-interface.
The no form of this command reverts to the default.
Default
sap-session-limit 1
Parameters
- sap-session-limit
-
Specifies the number of allowed IPoE sessions.
Note:The operational maximum value may be smaller due to equipped hardware dependencies.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap-template
sap-template
Syntax
sap-template sap-template
no sap-template
Context
[Tree] (config>service>vpls>wlan-gw sap-template)
Full Context
configure service vpls wlan-gw sap-template
Description
This command specifies the VPLS SAP template that is applied on the internal SAPs created for communication between the VPLS and the ISAs.
The no form of this command removes the SAP template.
Parameters
- sap-template
-
Specifies the existing SAP template to apply. The template is created in the config>service>template context.
Platforms
7750 SR, 7750 SR-e, 7750 SR-s, VSR
sap-template
Syntax
sap-template name [create]
no sap-template name
Context
[Tree] (config>subscr-mgmt sap-template)
Full Context
configure subscriber-mgmt sap-template
Description
This command configures a template that specifies parameters for automatically generated subscriber SAPs, for example, when creating CUPS sessions. A template with the name "default" is used if no specific name is provided, but this must be manually provisioned.
The no form of this command removes the template.
Parameters
- name
-
Specifies the name of the PFCP association, up to 32 characters.
- create
-
Keyword used to create the SAP template.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
sap-template-binding
sap-template-binding
Syntax
sap-template-binding name/id
no sap-template-binding
Context
[Tree] (config>service>vpls>vpls-group sap-template-binding)
Full Context
configure service vpls vpls-group sap-template-binding
Description
This command configures the binding to a SAP template to be used to instantiate SAPs in the data VPLS using as input variables the VLAN IDs generated by the vid-range command.
The no form of this command removes the binding and deletes the related SAP instances. The command will fail if any of the affected VPLS instances have either a provisioned SAP or an active MVRP declaration/registration or if the related vpls-group is in no shutdown state. Any changes to the sap-template-binding require the vpls-group to be in shutdown state. New control SAP additions to the management VPLS are allowed as long as data VPLS instantiations/removals for vpls-groups are not in progress. Control SAPs can be removed at any time generating the removal of related data SAPs from the data VPLS. The shutdown or no shutdown state for the control SAPs does not have any effect on data SAPs instantiated with this command.
Default
no sap-template-binding
Parameters
- name
-
Specifies the name of the VPLS template
- id
-
Specifies the ID of the VPLS template
Platforms
All
saps
saps
Syntax
saps {qset-size size | non-shaper-queues}
Context
[Tree] (config>qos>fp-resource-policy>aggregate-shapers>queue-sets>default-size saps)
Full Context
configure qos fp-resource-policy aggregate-shapers queue-sets default-size saps
Description
This command configures the default queue-set size for SAPs.
Parameters
- size
-
Specifies the size of the queue sets.
- non-shaper-queues
-
Specifies that subscribers will not use hardware aggregate shapers on FPs where the FP resource policy is applied.
Platforms
7750 SR-1, 7750 SR-s
sat-type
sat-type
Syntax
sat-type sat-type [port-template template-name]
no sat-type
Context
[Tree] (config>system>satellite>eth-sat sat-type)
[Tree] (config>system>satellite>tdm-sat sat-type)
Full Context
configure system satellite eth-sat sat-type
configure system satellite tdm-sat sat-type
Description
This command configures the type of satellite variant for the associated satellite chassis.
The no form of the command deletes the sat-type configuration.
Default
no sat-type
Parameters
- sat-type
-
Specifies the satellite type. Configuration of the following variants is supported:
- es24-1gb-sfp
-
Specifies the 24xGE (SFP) + 4x10GE Ethernet satellite.
- es48-1gb-sfp
-
Specifies the 48xGE (SFP) + 4x10GE Ethernet satellite.
- es24-sass-1gb-sfp
-
Specifies the SAS-S 24xGE (SFP) + 4x10GE Ethernet satellite.
- es48-sass-1gb-sfp
-
Specifies the SAS-S 48xGE (SFP) + 4x10GE Ethernet satellite.
- es24-1gb-tx
-
Specifies the 24xGE (copper) + 4x10GE Ethernet satellite.
- es48-1gb-tx
-
Specifies the 48xGE (copper) + 4x10GE Ethernet satellite.
- es24-1gb-tx
-
Specifies the 24-port copper + PoE Ethernet satellite.
- es48-1gb-tx
-
Specifies the 48-port copper + PoE Ethernet satellite.
- es64-10gb-sfpp+4-100gb-cfp4
-
Specifies the 64x10GE + 4x100GE Ethernet satellite.
- es64-10gb-sfpp+4-100gb-qsfp28
-
Specifies the 64x10GE + 4xQSFP28 Ethernet satellite.
- es24-sasmxp-1gb-sfp
-
Specifies the 7210 SAS-Mxp as an ethernet satellite.
- ts4-choc3-sfp
-
Specifies the 4-port OC3 TDM satellite.
- ts4-chstm1-sfp
-
Specifies the 4-port STM1 TDM satellite.
- ts1-choc12-sfp
-
Specifies the 1-port OC12 TDM satellite.
- ts1-chstm4-sfp
-
Specifies the 1-port STM4 TDM satellite.
- template-name
-
Specifies the name for the associated port template.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
- configure system satellite eth-sat sat-type
7450 ESS, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e
- configure system satellite tdm-sat sat-type
satellite
satellite
Syntax
satellite
Context
[Tree] (config>system satellite)
Full Context
configure system satellite
Description
This command enables the satellite configuration context. Within the satellite context, the administrator can specify the configuration details for a satellite chassis that is hosted by the associated local system.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
satellite
Syntax
satellite
Context
[Tree] (admin satellite)
Full Context
admin satellite
Description
This command performs satellite operations.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
save
save
Syntax
save
Context
[Tree] (config>li save)
Full Context
configure li save
Description
This command is required to save LI configuration parameters.
Platforms
All
save
Syntax
save [cflash-id]
Context
[Tree] (bof save)
Full Context
bof save
Description
This command uses the boot option parameters currently in memory and writes them from the boot option file to the specified compact flash.
The BOF must be located in the root directory of the internal or external compact flash drives local to the system and have the mandatory filename of bof.cfg.
If a location is not specified, the BOF is saved to the default compact flash drive (cf3:) on the active CPM (typically the CPM in slot A, but the CPM in slot B could also be acting as the active CPM). The slot name is not case-sensitive. You can use upper or lowercase "A” or "B”.
Command usage:
-
bof save — saves the BOF to the default drive (cf3:) on the active CPM (either in slot A or B)
-
bof save cf3: — saves the BOF to cf3: on the active CPM (either in slot A or B)
To save the BOF to a compact flash drive on the standby CPM (for example, the redundant (standby) CPM is installed in slot B), specify -A or -B option.
Command usage:
-
bof save cf3-A: — saves the BOF to cf3: on CPM in slot A whether it is active or standby
-
bof save cf3-B: — saves the BOF to cf3: on CPM in slot B whether it is active or standby
The slot name is not case-sensitive. You can use upper or lowercase "A” or "B”.
The bof save and show bof commands allow you to save to or read from the compact flash of the standby CPM. Use the show card command to determine the active and standby CPM (A or B).
Default
Saves must be explicitly executed. The BOF is saved to cf3: if a location is not specified.
Parameters
- flash-id
-
Specifies the compact flash ID where the bof.cfg is to be saved.
Platforms
All
save
Syntax
save file-url
Context
[Tree] (candidate save)
Full Context
candidate save
Description
This command saves the current candidate to a file.
Parameters
- file-url
-
Specifies the directory and filename.
Platforms
All
save
Syntax
save [comment comment] [rescue]
Context
[Tree] (admin>rollback save)
Full Context
admin rollback save
Description
If the optional rescue keyword is not used, this command saves a rollback checkpoint at the location and with the filename specified by the rollback-location with a suffix of .rb. The previously saved checkpoints will have their suffixes incremented by one (.rb.1 becomes .rb.2, and so on). If there are already as many checkpoint files as the maximum number supported, then the last checkpoint file is deleted.
If the rescue keyword is used, then this command saves the current operational configuration as a rescue configuration at the location and with the filename specified by the rescue location. The filename will have the suffix .rc appended.
Parameters
- comment-string
-
Specifies a comment, up to 255 characters, that is associated with the checkpoint.
- rescue
-
Saves the rescue checkpoint instead of a normal rollback checkpoint.
Platforms
All
save
Syntax
save [file-url] [detail] [index]
Context
[Tree] (admin save)
Full Context
admin save
Description
This command saves the running configuration to a configuration file. For example:
A:ALA-1>admin# save ftp://test:test@192.168.x.xx/./100.cfg
Saving configuration .........Completed.
By default, the running configuration is saved to the primary configuration file.
Parameters
- file-url
-
Specifies the file URL location to save the configuration file.
- detail
-
Saves both default and non-default configuration parameters.
- index
-
Forces a save of the persistent index file regardless of the persistent status in the BOF file. The index option can also be used to avoid an additional boot required while changing your system to use the persistence indices.
Platforms
All
save-deterministic-script
save-deterministic-script
Syntax
save-deterministic-script
Context
[Tree] (admin>nat save-deterministic-script)
Full Context
admin nat save-deterministic-script
Description
This command saves the script that calculates Deterministic NAT map entries.
Once the location for the Python deterministic NAT script is configured, the script is generated/updated every time deterministic NAT configuration is modified. However, the script must be manually exported to the remote location. This command triggers the export of the script to a remote location.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
save-when-restricted
save-when-restricted
Syntax
save-when-restricted
no save-when-restricted
Context
[Tree] (config>system>security>user save-when-restricted)
[Tree] (config>system>security>user-template save-when-restricted)
Full Context
configure system security user save-when-restricted
configure system security user-template save-when-restricted
Description
This command specifies whether the system permits all configuration save operations (such as admin save) via any management interface (such as CLI and NETCONF) even if restricted-to-home is enabled. The home directory does not need to be configured.
Default
no save-when-restricted
Platforms
All
saved-ind-prompt
saved-ind-prompt
Syntax
[no] saved-ind-prompt
Context
[Tree] (environment saved-ind-prompt)
Full Context
environment saved-ind-prompt
Description
This command enables saved indicator in the prompt. When changes are made to the configuration file a "*” appears in the prompt string indicating that the changes have not been saved. When an admin save command is executed the "*” disappears.
*A:ALA-48# admin save
Writing file to ftp://192.0.2.43/./sim48/sim48-config.cfg
Saving configuration .... Completed.
A:ALA-48#
Platforms
All
scaling-profile
scaling-profile
Syntax
scaling-profile scaling-profile-id
Context
[Tree] (config>isa>nat-group scaling-profile)
Full Context
configure isa nat-group scaling-profile
Description
This command determines profiles for NAT scaling. Lower profile numbers allocate less resources, therefore, supporting lower scaling.
Contact your Nokia representative for more information about NAT scaling figures in each profile.
Default
scaling-profile profile1
Parameters
- scaling-profile-id
-
Specifies the name of the profile, up to 32 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
sched-class
sched-class
Syntax
sched-class sched-class group name [weight weight]
no sched-class sched-class
Context
[Tree] (config>qos>hw-agg-shap-sched-plcy sched-class)
Full Context
configure qos hw-agg-shaper-scheduler-policy sched-class
Description
This command configures the scheduling class for the hardware aggregate shaper scheduler policy.
The no form of this command removes the scheduling class configuration.
Parameters
- sched-class
-
Specifies the scheduling class ID.
- name
-
Assigns the specified scheduling class to a group within the hardware aggregate shaper scheduler policy.
- weight
-
Specifies the weight for a scheduling class within the specified group.
Platforms
7750 SR-1, 7750 SR-s
sched-class
Syntax
sched-class sched-class
no sched-class
Context
[Tree] (config>qos>sap-egress>queue sched-class)
Full Context
configure qos sap-egress queue sched-class
Description
This command configures the scheduling class for the hardware aggregate shaper scheduler policy.
The no form of this command removes the scheduling class configuration.
Parameters
- sched-class
-
Specifies the scheduling class ID.
Platforms
7750 SR-1, 7750 SR-s
sched-class-elevation
sched-class-elevation
Syntax
sched-class-elevation sched-class sched-class weight weight
no sched-class-elevation sched-class sched-class
Context
[Tree] (config>qos>sap-egress sched-class-elevation)
Full Context
configure qos sap-egress sched-class-elevation
Description
This command configures the scheduling class elevation.
The no form of this command removes the scheduling class elevation configuration.
Parameters
- sched-class
-
Specifies the scheduling class ID.
- weight
-
Specifies the weight for the scheduling class.
Platforms
7750 SR-1, 7750 SR-s
sched-run-min-int
sched-run-min-int
Syntax
sched-run-min-int percent-of-default
no sched-run-min-int
Context
[Tree] (config>card>virt-sched-adj sched-run-min-int)
Full Context
configure card virtual-scheduler-adjustment sched-run-min-int
Description
This command overrides the default minimum time that must elapse before a virtual scheduler may redistribute bandwidth based on changes to the offered rates of member policers or queues. A minimum run interval is enforced to allow a minimum amount of "batching” queue changes before reacting to the changed rates. This minimum interval is beneficial since the periodic function of determining policer or queue offered rates is performed sequentially and the interval allows a number policer and queue rates to be determined prior to determining the distribution of bandwidth to the policers and queues.
The default minimum scheduler run interval is 0.5 seconds. The sched-run-min-int command uses a percent value to modify the default interval.
The no form of this command restores the default minimum scheduler run interval for all virtual schedulers on the card.
Default
no sched-run-min-int
Parameters
- percent-of-default
-
Specifies that the percent-of-default parameter is required and is used to modify the default minimum scheduler run interval for all virtual schedulers on the card. Defining 100.00 percent is equivalent to removing the override (restoring the default) for the minimum scheduler run interval.
Platforms
All
schedule
schedule
Syntax
[no] schedule schedule-name [owner schedule-owner]
Context
[Tree] (config>system>cron schedule)
Full Context
configure system cron schedule
Description
This command configures the type of schedule to run, including one-time only (oneshot), periodic or calendar-based runs. All runs are determined by month, day of month or weekday, hour, minute and interval (seconds).
The no form of the command removes the context from the configuration.
Parameters
- schedule-name
-
Specifies the name of the schedule. The name can be up to 32 characters.
- schedule-owner
-
Specifies the owner name of the schedule. The name can be up to 32 characters.
Platforms
All
schedule-type
schedule-type
Syntax
schedule-type schedule-type
Context
[Tree] (config>system>security>pki>ca-prof>auto-crl-update schedule-type)
Full Context
configure system security pki ca-profile auto-crl-update schedule-type
Description
This command specifies the schedule type for auto CRL update. The system supports two types:
-
periodic: — The system will download a CRL periodically at the interval configured via the periodic-update-interval command. For example, if the periodic-update-interval is 1 day, then the system will download a CRL every 1 day. The minimal periodic-update-interval is 1 hour.
-
next-update-based — The system will download a CRL at the time = Next_Update_of_existing_CRL minus pre-update-time. For example, if the Next-Update of the existing CRL is 2015-06-30 06:00 and pre-update-time is 1 hour, then the system will start downloading at 2015-06-30, 05:00.
Default
schedule-type next-update-based
Parameters
- schedule-type
-
Specifies the type of time scheduler to update the CRL.
Platforms
All
scheduler
scheduler
Syntax
scheduler scheduler-name rate pir-rate [cir cir-rate]
no scheduler scheduler-name
Context
[Tree] (config>subscr-mgmt>sub-prof>ing>sched scheduler)
[Tree] (config>subscr-mgmt>sub-prof>egr>sched scheduler)
Full Context
configure subscriber-mgmt sub-profile ingress scheduler-policy scheduler
configure subscriber-mgmt sub-profile egress scheduler-policy scheduler
Description
This command provides a way to override parameters of the existing scheduler associated with the egress or ingress scheduler policy. A scheduler defines bandwidth controls that limit each child (other schedulers and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have queues or other schedulers defined as child associations. The scheduler can be a child (take bandwidth from a scheduler in a higher tier).
The no form of this command reverts to the default.
Parameters
- scheduler-policy-name
-
Specify an existing scheduler policy name.
- pir-rate
-
Specify the pir-rate, in kilobits, to override the administrative PIR used by the scheduler. When the rate command is executed, a valid PIR setting must be explicitly defined. Fractional values are not allowed and must be given as a positive integer.
- cir-rate
-
The cir parameter overrides the administrative CIR used by the scheduler. When the rate command is executed, a CIR setting is optional. The sum keyword specifies that the CIR be used as the summed CIR values of the children schedulers or queues. Fractional values are not allowed and must be given as a positive integer.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
scheduler
Syntax
scheduler scheduler-name [create]
no scheduler scheduler-name
Context
[Tree] (config>service>vpls>sap>egress>sched-override scheduler)
Full Context
configure service vpls sap egress scheduler-override scheduler
Description
This command overrides specific attributes of the specified scheduler name.
A scheduler defines a bandwidth control that limits each child (other schedulers, policers and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created has policers, queues or other schedulers defined as child associations. The scheduler can be a child which takes bandwidth from a scheduler in a higher tier. A total of 32 schedulers can be created within a single scheduler policy with no restriction on the distribution between the tiers.
Each scheduler must have a unique name within the context of the scheduler policy; however the same name can be reused in multiple scheduler policies. If scheduler-name already exists within the policy tier level (regardless of the inclusion of the keyword create), the context changes to that scheduler name for the purpose of editing the scheduler parameters. Modifications made to an existing scheduler are executed on all instantiated schedulers created through association with the policy of the edited scheduler. This can cause policers, queues or schedulers to become orphaned (invalid parent association) and adversely affect the ability of the system to enforce service level agreements (SLAs).
If the scheduler-name exists within the policy on a different tier (regardless of the inclusion of the keyword create), an error occurs and the current CLI context does not change.
If the scheduler-name does not exist in this or another tier within the scheduler policy, it is assumed that an attempt is being made to create a scheduler of that name. The success of the command execution is dependent on the following:
-
The maximum number of schedulers has not been configured.
-
The provided scheduler-name is valid.
-
The create keyword is entered with the command if the system is configured to require it (enabled in the environment create command).
When the maximum number of schedulers has been exceeded on the policy, a configuration error occurs and the command does not execute, nor does the CLI context change.
If the provided scheduler-name is invalid according to the criteria below, a name syntax error occurs, the command does not execute, and the CLI context does not change.
The no form of this command removes the scheduler name from the configuration.
Parameters
- scheduler-name
-
Specifies name of the scheduler
- create
-
This optional keyword explicitly specifies that it is acceptable to create a scheduler with the given scheduler-name. If the create keyword is omitted, scheduler-name is not created when the system environment variable create is set to true. This safeguard is meant to avoid accidental creation of system objects (such as schedulers) while attempting to edit an object with a mistyped name or ID. The keyword has no effect when the object already exists.
Platforms
All
scheduler
Syntax
scheduler scheduler-name [create]
no scheduler scheduler-name
Context
[Tree] (config>port>ethernet>access>egr>qgrp>sched-override scheduler)
[Tree] (config>port>ethernet>access>ing>qgrp>sched-override scheduler)
Full Context
configure port ethernet access egress queue-group scheduler-override scheduler
configure port ethernet access ingress queue-group scheduler-override scheduler
Description
This command can be used to override specific attributes of the specified scheduler name. A scheduler defines bandwidth controls that limit each child (other schedulers and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have queues or other schedulers defined as child associations. The scheduler can be a child which takes bandwidth from a scheduler in a higher tier. A total of 32 schedulers can be created within a single scheduler policy with no restriction on the distribution between the tiers. The scheduler-name must exist in the applied scheduler policy.
The no form of this command removes the scheduler overrides for the specified scheduler and returns the scheduler’s parent weight and CIR weight, and its PIR and CIR to the values configured in the applied scheduler policy.
Parameters
- scheduler-name
-
Specifies the name of the scheduler.
- create
-
Creates a new scheduler for this port.
Platforms
All
scheduler
Syntax
scheduler scheduler-name [create]
no scheduler scheduler-name
Context
[Tree] (config>service>ipipe>sap>ingress>sched-override scheduler)
[Tree] (config>service>cpipe>sap>ingress>sched-override scheduler)
[Tree] (config>service>apipe>sap>ingress>sched-override scheduler)
[Tree] (config>service>epipe>sap>egress>sched-override scheduler)
[Tree] (config>service>fpipe>sap>ingress>sched-override scheduler)
[Tree] (config>service>fpipe>sap>egress>sched-override scheduler)
[Tree] (config>service>ipipe>sap>egress>sched-override scheduler)
[Tree] (config>service>cpipe>sap>egress>sched-override scheduler)
[Tree] (config>service>apipe>sap>egress>sched-override scheduler)
[Tree] (config>service>epipe>sap>ingress>sched-override scheduler)
Full Context
configure service ipipe sap ingress scheduler-override scheduler
configure service cpipe sap ingress scheduler-override scheduler
configure service apipe sap ingress scheduler-override scheduler
configure service epipe sap egress scheduler-override scheduler
configure service fpipe sap ingress scheduler-override scheduler
configure service fpipe sap egress scheduler-override scheduler
configure service ipipe sap egress scheduler-override scheduler
configure service cpipe sap egress scheduler-override scheduler
configure service apipe sap egress scheduler-override scheduler
configure service epipe sap ingress scheduler-override scheduler
Description
This command can be used to override specific attributes of the specified scheduler name. A scheduler defines bandwidth controls that limit each child (other schedulers, policers, and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have policers, queues or other schedulers defined as child associations. The scheduler can be a child which takes bandwidth from a scheduler in a higher tier. A total of 32 schedulers can be created within a single scheduler policy with no restriction on the distribution between the tiers.
Each scheduler must have a unique name within the context of the scheduler policy; however the same name can be reused in multiple scheduler policies. If scheduler-name already exists within the policy tier level (regardless of the inclusion of the keyword create), the context changes to that scheduler name for the purpose of editing the scheduler parameters. Modifications made to an existing scheduler are executed on all instantiated schedulers created through association with the policy of the edited scheduler. This can cause policers, queues, or schedulers to become orphaned (invalid parent association) and adversely affect the ability of the system to enforce service level agreements (SLAs).
If the scheduler-name exists within the policy on a different tier (regardless of the inclusion of the keyword create), an error occurs and the current CLI context will not change.
If the scheduler-name does not exist in this or another tier within the scheduler policy, it is assumed that an attempt is being made to create a scheduler of that name. The success of the command execution is dependent on the following:
-
The maximum number of schedulers has not been configured.
-
The provided scheduler-name is valid.
-
The create keyword is entered with the command if the system is configured to require it (enabled in the environment create command).
When the maximum number of schedulers has been exceeded on the policy, a configuration error occurs and the command will not execute, nor will the CLI context change.
If the provided scheduler-name is invalid according to the following criteria, a name syntax error will occur, the command will not execute, and the CLI context will not change.
Parameters
- scheduler-name
-
The name of the scheduler. Each scheduler must be explicitly created.
- create
-
This optional keyword explicitly specifies that it is acceptable to create a scheduler with the given scheduler-name. If the create keyword is omitted, scheduler-name is not created when the system environment variable create is set to true. This safeguard is meant to avoid accidental creation of system objects (such as schedulers) while attempting to edit an object with a mistyped name or ID. The keyword has no effect when the object already exists.
Platforms
All
- configure service epipe sap egress scheduler-override scheduler
- configure service ipipe sap egress scheduler-override scheduler
- configure service ipipe sap ingress scheduler-override scheduler
- configure service epipe sap ingress scheduler-override scheduler
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
- configure service cpipe sap egress scheduler-override scheduler
- configure service fpipe sap egress scheduler-override scheduler
- configure service cpipe sap ingress scheduler-override scheduler
- configure service fpipe sap ingress scheduler-override scheduler
7450 ESS, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e, 7950 XRS
- configure service apipe sap ingress scheduler-override scheduler
- configure service apipe sap egress scheduler-override scheduler
scheduler
Syntax
scheduler scheduler-name [create]
no scheduler scheduler-name
Context
[Tree] (config>service>vprn>if>sap>egress>sched-override scheduler)
[Tree] (config>service>vprn>if>sap>ingress>sched-override scheduler)
Full Context
configure service vprn interface sap egress scheduler-override scheduler
configure service vprn interface sap ingress scheduler-override scheduler
Description
This command can be used to override specific attributes of the specified scheduler name.
A scheduler defines a bandwidth controls that limit each child (other schedulers, policers, and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have policers, queues, or other schedulers defined as child associations. The scheduler can be a child which takes bandwidth from a scheduler in a higher tier. A total of 32 schedulers can be created within a single scheduler policy with no restriction on the distribution between the tiers.
Each scheduler must have a unique name within the context of the scheduler policy; however the same name can be reused in multiple scheduler policies. If scheduler-name already exists within the policy tier level (regardless of the inclusion of the keyword create), the context changes to that scheduler name for the purpose of editing the scheduler parameters. Modifications made to an existing scheduler are executed on all instantiated schedulers created through association with the policy of the edited scheduler. This can cause queues or schedulers to become orphaned (invalid parent association) and adversely affect the ability of the system to enforce service level agreements (SLAs).
If the scheduler-name exists within the policy on a different tier (regardless of the inclusion of the keyword create), an error occurs and the current CLI context will not change.
If the scheduler-name does not exist in this or another tier within the scheduler policy, it is assumed that an attempt is being made to create a scheduler of that name. The success of the command execution is dependent on the following:
-
The maximum number of schedulers has not been configured.
-
The provided scheduler-name is valid.
-
The create keyword is entered with the command if the system is configured to require it (enabled in the environment create command).
When the maximum number of schedulers has been exceeded on the policy, a configuration error occurs and the command will not execute, nor will the CLI context change.
If the provided scheduler-name is invalid according to the criteria below, a name syntax error will occur, the command will not execute, and the CLI context will not change.
Parameters
- scheduler-name
-
Specifies the name of the scheduler.
- create
-
Specifies that it is acceptable to create a scheduler with the given scheduler-name. If the create keyword is omitted, scheduler-name is not created when the system environment variable create is set to true. This safeguard is meant to avoid accidental creation of system objects (such as schedulers) while attempting to edit an object with a mistyped name or ID. The keyword has no effect when the object already exists.
Platforms
All
scheduler
Syntax
scheduler scheduler-name [create]
no scheduler scheduler-name
Context
[Tree] (config>service>ies>if>sap>egress>sched-override scheduler)
[Tree] (config>service>ies>if>sap>ingress>sched-override scheduler)
Full Context
configure service ies interface sap egress scheduler-override scheduler
configure service ies interface sap ingress scheduler-override scheduler
Description
This command can be used to override specific attributes of the specified scheduler name.
A scheduler defines a bandwidth controls that limit each child (other schedulers, policers, and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have policers, queues, or other schedulers defined as child associations. The scheduler can be a child which takes bandwidth from a scheduler in a higher tier. A total of 32 schedulers can be created within a single scheduler policy with no restriction on the distribution between the tiers.
Each scheduler must have a unique name within the context of the scheduler policy; however the same name can be reused in multiple scheduler policies. If scheduler-name already exists within the policy tier level (regardless of the inclusion of the keyword create), the context changes to that scheduler name for the purpose of editing the scheduler parameters. Modifications made to an existing scheduler are executed on all instantiated schedulers created through association with the policy of the edited scheduler. This can cause queues or schedulers to become orphaned (invalid parent association) and adversely affect the ability of the system to enforce service level agreements (SLAs).
If the scheduler-name exists within the policy on a different tier (regardless of the inclusion of the keyword create), an error occurs and the current CLI context will not change.
If the scheduler-name does not exist in this or another tier within the scheduler policy, it is assumed that an attempt is being made to create a scheduler of that name. The success of the command execution is dependent on the following:
-
The maximum number of schedulers has not been configured.
-
The provided scheduler-name is valid.
-
The create keyword is entered with the command if the system is configured to require it (enabled in the environment create command).
When the maximum number of schedulers has been exceeded on the policy, a configuration error occurs and the command will not execute, nor will the CLI context change.
If the provided scheduler-name is invalid according to the criteria below, a name syntax error will occur, the command will not execute, and the CLI context will not change.
Parameters
- scheduler-name
-
The name of the scheduler. Each scheduler must be explicitly created.
- create
-
This optional keyword explicitly specifies that it is acceptable to create a scheduler with the given scheduler-name. If the create keyword is omitted, scheduler-name is not created when the system environment variable create is set to true. This safeguard is meant to avoid accidental creation of system objects (such as schedulers) while attempting to edit an object with a mistyped name or ID. The keyword has no effect when the object already exists.
Platforms
All
scheduler
Syntax
scheduler scheduler-name [create]
no scheduler scheduler-name
Context
[Tree] (config>qos>scheduler-policy>tier scheduler)
Full Context
configure qos scheduler-policy tier scheduler
Description
This command creates a new scheduler or edits an existing scheduler within the scheduler policy tier. A scheduler defines bandwidth controls that limit each child (other schedulers and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have queues or other schedulers defined as child associations. The scheduler can be a child which takes bandwidth from a scheduler in a higher tier. A total of 32 schedulers can be created within a single scheduler policy with no restriction on the distribution between the tiers.
Each scheduler must have a unique name within the context of the scheduler policy; however, the same name can be reused in multiple scheduler policies. If scheduler-name already exists within the policy tier level (regardless of the inclusion of the keyword create), the context changes to that scheduler name for the purpose of editing the scheduler parameters. Modifications made to an existing scheduler are executed on all instantiated schedulers created through association with the policy of the edited scheduler. This can cause queues or schedulers to become orphaned (invalid parent association) and adversely affect the ability of the system to enforce SLAs.
If the scheduler-name exists within the policy on a different tier (regardless of the inclusion of the keyword create), an error occurs and the current CLI context will not change.
If the scheduler-name does not exist in this or another tier within the scheduler policy, it is assumed that an attempt is being made to create a scheduler of that name. The success of the command execution is dependent on the following:
-
The maximum number of schedulers has not been configured.
-
The provided scheduler-name is valid.
-
The create keyword is entered with the command if the system is configured to require it (enabled in the environment create command).
When the maximum number of schedulers has been exceeded on the policy, a configuration error occurs, the command will not execute, nor will the CLI context change.
If the provided scheduler-name is invalid according to the criteria below, a name syntax error will occur, the command will not execute, and the CLI context will not change.
Parameters
- scheduler-name
-
Specifies the scheduler name.
- create
-
This optional keyword explicitly specifies that it is acceptable to create a scheduler with the given scheduler-name. If the create keyword is omitted, scheduler-name is not created when the system environment variable create is set to true. This safeguard is meant to avoid accidental creation of system objects (such as schedulers) while attempting to edit an object with a mistyped name or ID. The keyword has no effect when the object already exists.
Platforms
All
scheduler
Syntax
scheduler scheduler-name [create]
no scheduler scheduler-name
Context
[Tree] (config>service>cust>multi-service-site>egress>sched-override scheduler)
[Tree] (config>service>cust>multi-service-site>ingress>sched-override scheduler)
Full Context
configure service customer multi-service-site egress scheduler-override scheduler
configure service customer multi-service-site ingress scheduler-override scheduler
Description
This command override specifics attributes of the specified scheduler name.
A scheduler defines bandwidth controls that limit each child (other schedulers, policers and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have policers, queues or other schedulers defined as child associations. The scheduler can be a child which takes bandwidth from a scheduler in a higher tier. A total of 32 schedulers can be created within a single scheduler policy with no restriction on the distribution between the tiers.
Each scheduler must have a unique name within the context of the scheduler policy; however the same name can be reused in multiple scheduler policies. If scheduler-name already exists within the policy tier level (regardless of the inclusion of the keyword create), the context changes to that scheduler name for the purpose of editing the scheduler parameters. Modifications made to an existing scheduler are executed on all instantiated schedulers created through association with the policy of the edited scheduler. This can cause policer, queues or schedulers to become orphaned (invalid parent association) and adversely affect the ability of the system to enforce service level agreements (SLAs).
If the scheduler-name exists within the policy on a different tier (regardless of the inclusion of the keyword create), an error occurs and the current CLI context will not change.
If the scheduler-name does not exist in this or another tier within the scheduler policy, it is assumed that an attempt is being made to create a scheduler of that name. The success of the command execution is dependent on the following:
-
The maximum number of schedulers has not been configured.
-
The provided scheduler-name is valid.
-
The create keyword is entered with the command if the system is configured to require it (enabled in the environment create command).
When the maximum number of schedulers has been exceeded on the policy, a configuration error occurs and the command will not execute, nor will the CLI context change.
If the provided scheduler-name is invalid according to the criteria below, a name syntax error will occur, the command will not execute, and the CLI context will not change.
The no form of the command disables the scheduler override.
Parameters
- scheduler-name
-
Specifies the name of the scheduler.
- create
-
This optional keyword explicitly specifies that it is acceptable to create a scheduler with the given scheduler-name. If the create keyword is omitted, scheduler-name is not created when the system environment variable create is set to true. This safeguard is meant to avoid accidental creation of system objects (such as schedulers) while attempting to edit an object with a mistyped name or ID. The keyword has no effect when the object already exists.
Platforms
All
scheduler
Syntax
scheduler scheduler-name rate pir-rate [cir cir-rate]
no scheduler scheduler-name
Context
[Tree] (config>subscr-mgmt>sla-prof>egress>sched scheduler)
Full Context
configure subscriber-mgmt sla-profile egress scheduler-policy scheduler
Description
This command provides a way to override parameters of the existing scheduler associated with the egress scheduler policy. A scheduler defines bandwidth controls that limit each child (other schedulers and queues) associated with the scheduler. Scheduler objects are created within the hierarchical tiers of the policy. It is assumed that each scheduler created will have queues or other schedulers defined as child associations. The scheduler can be a child (take bandwidth from a scheduler in a higher tier).
The no form of this command reverts to the default.
Parameters
- scheduler-name
-
Specify an existing scheduler policy name up to 32 characters.
- pir-rate
-
Specifies the PIR rate in kb/s. This parameter overrides the administrative PIR used by the scheduler. When the rate command is executed, a valid PIR setting must be explicitly defined. Fractional values are not allowed and must be given as a positive integer.
- cir-rate
-
Specifies the CIR rate in kb/s. This parameter overrides the administrative CIR used by the scheduler. When the rate command is executed, a CIR setting is optional. The sum keyword specifies that the CIR be used as the summed CIR values of the children schedulers or queues. Fractional values are not allowed and must be given as a positive integer.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
scheduler-override
scheduler-override
Syntax
[no] scheduler-override
Context
[Tree] (config>service>vpls>sap>egress scheduler-override)
[Tree] (config>service>vpls>sap>ingress scheduler-override)
Full Context
configure service vpls sap egress scheduler-override
configure service vpls sap ingress scheduler-override
Description
Commands in this context configure the set of attributes whose values have been overridden via management on this virtual scheduler. Clearing a given flag returns the corresponding overridden attribute to the value defined on the SAP's ingress scheduler policy.
The no form of this command removes scheduler parameters from the configuration.
Platforms
All
scheduler-override
Syntax
[no] scheduler-override
Context
[Tree] (config>port>ethernet>access>egr>qgrp scheduler-override)
[Tree] (config>port>ethernet>access>ing>qgrp scheduler-override)
Full Context
configure port ethernet access egress queue-group scheduler-override
configure port ethernet access ingress queue-group scheduler-override
Description
This command specifies the set of attributes whose values have been overridden by management on this virtual scheduler. Clearing a given flag will return the corresponding overridden attribute to the value defined on the ingress or egress queue group template.
The no form of this command removes all of the scheduler overrides and returns the scheduler’s parent weight and CIR weight, and its PIR and CIR to the values configured in the applied scheduler policy.
Platforms
All
scheduler-override
Syntax
[no] scheduler-override
Context
[Tree] (config>service>apipe>sap>ingress scheduler-override)
[Tree] (config>service>ipipe>sap>ingress scheduler-override)
[Tree] (config>service>fpipe>sap>egress scheduler-override)
[Tree] (config>service>ipipe>sap>egress scheduler-override)
[Tree] (config>service>cpipe>sap>egress scheduler-override)
[Tree] (config>service>fpipe>sap>ingress scheduler-override)
[Tree] (config>service>epipe>sap>ingress scheduler-override)
[Tree] (config>service>epipe>sap>egress scheduler-override)
[Tree] (config>service>cpipe>sap>ingress scheduler-override)
[Tree] (config>service>apipe>sap>egress scheduler-override)
Full Context
configure service apipe sap ingress scheduler-override
configure service ipipe sap ingress scheduler-override
configure service fpipe sap egress scheduler-override
configure service ipipe sap egress scheduler-override
configure service cpipe sap egress scheduler-override
configure service fpipe sap ingress scheduler-override
configure service epipe sap ingress scheduler-override
configure service epipe sap egress scheduler-override
configure service cpipe sap ingress scheduler-override
configure service apipe sap egress scheduler-override
Description
This command specifies the set of attributes whose values have been overridden by management on this virtual scheduler. Clearing a given flag will return the corresponding overridden attribute to the value defined on the SAP's ingress scheduler policy.
Platforms
7450 ESS, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e, 7950 XRS
- configure service apipe sap ingress scheduler-override
- configure service apipe sap egress scheduler-override
All
- configure service epipe sap ingress scheduler-override
- configure service ipipe sap ingress scheduler-override
- configure service ipipe sap egress scheduler-override
- configure service epipe sap egress scheduler-override
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
- configure service cpipe sap ingress scheduler-override
- configure service fpipe sap ingress scheduler-override
- configure service fpipe sap egress scheduler-override
- configure service cpipe sap egress scheduler-override
scheduler-override
Syntax
[no] scheduler-override
Context
[Tree] (config>service>ies>if>sap>ingress scheduler-override)
[Tree] (config>service>ies>if>sap>egress scheduler-override)
Full Context
configure service ies interface sap ingress scheduler-override
configure service ies interface sap egress scheduler-override
Description
This command specifies the set of attributes whose values have been overridden via management on this virtual scheduler. Clearing a given flag will return the corresponding overridden attribute to the value defined on the SAP's ingress scheduler policy.
Platforms
All
scheduler-override
Syntax
[no] scheduler-override
Context
[Tree] (config>service>vprn>if>sap>ingress scheduler-override)
[Tree] (config>service>vprn>if>sap>egress scheduler-override)
Full Context
configure service vprn interface sap ingress scheduler-override
configure service vprn interface sap egress scheduler-override
Description
This command specifies the set of attributes whose values have been overridden via management on this virtual scheduler. Clearing a given flag will return the corresponding overridden attribute to the value defined on the SAP's ingress scheduler policy.
Platforms
All
scheduler-override
Syntax
[no] scheduler-override
Context
[Tree] (config>service>cust>multi-service-site>ingress scheduler-override)
[Tree] (config>service>cust>multi-service-site>egress scheduler-override)
Full Context
configure service customer multi-service-site ingress scheduler-override
configure service customer multi-service-site egress scheduler-override
Description
This command specifies the set of attributes whose values have been overridden by management on this virtual scheduler. Clearing a given flag will return the corresponding overridden attribute to the value defined on the SAP's ingress and egress scheduler policy.
The no form of the command disables the override.
Platforms
All
scheduler-parent
scheduler-parent
Syntax
scheduler-parent scheduler-name [weight weight] [level level] [cir-weight cir-weight] [cir-level cir-level]
no scheduler-parent
Context
[Tree] (config>qos>sap-egress>policer scheduler-parent)
Full Context
configure qos sap-egress policer scheduler-parent
Description
This command defines an optional parent scheduler that governs the available bandwidth given to a policer in addition to the PIR setting of the policer. When multiple schedulers, queues, or policers share a child status with the parent scheduler, the weight or level parameters define how this policer contends with the other children for the bandwidth of the parent. This command and the configuration of a SAP policer port-parent or parent arbiter are mutually exclusive.
Multiple schedulers can exist in different scheduler policies with the same scheduler-name; in this command, the associated scheduler-name pertains to a scheduler that should exist on the SAP as the policy is applied and the policer is created. When the policer is created on the SAP, the existence of the scheduler-name is dependent on a scheduler policy containing the scheduler-name being directly applied or indirectly applied (through a multiservice customer site) to the SAP. The policer accepts packets, but is not bandwidth limited by a virtual scheduler or the scheduler hierarchy applied to the SAP. The SAP to which the policer belongs displays an orphan policer status with the SapEgressPolicerMismatch flag in the show service sap-using output. The orphaned state of the policer is automatically cleared when the scheduler-name becomes available on the SAP.
The parent scheduler can be made unavailable by the removal of a scheduler policy or scheduler. When an existing parent scheduler is removed or inoperative, the policer enters the orphaned state. The policer automatically returns to normal operation when the parent scheduler is available again.
The no form of this command removes a child association with a parent scheduler. If a parent association does not currently exist, the command has no effect and no error message is returned. When a parent association has been removed, the former child policer attempts to operate based on its configured rate parameter.
Removing the parent association on the policer within the policy takes effect immediately on all policers using the SAP QoS policy.
Default
no scheduler-parent
Parameters
- scheduler-name
-
Scheduler names are configured in the config>qos>scheduler-policy>tier context. There are no checks performed at the time of definition to ensure that the scheduler-name exists within an existing scheduler policy. For the policer to use the defined scheduler-name, the scheduler must exist on each SAP that the policer is created on. If a scheduler-name does not exist on the SAP, the policer operates in an orphaned state. Each parental association must be explicitly defined.
- weight
-
Defines the relative weight of this policer in comparison with other child policers, queues, and schedulers when competing for bandwidth on the parent scheduler-name at the above-CIR priority level defined by the level parameter.
All weight values from all weighted active policers, queues, and schedulers with a common port parent are added together. Then, each individual active weight is divided by the total to determine the percentage of remaining bandwidth provided to the policer, queue, or scheduler after the higher priority level children have been serviced. A weight is considered to be active when the applicable policer, queue, or scheduler has not reached its maximum rate and still has packets to transmit. All child policers, queues, and schedulers with a weight of 0 are considered to have the lowest priority at the configured level and are not serviced until all non-zero weighted policers, queues, and schedulers at that level are operating at the maximum bandwidth or are idle.
- level
-
Defines the level of hierarchy when compared with other policers, queues, and schedulers when competing for bandwidth on the parent scheduler-name.
Children of the parent scheduler with a lower priority will not receive bandwidth until all children with a higher priority have either reached their maximum bandwidth or are idle. Children with the same level are serviced in relation to their relative weights.
- cir-weight
-
Defines the relative weight of this policer in comparison with other child policers, queues, or schedulers competing for bandwidth on the parent scheduler-name at the within-CIR priority level defined by the cir-level parameter.
All cir-weight values from all weighted active policers, queues, and schedulers with a common parent are added together. Then, each individual active weight is divided by the total to determine the percentage of remaining bandwidth provided to the policer, queue, or scheduler after the higher priority level children have been serviced. A weight is considered to be active when the applicable policer, queue, or scheduler has not reached its maximum rate and still has packets to transmit.
The weight is specified as an integer value from 0 to 100, with 100 being the highest weight. When the cir-weight parameter is set to a value of 0, the policer receives bandwidth only after the other children with a non-zero weight at this level.
- cir-level
-
Defines the level of hierarchy when compared with other policers, queues, and schedulers that the policer uses to receive bandwidth for its within-CIR offered load. If the cir-level parameter is set to a value of 0 (the default value), the policer does not receive bandwidth during the schedulers within-CIR pass and the cir-weight parameter is ignored. If the cir-level parameter is 1 or greater, the cir-weight parameter is used.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-1s, 7750 SR-1se, 7750 SR-2s, 7750 SR-2se, 7750 SR-7s, VSR
scheduler-parent
Syntax
scheduler-parent scheduler-name [weight weight] [level level] [cir-weight cir-weight] [cir-level cir-level]
no scheduler-parent
Context
[Tree] (config>qos>sap-ingress>policer scheduler-parent)
Full Context
configure qos sap-ingress policer scheduler-parent
Description
This command defines an optional parent scheduler that governs the available bandwidth given to a policer in addition to the PIR setting of the policer. When multiple schedulers, queues, or policers share a child status with the parent scheduler, the weight or level parameters define how this policer contends with the other children for the bandwidth of the parent. This command and the configuration of a SAP policer scheduler-parent or parent arbiter are mutually exclusive.
Multiple schedulers can exist in different scheduler policies with the same scheduler-name; in this command, the associated scheduler-name pertains to a scheduler that should exist on the SAP as the policy is applied and the policer is created. When the policer is created on the SAP, the existence of the scheduler-name is dependent on a scheduler policy containing the scheduler-name being directly applied or indirectly applied (through a multiservice customer site) to the SAP. The policer accepts packets, but is not bandwidth limited by a virtual scheduler or the scheduler hierarchy applied to the SAP.
The parent scheduler can be made unavailable by the removal of a scheduler policy or scheduler. When an existing parent scheduler is removed or inoperative, the policer enters the orphaned state. The policer automatically returns to normal operation when the parent scheduler is available again.
The no form of this command removes a child association with a parent scheduler. If a parent association does not currently exist, the command has no effect and no error message is returned. When a parent association has been removed, the former child policer attempts to operate based on its configured rate parameter.
Removing the parent association on the policer within the policy takes effect immediately on all policers using the SAP QoS policy.
Default
no scheduler-parent
Parameters
- scheduler-name
-
Scheduler names are configured in the config>qos>scheduler-policy>tier context. There are no checks performed at the time of definition to ensure that the scheduler-name exists within an existing scheduler policy. For the policer to use the defined scheduler-name, the scheduler must exist on each SAP that the policer is created on. If a scheduler-name does not exist on the SAP, the policer operates in an orphaned state. Each parental association must be explicitly defined.
- weight
-
Defines the relative weight of this policer in comparison with other child policers, queues, and schedulers when competing for bandwidth on the parent scheduler-name at the above-CIR priority level defined by the level parameter.
All weight values from all weighted active policers, queues, and schedulers with a common port parent are added together. Then, each individual active weight is divided by the total to determine the percentage of remaining bandwidth provided to the policer, queue, or scheduler after the higher priority level children have been serviced. A weight is considered to be active when the applicable policer, queue, or scheduler has not reached its maximum rate and still has packets to transmit. All child policers, queues, and schedulers with a weight of 0 are considered to have the lowest priority at the configured level and are not serviced until all non-zero weighted policers, queues, and schedulers at that level are operating at the maximum bandwidth or are idle.
- level
-
Defines the level of hierarchy when compared with other policers, queues, and schedulers when competing for bandwidth on the parent scheduler-name.
Children of the parent scheduler with a lower priority will not receive bandwidth until all children with a higher priority have either reached their maximum bandwidth or are idle. Children with the same level are serviced in relation to their relative weights.
- cir-weight
-
Defines the relative weight of this policer in comparison with other child policers, queues, or schedulers competing for bandwidth on the parent scheduler-name at the within-CIR priority level defined by the cir-level parameter.
All cir-weight values from all weighted active policers, queues, and schedulers with a common parent are added together. Then, each individual active weight is divided by the total to determine the percentage of remaining bandwidth provided to the policer, queue, or scheduler after the higher priority level children have been serviced. A weight is considered to be active when the applicable policer, queue, or scheduler has not reached its maximum rate and still has packets to transmit.
The weight is specified as an integer value from 0 to 100, with 100 being the highest weight. When the cir-weight parameter is set to a value of 0, the policer receives bandwidth only after the other children with a non-zero weight at this level.
- cir-level
-
Defines the level of hierarchy when compared with other policers, queues, and schedulers that the policer uses to receive bandwidth for its within-CIR offered load. If the cir-level parameter is set to a value of 0 (the default value), the policer does not receive bandwidth during the schedulers within-CIR pass and the cir-weight parameter is ignored. If the cir-level parameter is 1 or greater, the cir-weight parameter is used.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-1s, 7750 SR-1se, 7750 SR-2s, 7750 SR-2se, 7750 SR-7s
scheduler-policy
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>subscr-mgmt>sla-prof>egress scheduler-policy)
Full Context
configure subscriber-mgmt sla-profile egress scheduler-policy
Description
This command specifies a scheduler policy to associate to the sla profile. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
The no form of this command removes the scheduler-policy-name from the configuration.
Parameters
- scheduler-policy-name
-
Specifies an existing scheduler policy name up to 32 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>subscr-mgmt>sub-profile>ingress scheduler-policy)
[Tree] (config>subscr-mgmt>sub-profile>egress scheduler-policy)
Full Context
configure subscriber-mgmt sub-profile ingress scheduler-policy
configure subscriber-mgmt sub-profile egress scheduler-policy
Description
This command specifies a scheduler policy to associate to the subscriber profile. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
The no form of this command reverts to the default.
Parameters
- scheduler-policy-name
-
Specify an existing scheduler policy name up to 32 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>service>vprn>sub-if>grp-if>sap>ingress scheduler-policy)
[Tree] (config>service>ies>sub-if>grp-if>sap>egress scheduler-policy)
[Tree] (config>service>vprn>sub-if>grp-if>sap>egress scheduler-policy)
[Tree] (config>service>ies>sap>egress scheduler-policy)
[Tree] (config>service>ies>sub-if>grp-if>sap>ingress scheduler-policy)
[Tree] (config>service>ies>sap>ingress scheduler-policy)
Full Context
configure service vprn subscriber-interface group-interface sap ingress scheduler-policy
configure service ies subscriber-interface group-interface sap egress scheduler-policy
configure service vprn subscriber-interface group-interface sap egress scheduler-policy
configure service ies sap egress scheduler-policy
configure service ies subscriber-interface group-interface sap ingress scheduler-policy
configure service ies sap ingress scheduler-policy
Description
This command applies an existing scheduler policy to an ingress or egress scheduler used by ingress SAP queues or egress SAP policers and queues associated with this multi-service customer site. The schedulers defined in the scheduler policy can only be created once the customer site has been appropriately assigned to a chassis port, channel or slot. Scheduler policies are defined in the config>qos>scheduler-policy scheduler-policy-name context.
The no form of this command removes the configured ingress or egress scheduler policy from the multi-service customer site. When the policy is removed, the schedulers created due to the policy are removed also making them unavailable for the SAP policers or queues associated with the customer site. Policers and queues that lose their parent scheduler association are deemed to be orphaned and are no longer subject to a virtual scheduler. The SAPs that have policers or queues reliant on the removed schedulers enter into an operational state depicting the orphaned status of one or more policers or queues. When the no form of this command executed, the customer site ingress or egress node will not contain an applied scheduler policy.
Parameters
- scheduler-policy-name:
-
Specifies the scheduler policy name to apply to an existing scheduler policy that was created in the config>qos>scheduler-policy scheduler-policy-name context to create the hierarchy of ingress or egress virtual schedulers. The scheduler names defined within the policy are created and made available to any ingress queues or egress policers and queues created on associated SAPs.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>port>ethernet>access>egress>vport scheduler-policy)
Full Context
configure port ethernet access egress vport scheduler-policy
Description
This command specifies a scheduler policy to associate to the Vport. Scheduler policies are configured in the configure>qos>scheduler>policy context. Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations. The policy defines the hierarchy and operating parameters for virtual schedulers.
The no form of this command removes the configured egress scheduler policy from the Vport.
The agg-rate rate, port-scheduler-policy and scheduler-policy commands are mutually exclusive. Changing between the use of a scheduler policy and the use of an agg-rate/port-scheduler-policy involves removing the existing command and applying the new command.
The configuration of a scheduler policy under a Vport is mutually exclusive with the configuration of the egress-rate-modify parameter.
The no form of this command reverts to the default.
Parameters
- scheduler-policy-name
-
Specifies the scheduler-policy-name parameter applies an existing scheduler policy that was created in the config>qos>scheduler-policy scheduler-policy-name context to create the hierarchy of egress virtual schedulers.
Platforms
All
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>service>ies>if>sap>ingress scheduler-policy)
[Tree] (config>service>vprn>if>sap>egress scheduler-policy)
[Tree] (config>service>vpls>sap>egress scheduler-policy)
[Tree] (config>service>vpls>sap>ingress scheduler-policy)
[Tree] (config>service>vprn>if>sap>ingress scheduler-policy)
[Tree] (config>service>ies>if>sap>egress scheduler-policy)
Full Context
configure service ies interface sap ingress scheduler-policy
configure service vprn interface sap egress scheduler-policy
configure service vpls sap egress scheduler-policy
configure service vpls sap ingress scheduler-policy
configure service vprn interface sap ingress scheduler-policy
configure service ies interface sap egress scheduler-policy
Description
This command applies an existing scheduler policy to an ingress or egress scheduler used by SAP queues associated with this multi-service customer site. The schedulers defined in the scheduler policy can only be created once the customer site has been appropriately assigned to a chassis port, channel or slot. Scheduler policies are defined in the config>qos>scheduler-policy scheduler-policy-name context.
The no form of this command removes the configured ingress or egress scheduler policy from the multi-service customer site. When the policy is removed, the schedulers created due to the policy are removed also making them unavailable for the ingress SAP queues and egress SAP policers and queues associated with the customer site. Policers and queues that lose their parent scheduler association are deemed to be orphaned and are no longer subject to a virtual scheduler. The SAPs that have policers or queues reliant on the removed schedulers enter into an operational state depicting the orphaned status of one or more policers or queues. When the no scheduler-policy command is executed, the customer site’s ingress or egress node will not contain an applied scheduler policy.
Parameters
- scheduler-policy-name
-
Specifies that the scheduler-policy-name is applied to an existing scheduler policy that was created in the config>qos>scheduler-policy scheduler-policy-name context to create the hierarchy of ingress or egress virtual schedulers. The scheduler names defined within the policy are created and made available to any ingress or egress queues created on associated SAPs.
Platforms
All
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>service>ies>sub-if>grp-if>wlan-gw>egress scheduler-policy)
Full Context
configure service ies subscriber-interface group-interface wlan-gw egress scheduler-policy
Description
This command configures the identifier of the egress scheduler policy associated with each wlan-gw tunnel of this interface.
The no form of this command removes the scheduler policy name from the configuration.
Parameters
- scheduler-policy-name
-
Specifies the identifier of the egress scheduler policy associated with each wlan-gw tunnel of this interface.
Platforms
7750 SR, 7750 SR-e, 7750 SR-s, VSR
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>port>ethernet>egress>queue-group scheduler-policy)
[Tree] (config>port>ethernet>ingress>queue-group scheduler-policy)
[Tree] (config>port>ethernet>network>egress>queue-group scheduler-policy)
Full Context
configure port ethernet egress queue-group scheduler-policy
configure port ethernet ingress queue-group scheduler-policy
configure port ethernet network egress queue-group scheduler-policy
Description
This command configures a scheduler policy for the egress queue group.
Parameters
- scheduler-policy-name
-
Specifies the scheduler policy name, up to 32 characters.
Platforms
All
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>service>cpipe>sap>ingress scheduler-policy)
[Tree] (config>service>epipe>sap>ingress scheduler-policy)
[Tree] (config>service>fpipe>sap>egress scheduler-policy)
[Tree] (config>service>apipe>sap>ingress scheduler-policy)
[Tree] (config>service>cpipe>sap>egress scheduler-policy)
[Tree] (config>service>fpipe>sap>ingress scheduler-policy)
[Tree] (config>service>apipe>sap>egress scheduler-policy)
[Tree] (config>service>epipe>sap>egress scheduler-policy)
[Tree] (config>service>ipipe>sap>egress scheduler-policy)
[Tree] (config>service>ipipe>sap>ingress scheduler-policy)
Full Context
configure service cpipe sap ingress scheduler-policy
configure service epipe sap ingress scheduler-policy
configure service fpipe sap egress scheduler-policy
configure service apipe sap ingress scheduler-policy
configure service cpipe sap egress scheduler-policy
configure service fpipe sap ingress scheduler-policy
configure service apipe sap egress scheduler-policy
configure service epipe sap egress scheduler-policy
configure service ipipe sap egress scheduler-policy
configure service ipipe sap ingress scheduler-policy
Description
This command applies an existing scheduler policy to an ingress or egress scheduler used by SAP queues associated with this multi-service customer site. The schedulers defined in the scheduler policy can only be created when the customer site has been appropriately assigned to a chassis port, channel or slot. Scheduler policies are defined in the config>qos>scheduler-policy scheduler-policy-name context.
The no form of this command removes the configured ingress or egress scheduler policy from the multi-service customer site. When the policy is removed, the schedulers created due to the policy are removed also making them unavailable for the ingress SAP queues associated with the customer site. Policers or queues that lose their parent scheduler association are deemed to be orphaned and are no longer subject to a virtual scheduler. The SAPs that have policers or queues reliant on the removed schedulers enter into an operational state depicting the orphaned status of one or more policers or queues. When the no scheduler-policy command is executed, the customer site ingress or egress node will not contain an applied scheduler policy.
Parameters
- scheduler-policy-name
-
The scheduler-policy-name parameter applies an existing scheduler policy that was created in the config>qos>scheduler-policy scheduler-policy-name context to create the hierarchy of ingress or egress virtual schedulers. The scheduler names defined within the policy are created and made available to any ingress or egress queues and to egress policers managed by HQoS created on associated SAPs.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
- configure service fpipe sap ingress scheduler-policy
- configure service fpipe sap egress scheduler-policy
- configure service cpipe sap ingress scheduler-policy
- configure service cpipe sap egress scheduler-policy
All
- configure service epipe sap egress scheduler-policy
- configure service ipipe sap ingress scheduler-policy
- configure service ipipe sap egress scheduler-policy
- configure service epipe sap ingress scheduler-policy
7450 ESS, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e, 7950 XRS
- configure service apipe sap ingress scheduler-policy
- configure service apipe sap egress scheduler-policy
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>service>vpls>sap>egress>encap-defined-qos>encap-group scheduler-policy)
Full Context
configure service vpls sap egress encap-defined-qos encap-group scheduler-policy
Description
This command configures the scheduler policy.
Platforms
All
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name [create]
no scheduler-policy scheduler-policy-name
Context
[Tree] (config>qos scheduler-policy)
Full Context
configure qos scheduler-policy
Description
Each scheduler policy is divided up into groups of schedulers based on the tier each scheduler is created under. A tier is used to give structure to the schedulers within a policy and define rules for parent scheduler associations.
The scheduler-policy command creates a scheduler policy or allows editing of an existing policy. The policy defines the hierarchy and operating parameters for virtual schedulers. Creating a policy does not create the schedulers; it only provides a template for the schedulers to be created when the policy is associated with a SAP or multiservice site.
Each scheduler policy must have a unique name within the context of the system. Modifications made to an existing policy are executed on all schedulers that use the policy. This can cause queues or schedulers to become orphaned (invalid parent association) and adversely affect the ability of the system to enforce SLAs.
If a scheduler-policy-name does not exist, it is assumed that an attempt is being made to create a new policy. The success of the command execution is dependent on the following:
-
The maximum number of scheduler policies has not been configured.
-
The provided scheduler-policy-name is valid.
-
The create keyword is entered with the command if the system is configured to require it (enabled in the environment create command).
When the maximum number of scheduler policies has been exceeded, a configuration error occurs, the command will not execute, and the CLI context will not change.
If the provided scheduler-policy-name is invalid according to the criteria below, a name syntax error occurs, the command will not execute, and the CLI context will not change.
Parameters
- scheduler-policy-name
-
The name of the scheduler policy.
Platforms
All
scheduler-policy
Syntax
scheduler-policy scheduler-policy-name
no scheduler-policy
Context
[Tree] (config>service>cust>multi-service-site>ingress scheduler-policy)
[Tree] (config>service>cust>multi-service-site>egress scheduler-policy)
Full Context
configure service customer multi-service-site ingress scheduler-policy
configure service customer multi-service-site egress scheduler-policy
Description
This command applies an existing scheduler policy to an ingress or egress scheduler used by SAP queues or, at egress only, policers associated with this multi-service customer site. The schedulers defined in the scheduler policy can only be created once the customer site has been appropriately assigned to a chassis port, channel or slot. Scheduler policies are defined in the config>qos>scheduler-policy scheduler-policy-name context.
The no form of this command removes the configured ingress or egress scheduler policy from the multi-service customer site. When the policy is removed, the schedulers created due to the policy are removed also making them unavailable for the SAP policers and queues associated with the customer site. Policers and queues that lose their parent scheduler association are deemed to be orphaned and are no longer subject to a virtual scheduler.
The SAPs that have ingress queues reliant on the removed schedulers enter into an operational state depicting the orphaned status of one or more policers and queues. When the no scheduler-policy command is executed, the customer site ingress or egress node will not contain an applied scheduler policy.
Parameters
- scheduler-policy-name
-
Applies an existing scheduler policy that was created in the config>qos>scheduler-policy scheduler-policy-name context to create the hierarchy of ingress or egress virtual schedulers. The scheduler names defined within the policy are created and made available to any ingress or egress queues and egress policers managed by HQoS created on associated SAPs.
Platforms
All
scheduler-policy
Syntax
scheduler-policy src-name dst-name [overwrite]
Context
[Tree] (config>qos>copy scheduler-policy)
Full Context
configure qos copy scheduler-policy
Description
This command copies existing QoS policy entries for a QoS policy to another QoS policy.
The copy command is a configuration-level maintenance tool used to create new policies using existing policies. It also allows bulk modifications to an existing policy with the use of the overwrite keyword.
If overwrite is not specified, an error will occur if the destination policy exists.
Parameters
- src-name dst-name
-
Indicates that the source policy and the destination policy are scheduler policy. Specify the source policy that the copy command will attempt to copy from and specify the destination policy to which the command will copy a duplicate of the policy.
- overwrite
-
Forces the destination policy name to be copied as specified. When forced, everything in the existing destination policy will be completely overwritten with the contents of the source policy.
Platforms
All
scheduling-class
scheduling-class
Syntax
scheduling-class class rate rate
scheduling-class class weight weight-in-group
no scheduling-class class
Context
[Tree] (config>port>ethernet>egress>hs-sched-ovr scheduling-class)
Full Context
configure port ethernet egress hs-scheduler-overrides scheduling-class
Description
This command overrides the scheduling class configuration in the HS scheduler policy applied to the port egress. The scheduling class rate or weight within the WRR group can be overridden.
The no form of this command removes the scheduling class override parameters from the port egress configuration.
Parameters
- class
-
Specifies the scheduling class.
- rate
-
Specifies the explicit maximum frame based bandwidth limit, in megabits per second, for this HS scheduler policy scheduling class. The rate keyword must be followed by either the keyword max or a rate specified in megabits per second.
- weight-in-group
-
Specifies the weight the HS scheduler policy should apply to this scheduling class within the group in which it belongs. The weight-in-group parameter must follow the weight keyword and is used to specify the relative weight of class to the other scheduling classes within the group. Setting the weight will fail if the scheduling class is not currently configured in a group.
Platforms
7750 SR-7/12/12e
scheduling-class
Syntax
scheduling-class class-id
Context
[Tree] (config>service>apipe>sap>frame-relay scheduling-class)
[Tree] (config>service>ipipe>sap>frame-relay scheduling-class)
[Tree] (config>service>fpipe>sap>frame-relay scheduling-class)
[Tree] (config>service>epipe>sap>frame-relay scheduling-class)
Full Context
configure service apipe sap frame-relay scheduling-class
configure service ipipe sap frame-relay scheduling-class
configure service fpipe sap frame-relay scheduling-class
configure service epipe sap frame-relay scheduling-class
Description
This command specifies the scheduling class to use for this SAP.
Parameters
- class-id
-
Specifies the scheduling class to use for this SAP.
Platforms
7450 ESS, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e, 7950 XRS
- configure service apipe sap frame-relay scheduling-class
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
- configure service ipipe sap frame-relay scheduling-class
- configure service epipe sap frame-relay scheduling-class
- configure service fpipe sap frame-relay scheduling-class
scheduling-class
Syntax
scheduling-class class-id
no scheduling-class
Context
[Tree] (config>service>vpls>sap>frame-relay scheduling-class)
Full Context
configure service vpls sap frame-relay scheduling-class
Description
This command specifies the scheduling class to use for this SAP. This object is only applicable for a SAP whose bundle type is set to MLFR.
Parameters
- class-id
-
Specifies the scheduling class
Platforms
All
scheduling-class
Syntax
scheduling-class class-id
no scheduling-class
Context
[Tree] (config>service>vprn>if>sap>frame-relay scheduling-class)
[Tree] (config>service>ies>if>sap>frame-relay scheduling-class)
Full Context
configure service vprn interface sap frame-relay scheduling-class
configure service ies interface sap frame-relay scheduling-class
Description
This command assigns a Frame Relay scheduling class for a Frame Relay SAP. The scheduling class dictates which queue the frame or frame fragments are stored in FRF.12 end-to-end fragmentation, FRF.12 UNI/NNI link fragmentation and MLFR applications.
Default
scheduling-class 3
Parameters
- class-id
-
Specifies the Frame Relay scheduling class number.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
scheduling-class
Syntax
scheduling-class class-id
no scheduling-class
Context
[Tree] (config>service>vprn>if>sap scheduling-class)
Full Context
configure service vprn interface sap scheduling-class
Description
This command specifies the scheduling class to use for this SAP.
Parameters
- class-id
-
Specifies the scheduling class to use for this SAP.
Platforms
All
scheduling-class
Syntax
scheduling-class class-id group group-id [weight weight-in-group]
scheduling-class class-id rate rate
no scheduling-class class-id
Context
[Tree] (config>qos>hs-scheduler-policy scheduling-class)
Full Context
configure qos hs-scheduler-policy scheduling-class
Description
This command configures the behavior of a specific scheduling class on all HSQ schedulers associated with the policy. The scheduler-class command performs one of two operations: it configures a maximum rate for the scheduling class or places the scheduling class into the weighted scheduling group. The two operations are mutually exclusive.
By default, none of the scheduling classes are members of the weighted scheduling group and each class is set to a rate limit of max (no rate limit applied).
Specifying Scheduling Class Rate (or Removing the Scheduling Class from Group) — If the scheduling-class command is executed with the rate keyword specified, either max or a specified rate value must follow. If a class-id was previously mapped into the weighted scheduling group, the class is removed from the group. However, if removing the class from the group causes the group to no longer have contiguous class members, the command fails with no effect on the specified class. A "non-contiguous grouping error” is returned. The lowest or highest members within a weighted group must be removed prior to removing the middle members. For example, if scheduling classes 3, 4, and 5 were members of weighted group 1, class 4 cannot be removed first.
This command using the rate keyword also fails when an override for the group weight is in place on the scheduling class within a scheduler associated with the policy. The override expects the class to be associated with a weighted scheduling group and the policy rate definition is attempting to remove the class from the group. An "override mismatch” error is generated, specifying the scheduling object where the override exists.
After a rate has been successfully defined for a scheduling class, the specified rate is automatically updated on all HSQ scheduler instances associated with the scheduling policy. The exception is where the scheduler instance has a local override for the rate on the scheduling class.
Specifying Scheduling Class Weighted Group Membership — If the scheduling-class command is executed with the group keyword specified, the group ID value of 1 must follow. The corresponding optional weight keyword is used to specify the weight of the scheduling class within the group. If weight is not specified, the default weight of 1 is used. If the specified scheduling class is not contiguous with the other scheduling classes in the group, the command fails with no change to the current state of the scheduling class and a "non-contiguous grouping” error is returned, specifying the weighted scheduling group and the current group members.
The scheduling-class command fails using the group keyword when a rate override for the scheduling class exists on an HSQ scheduler instance associated with the policy. The rate override for the scheduling class indicates the class is directly attached to a strict priority level, conflicting with the policy group keyword trying to place the class in the specified group. The command fails without affecting the scheduling class definition on the policy and returns an error specifying the scheduling object where the override exists.
Other Override Constraints — The scheduling overrides cannot change or remove a scheduling class from a policy-defined weighted group membership.
The no form of the command returns the scheduling class represented by class-id to the default behavior. The default behavior for a scheduling class is to not be a member of the weighted scheduling class group and have a rate set to max. The no scheduling-class command fails if the scheduling class is currently a member of the weighted scheduling class group and a weight override is in effect on a scheduling object for the class, in which case an error is returned.
Parameters
- class-id
-
Specifies the scheduling class for HS scheduler policy. The class-id value is a required parameter that specifies which scheduling class the scheduling-class command is acting upon.
- group-id
-
Specifies the group this HS scheduler policy scheduling class belongs to. The group and the rate keywords are mutually exclusive when executing this command. A group ID value of 1 must follow the group keyword. The group keyword removes the class ID from its inherent strict scheduling level and places it into the specified group ID. The associated weight parameter is optional and is used to specify the weight of a class ID within the weighted scheduling class group. Specifying the group parameter while an override for the scheduling class exists for rate causes the scheduling-class command to fail.
- weight-in-group
-
Specifies the weight the HS scheduler policy should apply to this scheduling class within the group in which it belongs. This keyword is optional and must follow the group parameter when specified. The weight-in-group parameter must follow the weight keyword and is used to specify the relative weight of the class-id to the other scheduling classes within the group. If the group is specified without the weight parameter, a default weight of 1 is used.
- rate
-
Specifies the explicit maximum frame-based bandwidth limit, in megabits per second, for this HS scheduler policy scheduling class. The rate and group keywords are mutually exclusive. Either the rate or group keyword must be specified when executing this command. When specified, the rate keyword must be followed by either the keyword max or a rate specified in megabits per second. The specified rate can be overridden at the port Ethernet egress using the scheduler override functions. A newly-created HS scheduler policy defaults each scheduling class to have its rate set to max and the weighted scheduling class group has no members.
Platforms
7750 SR-7/12/12e
schema-path
schema-path
Syntax
schema-path url-string
no schema-path
Context
[Tree] (config>system>management-interface schema-path)
Full Context
configure system management-interface schema-path
Description
This command specifies the schema path where the SR OS YANG modules can be placed by the user before using a <get-schema> request. Nokia recommends that the URL string not exceed 135 characters for the <get-schema> request to work correctly with all schema files.
If this command is not configured, the software upgrade process manages the YANG schema files to ensure the schema files are synchronized with the software image on both the primary and standby CPM.
The no form of this command reverts to the default value.
Default
no schema-path
Parameters
- url-string
-
Specifies the schema path URL up to 180 characters. However, Nokia recommends that the string shall not exceed 135 characters to ensure that the <get-schema> request works properly with all schema files.
Platforms
All
scope
scope
Syntax
scope {exclusive | template}
no scope
Context
[Tree] (config>service>mrp>mrp-policy scope)
Full Context
configure service mrp mrp-policy scope
Description
This command configures the filter policy scope as exclusive or template. If the scope of the policy is template and is applied to one or more services, the scope cannot be changed.
The no form of this command sets the scope of the policy to the default of template.
Default
scope template
Parameters
- exclusive
-
When the scope of a policy is defined as exclusive, the policy can only be applied to a single entity (SAP or SDP). Attempting to assign the policy to a second entity will result in an error message. If the policy is removed from the entity, it will become available for assignment to another entity.
- template
-
When the scope of a policy is defined as template, the policy can be applied to multiple SAPs or network ports.
Platforms
All
scope
Syntax
scope {exclusive | template}
no scope
Context
[Tree] (config>qos>sap-ingress scope)
Full Context
configure qos sap-ingress scope
Description
This command configures the Service Ingress QoS policy scope as exclusive or template.
The policy’s scope cannot be changed if the policy is applied to a service.
The no form of this command sets the scope of the policy to the default of template.
Default
scope template
Parameters
- exclusive
-
When the scope of a policy is defined as exclusive, the policy can only be applied to one SAP. If a policy with an exclusive scope is assigned to a second SAP, an error message is generated. If the policy is removed from the exclusive SAP, it will become available for assignment to another exclusive SAP.
The system default policies cannot be put into the exclusive scope. An error will be generated if scope exclusive is executed in any policies with a policy-id equal to 1.
- template
-
When the scope of a policy is defined as template, the policy can be applied to multiple SAPs on the router.
Default QoS policies are configured with template scopes. An error is generated when the template scope parameter to exclusive scope on default policies is modified.
Platforms
All
scope
Syntax
scope {exclusive | template}
no scope
Context
[Tree] (config>qos>sap-egress scope)
Full Context
configure qos sap-egress scope
Description
Enter the scope of this policy. The scope of the policy cannot be changed if the policy is applied to one or more services.
The no form of this command sets the scope of the policy to the default of template.
Default
scope template
Parameters
- exclusive
-
When the scope of a policy is defined as exclusive, the policy can only be applied to a single SAP. Attempting to assign the policy to a second SAP will result in an error message. If the policy is removed from the exclusive SAP, it will become available for assignment to another exclusive SAP.
The system default policies cannot be put into the exclusive scope. An error will be generated if scope exclusive is executed in any policies with a policy-id equal to 1.
- template
-
When the scope of a policy is defined as template, the policy can be applied to multiple SAPs on the router.
Platforms
All
scope
Syntax
scope {exclusive | template}
no scope
Context
[Tree] (config>qos>network scope)
Full Context
configure qos network scope
Description
This command configures the network policy scope as exclusive or template. The policy’s scope cannot be changed if the policy is applied to an interface.
The no form of this command sets the scope of the policy to the default of template.
Default
scope template
Parameters
- exclusive
-
When the scope of a policy is defined as exclusive, the policy can only be applied to one interface. If a policy with an exclusive scope is assigned to a second interface, an error message is generated. If the policy is removed from the exclusive interface, it will become available for assignment to another exclusive interface.
The system default policies cannot be put into the exclusive scope. An error will be generated if the scope exclusive command is executed in any policies with a policy-id equal to 1.
- template
-
When the scope of a policy is defined as template, the policy can be applied to multiple interfaces on the router.
Default QoS policies are configured with template scopes. An error is generated if the template scope parameter is modified to exclusive scope on default policies.
Platforms
All
scope
Syntax
scope {exclusive | template | embedded | system}
scope {exclusive | template}
no scope
Context
[Tree] (config>filter>ipv6-filter scope)
[Tree] (config>filter>mac-filter scope)
[Tree] (config>filter>ip-filter scope)
[Tree] (config>filter>ip-exception scope)
Full Context
configure filter ipv6-filter scope
configure filter mac-filter scope
configure filter ip-filter scope
configure filter ip-exception scope
Description
This command configures the filter policy scope as exclusive, template, embedded or system.
The scope of the policy cannot be changed when:
-
the scope is template and the policy is applied to one or more services or network interfaces
-
the scope is embedded and the policy is embedded by another policy
Changing the scope to/from system is only allowed when a policy is not active and the policy has no entries configured.
The no form of the command sets the scope of the policy to the default of template.
Default
scope template
Parameters
- exclusive
-
Specifies that the policy can only be applied to a single entity. Attempting to assign the policy to a second entity will result in an error message.
- template
-
Specifies that the policy can be applied to multiple entities.
- embedded
-
Specifies that the policy cannot be applied directly. The policy defines embedded filter rules, which are embedded by other exclusive/template/system filter policies. The embedded scope is supported for IPv4 and IPv6 filter policies only.
- system
-
Specifies that the policy defines system-wide filter rules. To apply system policy rules, activate system filter and chain exclusive/template ACL filter policy to the system filter. The system scope is supported for IPv4 and IPv6 filter policies only.
Platforms
All
- configure filter mac-filter scope
- configure filter ip-filter scope
- configure filter ipv6-filter scope
VSR
- configure filter ip-exception scope
scp
scp
Syntax
scp local-file-url destination-file-url [router router-instance] [force]
scp local-file-url destination-file-url [force] service service-name
Context
[Tree] (file scp)
Full Context
file scp
Description
This command copies a local file to a remote host file system. It uses
ssh
for data transfer, and uses the same authentication
and provides the same security as ssh
. The following prompt
appears:
"Are you sure (y/n)?” The destination must specify a user and a host.
Parameters
- local-file-url
-
Specifies the local source file or directory.
- destination-file-url
-
Specifies the destination file.
- user
-
Specifies the SSH user.
- hostname
-
Specifies the remote host IP address of DNS name.
- file-path
-
Specifies the destination path.
- router-instance
-
Specifies the router name or service ID used to specify the router instance.
- force
-
Forces an immediate copy of the specified file. The command file scp local-file-url destination-file-url [router router-instance] force executes the command without displaying a user prompt message.
- service-name
-
Specifies the service name used to identify the router instance. The service name can be a maximum of 64 characters long.
Platforms
All
scramble
scramble
Syntax
[no] scramble
Context
[Tree] (config>port>tdm>e3 scramble)
[Tree] (config>port>tdm>e1>channel-group scramble)
[Tree] (config>port>tdm>ds1>channel-group scramble)
[Tree] (config>port>tdm>ds3 scramble)
Full Context
configure port tdm e3 scramble
configure port tdm e1 channel-group scramble
configure port tdm ds1 channel-group scramble
configure port tdm ds3 scramble
Description
This command enables payload scrambling on channel groups.
Scrambling randomizes the pattern of 1s and 0s carried in a SONET frame. Rearranging or scrambling the pattern prevents continuous strings of all 1s or all 0s and meets the needs of physical layer protocols that rely on sufficient transitions between 1s and 0s to maintain clocking.
For ATM, this command enables or disables ATM cell-level payload scrambling/descrambling using x43+1 polynomial as defined in ITU-T I.432.1. Scrambling is enabled by default for the ATM path/channel. Note that this scrambling is done in addition to SONET/SDH frame scrambling/descrambling, which is always enabled in the framer.
The no form of this command disables scrambling.
Default
no scramble
Platforms
7450 ESS, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e
scramble
Syntax
[no] scramble
Context
[Tree] (config>port>sonet-sdh>path scramble)
Full Context
configure port sonet-sdh path scramble
Description
This command enables SONET/SDH payload scrambling. Scrambling randomizes the pattern of 1s and 0s carried in a SONET frame. Rearranging or scrambling the pattern prevents continuous strings of all 1s or all 0s and meets the needs of physical layer protocols that rely on sufficient transitions between 1s and 0s to maintain clocking.
For ATM, this command enables or disables ATM cell-level payload scrambling/descrambling using x43+1 polynomial as defined in ITU-T I.432.1. Scrambling is enabled by default for the ATM path/channel. Note that this scrambling is done in addition to SONET/SDH frame scrambling/descrambling, which is always enabled in the framer.
The no form of this command disables scrambling.
Default
no scramble
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
script
script
Syntax
script script
Context
[Tree] (debug>dynsvc>scripts script)
Full Context
debug dynamic-services scripts script
Description
Commands in this context configure dynamic services script debugging for a specific script.
Parameters
- script
-
Specifies the script name.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script
Syntax
script script-name [owner script-owner]
no script
Context
[Tree] (config>system>script-control>script-policy script)
[Tree] (config>system>script-control script)
Full Context
configure system script-control script-policy script
configure system script-control script
Description
This command is used to configure a script to be run.
The no form of the command removes the script.
Default
no script
Parameters
- script-name
-
Specifies the name of the script. Can be up to 32 characters.
- script-owner
-
Specifies the name of the script owner. Can be up to 32 characters.
The owner is an arbitrary name and not necessarily a user name. Commands in the scripts are not authorized against the owner. The configure system security cli-script authorization x cli-user command determines the user context against which commands in the scripts are authorized.
Platforms
All
script-all-info
script-all-info
Syntax
script-all-info
Context
[Tree] (debug>python>py-script script-all-info)
Full Context
debug python python-script script-all-info
Description
This command enables the script-compile-error, script-export-variables, script-output, script-output-on-error, and script-runtime-error functionalities.
Platforms
All
script-all-info
Syntax
script-all-info
Context
[Tree] (debug>subscr-mgmt>sub-ident-plcy script-all-info)
Full Context
debug subscriber-mgmt sub-ident-policy script-all-info
Description
This command enables the script-compile-error, script-export-variables, script-output, script-output-on-error, and script-runtime-error functionalities.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-compile-error
script-compile-error
Syntax
[no] script-compile-error
Context
[Tree] (debug>python>py-script script-compile-error)
Full Context
debug python python-script script-compile-error
Description
This command sends the traceback of the compile error to the logger. The traceback contains detailed information about where and why the compilation fails. The compilation takes place when the CLI user changes the admin state of the Python script from shutdown to no shutdown.
Platforms
All
script-compile-error
Syntax
[no] script-compile-error
Context
[Tree] (debug>subscr-mgmt>sub-ident-plcy script-compile-error)
Full Context
debug subscriber-mgmt sub-ident-policy script-compile-error
Description
This command send the traceback of the compile error to the logger. The traceback contains detailed information about where and why the compilation fails. The compilation takes place when the CLI user changes the admin state of the Python URL from shutdown to no-shutdown.
The no form of this command disables debugging.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-control
script-control
Syntax
script-control
Context
[Tree] (config>system script-control)
Full Context
configure system script-control
Description
Commands in this context configure command script parameters.
Platforms
All
script-export-variables
script-export-variables
Syntax
[no] script-export-variables
Context
[Tree] (debug>python>py-script script-export-variables)
Full Context
debug python python-script script-export-variables
Description
This command sends the output variables of the Python script to the logger when the script ran successfully.
Platforms
All
script-export-variables
Syntax
[no] script-export-variables
Context
[Tree] (debug>subscr-mgmt>sub-ident-plcy script-export-variables)
Full Context
debug subscriber-mgmt sub-ident-policy script-export-variables
Description
This command sends the result (the three output variables) of the Python script to the logger when the script ran successfully.
The no form of this command disables debugging.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-output
script-output
Syntax
[no] script-output
Context
[Tree] (debug>python>py-script script-output)
Full Context
debug python python-script script-output
Description
This command sends the output (such as from print statements) of the Python script to the logger.
Platforms
All
script-output
Syntax
[no] script-output
Context
[Tree] (debug>subscr-mgmt>sub-ident-plcy script-output)
Full Context
debug subscriber-mgmt sub-ident-policy script-output
Description
This command sends the output (such as from 'print' statements) of the Python script to the logger.
The no form of this command disables debugging.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-output-on-error
script-output-on-error
Syntax
[no] script-output-on-error
Context
[Tree] (debug>python>py-script script-output-on-error)
Full Context
debug python python-script script-output-on-error
Description
This command sends the output (such as traceback data) of the Python script to the logger, only when the script fails.
Platforms
All
script-output-on-error
Syntax
[no] script-output-on-error
Context
[Tree] (debug>subscr-mgmt>sub-ident-plcy script-output-on-error)
Full Context
debug subscriber-mgmt sub-ident-policy script-output-on-error
Description
This command sends the output (such as from print statements) of the Python script to the logger, but only when the script fails.
The no form of this command disables debugging.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-parameters-1
script-parameters-1
Syntax
script-parameters-1 param-string1
no script-parameters-1
Context
[Tree] (config>service>dynsvc>ladb>user>idx script-parameters-1)
Full Context
configure service dynamic-services local-auth-db user-name index script-parameters-1
Description
This command specifies the first part of parameters as input to the dynamic data service Python script. The concatenation of all four script-parameters strings are passed to the Python script and must be formatted as function-key <dictionary>. The function-key specifies which Python functions is called, and <dictionary> contains the actual parameters in a Python dictionary structure format. The no form of this command removes script-parameters-1 from the configuration.
Parameters
- param-string1
-
Specifies a string representing parameters that are used as input for the dynamic service Python script, up to 250 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-parameters-2
script-parameters-2
Syntax
script-parameters-2 param-string2
no script-parameters-2
Context
[Tree] (config>service>dynsvc>ladb>user>idx script-parameters-2)
Full Context
configure service dynamic-services local-auth-db user-name index script-parameters-2
Description
This command specifies the second part of parameters as input to the dynamic data service Python script. The concatenation of all four script-parameters strings are passed to the Python script and must be formatted as function-key <dictionary>. The function-key specifies which Python functions is called, and <dictionary> contains the actual parameters in a Python dictionary structure format. The no form of this command removes the script-parameters-2 from the configuration.
Parameters
- param-string2
-
Specifies a string representing parameters that are used as input for the dynamic service Python script, up to 250 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-parameters-3
script-parameters-3
Syntax
script-parameters-3 param-string3
no script-parameters-3
Context
[Tree] (config>service>dynsvc>ladb>user>idx script-parameters-3)
Full Context
configure service dynamic-services local-auth-db user-name index script-parameters-3
Description
This command specifies the third part of parameters as input to the dynamic data service Python script. The concatenation of all four script-parameters strings are passed to the Python script and must be formatted as function-key <dictionary>. The function-key specifies which Python functions is called, and <dictionary> contains the actual parameters in a Python dictionary structure format. The no form of this command removes the script-parameters-3 from the configuration.
Parameters
- param-string3
-
Specifies string representing parameters that are used as input for the dynamic service Python script, up to 250 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-parameters-4
script-parameters-4
Syntax
script-parameters-4 param-string4
no script-parameters-4
Context
[Tree] (config>service>dynsvc>ladb>user>idx script-parameters-4)
Full Context
configure service dynamic-services local-auth-db user-name index script-parameters-4
Description
This command specifies the fourth part of parameters as input to the dynamic data service Python script. The concatenation of all four script-parameters strings are passed to the Python script and must be formatted as function-key <dictionary>. The function-key specifies which Python functions is called, and <dictionary> contains the actual parameters in a Python dictionary structure format. The no form of this command removes the script-parameters-4 from the configuration.
Parameters
- param-string4
-
Specifies a string representing parameters that are used as input for the dynamic service Python script, up to 250 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-policy
script-policy
Syntax
script-policy name
no script-policy
Context
[Tree] (config>service>dynsvc>policy script-policy)
Full Context
configure service dynamic-services dynamic-services-policy script-policy
Description
This command specifies the radius script policy to be used to setup the dynamic data services. The script-policy configuration cannot be changed when there are active dynamic data services referencing the policy.
The no form of this command removes the script-policy from the configuration. This is only allowed when there are no active dynamic data services referencing this policy.
Parameters
- name
-
Specifies the RADIUS script policy name.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-policy
Syntax
script-policy policy-name [owner policy-owner]
no script-policy
Context
[Tree] (config>system>cron>schedule script-policy)
Full Context
configure system cron schedule script-policy
Description
This command is used to configure the CLI script policy.
Parameters
- policy-name
-
Specifies the name of the policy. Can be up to 32 characters.
- policy-owner
-
Specifies the name of the policy owner. Can be up to 32 characters.
The owner is an arbitrary name and not necessarily a user name. Commands in the scripts are not authorized against the owner. The configure system security cli-script authorization x cli-user command determines the user context against which commands in the scripts are authorized.
Platforms
All
script-policy
Syntax
[no] script-policy policy-name [owner policy-owner]
Context
[Tree] (config>system>script-control script-policy)
Full Context
configure system script-control script-policy
Description
This command is used to configure the CLI script policy.
Parameters
- policy-name
-
Specifies the name of the policy, up to 32 characters.
- policy-owner
-
Specifies the name of the policy owner, up to 32 characters.
The owner is an arbitrary name and not necessarily a user name. Commands in the scripts are not authorized against the owner. The configure system security cli-script authorization x cli-user command determines the user context against which commands in the scripts are authorized.
Platforms
All
script-policy
Syntax
script-policy policy-name [owner policy-owner]
no script-policy
Context
[Tree] (config>log>event-handling>handler>action-list>entry script-policy)
Full Context
configure log event-handling handler action-list entry script-policy
Description
This command configures the script policy parameters to use for this EHS handler action-list entry. The associated script is launched when the handler is triggered.
Default
no script-policy
Parameters
- policy-name
-
Specifies the script policy name. Can be up to 32 characters maximum.
- owner policy-owner
-
Specifies the script policy owner. Can be up to 32 characters maximum.
Platforms
All
script-runtime-error
script-runtime-error
Syntax
[no] script-runtime-error
Context
[Tree] (debug>python>py-script script-runtime-error)
Full Context
debug python python-script script-runtime-error
Description
This command generates log information when detecting a script runtime error.
Platforms
All
script-runtime-error
Syntax
[no] script-runtime-error
Context
[Tree] (debug>subscr-mgmt>sub-ident-plcy script-runtime-error)
Full Context
debug subscriber-mgmt sub-ident-policy script-runtime-error
Description
This command sends the traceback of the Python script failure to the logger.
The no form of this command disables debugging.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-url
script-url
Syntax
script-url primary-script-url
no script-url
Context
[Tree] (config>aaa>radius-scr-plcy>primary script-url)
Full Context
configure aaa radius-script-policy primary script-url
Description
This command configures the URL of the primary script.
The no form of this command removes the URL from the configuration.
Parameters
- primary-script-url
-
Specifies the URL of the secondary script to change RADIUS attributes of the RADIUS message.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-url
Syntax
script-url secondary-script-url
no script-url
Context
[Tree] (config>aaa>radius-scr-plcy>secondary script-url)
Full Context
configure aaa radius-script-policy secondary script-url
Description
Specifies the URL of the secondary script to change RADIUS attributes of the RADIUS message.
The no form of this command removes the URL from the configuration.
Parameters
- secondary-script-url
-
Specifies the URL of the secondary script to change RADIUS attributes of the RADIUS message.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-url
Syntax
script-url dhcp-script-url
no script-url
Context
[Tree] (config>subscr-mgmt>sub-ident-pol>primary script-url)
[Tree] (config>subscr-mgmt>sub-ident-pol>tertiary script-url)
[Tree] (config>subscr-mgmt>sub-ident-pol>secondary script-url)
Full Context
configure subscriber-mgmt sub-ident-policy primary script-url
configure subscriber-mgmt sub-ident-policy tertiary script-url
configure subscriber-mgmt sub-ident-policy secondary script-url
Description
This command specifies the URL of the identification scripts.
The no form of this command reverts to the default.
Parameters
- dhcp-primary-script-url
-
Specifies the URL of the primary identification script up to 180 characters.
- dhcp-secondary-script-url
-
Specifies the URL of the secondary identification script up to 180 characters.
- dhcp-tertiary-script-url
-
Specifies the URL of the tertiary identification script up to 180 characters.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
script-url
Syntax
script-url script-url-name
no script-url
Context
[Tree] (config>app-assure>group>http-notif script-url)
Full Context
configure application-assurance group http-notification script-url
Description
This command configures the URL of the script used by the http notification policy.
The no form of this command removes the script URL from the http-notification policy.
Default
no script-url
Parameters
- script-url-name
-
Specifies the string representing the URL of the script used in the http notification policy, up to 255 characters.
- create
-
Keyword to create the script URL.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
scripts
scripts
Syntax
scripts
Context
[Tree] (debug>dynsvc scripts)
Full Context
debug dynamic-services scripts
Description
Commands in this context configure dynamic services script debugging.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR
scripts
Syntax
scripts
scripts event [cli] [ errors] [executed-cmd] [ state-change] [warnings]
scripts instance instance event [cli] [errors] [executed-cmd] [state-change] [warnings]
Context
[Tree] (debug>vsd scripts)
Full Context
debug vsd scripts
Description
This command enables the debug of the VSD fully dynamic integration scripts.
Platforms
All
scte30
scte30
Syntax
scte30
Context
[Tree] (config>service>vprn>video-interface>adi scte30)
[Tree] (config>service>ies>video-interface>adi scte30)
Full Context
configure service vprn video-interface adi scte30
configure service ies video-interface adi scte30
Description
Commands in this context configure SCTE 30 parameters.
Platforms
7450 ESS, 7750 SR-1, 7750 SR-7/12/12e, 7750 SR-1s, 7750 SR-2s, 7750 SR-7s, 7750 SR-14s
scte35-action
scte35-action
Syntax
scte35-action {forward | drop}
Context
[Tree] (config>service>vprn>video-interface>channel scte35-action)
[Tree] (config>service>ies>video-interface>channel scte35-action)
Full Context
configure service vprn video-interface channel scte35-action
configure service ies video-interface channel scte35-action
Description
This command specifies whether the Society of Cable Telecommunications Engineers 35 (SCTE 35) cue avails in the stream need to be forwarded or not. When specified to forward, SCTE 35 messages will be forwarded downstream. When specified to drop, SCTE 35 messages will not be forwarded downstream. They will be still be processed for local splicing decisions.
Parameters
- forward
-
Forwards SCTE 35 messages downstream.
- drop
-
Drops SCTE 35 messages.
Platforms
7450 ESS, 7750 SR-1, 7750 SR-7/12/12e, 7750 SR-1s, 7750 SR-2s, 7750 SR-7s, 7750 SR-14s
sctp-filter
sctp-filter
Syntax
sctp-filter sctp-filter-name
no sctp-filter
Context
[Tree] (config>app-assure>group>policy>aqp>entry>action sctp-filter)
Full Context
configure application-assurance group policy app-qos-policy entry action sctp-filter
Description
This command assigns an existing SCTP filter as an action on flows matching this AQP entry.
The no form of this command removes this SCTP filter from actions on flows matching this AQP entry.
Default
no sctp-filter
Parameters
- sctp-filter-name
-
Specifies the name of the existing SCTP filter for this application assurance profile. The sctp-filter-name is configured in the config>app-assure>group[:partition]>sctp-filter context.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
sctp-filter
Syntax
sctp-filter sctp-filter-name
Context
[Tree] (config>app-assure>group>statistics>tca sctp-filter)
Full Context
configure application-assurance group statistics threshold-crossing-alert sctp-filter
Description
This command configures TCA generation for an SCTP filter.
Parameters
- sctp-filter-name
-
Specifies the name of the SCTP filter, up to 32 characters
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
sctp-filter
Syntax
sctp-filter sctp-filter-name [create]
no sctp-filter sctp-filter-name
Context
[Tree] (config>app-assure>group sctp-filter)
Full Context
configure application-assurance group sctp-filter
Description
Commands in this context configure Stream Control Transmission Protocol (SCTP) parameters.
The no form of this command removes this filter.
Parameters
- sctp-filter-name
-
Specifies the SCTP filter name, up to 32 characters.
- create
-
Keyword used to create the SCTP filter.
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
sctp-filter-stats
sctp-filter-stats
Syntax
[no] sctp-filter-stats
Context
[Tree] (config>app-assure>group>statistics>aa-admit-deny sctp-filter-stats)
Full Context
configure application-assurance group statistics aa-admit-deny sctp-filter-stats
Description
This command configures whether to include or exclude SCTP filter admit-deny statistics in accounting records.
Default
no sctp-filter-stats
Platforms
7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR
sd
sd
Syntax
sd
Context
[Tree] (config>mcast-mgmt>mcast-info-plcy>video-policy>video-if sd)
Full Context
configure mcast-management multicast-info-policy video-policy video-interface sd
Description
Commands in this context configure within a video interface policy the properties relating to requests received by the video interface for Standard Definition (SD) channel requests.
Platforms
7450 ESS, 7750 SR-1, 7750 SR-7/12/12e, 7750 SR-1s, 7750 SR-2s, 7750 SR-7s, 7750 SR-14s
sd-offset
sd-offset
Syntax
sd-offset offset-value
no sd-offset
Context
[Tree] (config>service>vprn>isis>if>level sd-offset)
Full Context
configure service vprn isis interface level sd-offset
Description
If the pre-FEC error rate of the associated DWDM port crosses the configured sd-threshold, this offset-value is added to the IS-IS interface metric. This parameter is only effective if the interface is associated with a DWDM port and the sd-threshold value is configured under that port.
The no form of this command reverts the offset value to 0.
Default
no sd-offset
Parameters
- offset-value
-
Specifies the amount the interface metric is increased by if the sd-threshold is crossed.
Platforms
All
sd-offset
Syntax
sd-offset sd-offset
no sd-offset
Context
[Tree] (config>router>isis>if>level sd-offset)
Full Context
configure router isis interface level sd-offset
Description
If the pre-FEC error rate of the associated DWDM port crosses the configured sd-threshold, this offset-value is added to the IS-IS interface metric. This parameter is only effective if the interface is associated with a DWDM port and the sd-threshold value is configured under that port.
The no form of this command reverts the offset value to 0.
Default
no sd-offset
Parameters
- sd-offset
-
Specifies the amount the interface metric is increased by if the sd-threshold is crossed.
Platforms
All
sd-threshold
sd-threshold
Syntax
sd-threshold threshold [coefficient coefficient]
Context
[Tree] (config>port>otu sd-threshold)
Full Context
configure port otu sd-threshold
Description
This command defines the error rate at which to declare the signal degrade (SD) condition.
The parameters define an error rate of (coefficient/10) * 10E-threshold. For example, sd-threshold 5 coefficient 20 defines an error rate of (20/10) * 10E-5, or 2 * 10E-5, or 0.000 02.
The SD threshold must be:
-
greater than the SF threshold.
-
5 or higher before setting sf-sd-method to bip8.
The coefficient parameter is only used when sf-sd-method is set to fec. When sf-sd-method is set to bip8, coefficient is considered to have the value of 10.
Parameters
- threshold
-
Specifies the exponent for the SD threshold value.
- coefficient
-
Specifies the coefficient for the SD threshold value.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
sd-threshold
Syntax
sd-threshold errored-frames
no sd-threshold
Context
[Tree] (config>port>ethernet>efm-oam>link-mon>errored-frame sd-threshold)
Full Context
configure port ethernet efm-oam link-monitoring errored-frame sd-threshold
Description
The option defines the number of errored frames within the configured window which indicates the port has gone beyond an acceptable error rate and should be considered degraded. This is a first level warning that a port may be suspect. This generates an information log event message only and will be recorded in the Port event index but has no port level actions when the error count is equal to or greater than the threshold. This value must be lower than or equal to the sf-threshold value.
The no value of this option disables the sd-threshold.
Default
no sd-threshold
Parameters
- errored-frames
-
Specifies the number of errored frames within the configured window which indicates the port has become degraded.
Platforms
All
sd-threshold
Syntax
sd-threshold errored-frames
Context
[Tree] (config>port>ethernet>efm-oam>link-mon>errored-frame-period sd-threshold)
Full Context
configure port ethernet efm-oam link-monitoring errored-frame-period sd-threshold
Description
The option defines the number of errored frames within the configured window which indicates the port has gone beyond an acceptable error rate and should be considered degraded. This is a first level warning that a port may be suspect. This generates an information log event message only and will be recorded in the Port event index but has no port level actions when the error count is equal to or greater than the threshold. This value must be lower than or equal to the sf-threshold value.
The no value of this option disables the sd-threshold
Default
no sd-threshold
Parameters
- errored-frames
-
Specifies the number of errored frames within the configured window which indicates the port has become degraded.
Platforms
All
sd-threshold
Syntax
sd-threshold errored-frames
no sd-threshold
Context
[Tree] (config>port>ethernet>efm-oam>link-mon>errored-frame-seconds sd-threshold)
Full Context
configure port ethernet efm-oam link-monitoring errored-frame-seconds sd-threshold
Description
This command defines the number of errored frame seconds within the configured window which indicates the port has gone beyond an acceptable error rate and should be considered degraded. This is a first level warning that a port may be suspect. This event is raised when the error count is equal to or greater than the configured threshold. This is an information log event message only and will be recorded in the Port event index but has no port level actions. This value must be lower than or equal to the sf-threshold value.
The no version of this command disables the sd-threshold.
Parameters
- errored-frames
-
Specifies the number of errored seconds within the configured window which indicates the port has become degraded.
Platforms
All
sd-threshold
Syntax
sd-threshold errored-symbols
no sd-threshold
Context
[Tree] (config>port>ethernet>efm-oam>link-mon>errored-symbols sd-threshold)
Full Context
configure port ethernet efm-oam link-monitoring errored-symbols sd-threshold
Description
This command defines the number of errored frames within the configured window which indicates the port has gone beyond an acceptable error rate and should be considered degraded. This is a first level warning that a port may be suspect. An event is raised when the error count is equal to or greater than this value. This is an information log event message only and will be recorded in the Port event index but has no port level actions. This value must be lower than or equal to the sf-threshold value. Specific to symbol errors, this value must be configured with the value that indicates anything less is acceptable and the port can be returned to service. If this value is not configured then manual operation is required to return the port to service.
The no value of this option means there is there is no automatic return to service.
Default
no sd-threshold
Parameters
- errored-symbols
-
Specifies the number of errored symbols which indicates the port has become degraded.
Platforms
All
sd-threshold
Syntax
sd-threshold threshold [multiplier multiplier]
no sd-threshold
Context
[Tree] (config>port>ethernet>sym-mon sd-threshold)
Full Context
configure port ethernet symbol-monitor sd-threshold
Description
This command specifies the error rate at which to declare the Signal Degrade condition on an Ethernet interface. The value represents M*10E-N a ratio of symbol errors over total symbols received over W seconds of the sliding window. The symbol errors on the interface are sampled once per second. A default of 10 seconds is used when there is no additional window-size configured. The multiplier keyword is optional. If the multiplier keyword is omitted or no sd-threshold is specified the multiplier will return to the default value of 1.
Default
no sd-threshold
Parameters
- threshold
-
Specifies the rate of symbol errors.
- multiplier
-
Specifies the multiplier used to scale the symbol error ratio.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
sd-threshold
Syntax
sd-threshold threshold [multiplier multiplier]
no sd-threshold
Context
[Tree] (config>port>ethernet>crc-monitor sd-threshold)
Full Context
configure port ethernet crc-monitor sd-threshold
Description
This command specifies the error rate at which to declare the Signal Degrade condition on an Ethernet interface. The value represents M*10E-N a ratio of errored frames over total frames received over W seconds of the sliding window. The CRC errors on the interface are sampled once per second. A default of 10 seconds is used when there is no additional window-size configured. The multiplier keyword is optional. If the multiplier keyword is omitted or no sd-threshold is specified the multiplier will return to the default value of 1.
Default
no sd-threshold
Parameters
- threshold
-
Specifies the threshold value.
- multiplier
-
Specifies the multiplier value.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
sd-threshold-clear
sd-threshold-clear
Syntax
sd-threshold-clear threshold [coefficient coefficient]
Context
[Tree] (config>port>otu sd-threshold-clear)
Full Context
configure port otu sd-threshold-clear
Description
This command defines the signal degrade (SD) threshold clear value.
When the bit error rate falls below this value, the SD condition is cleared. The parameters define an error rate of (coefficient/10) * 10E-threshold. For example, sd-threshold-clear 7 coefficient 10 defines an error rate of (10/10) * 10E-7, or 10E-7, or 0.000 000 1.
This SD threshold clear setting is valid only when sf-sd-method is set to fec.
Parameters
- threshold
-
Specifies the exponent for the SD threshold clear value.
- coefficient
-
Specifies the coefficient for the SD threshold clear value.
Platforms
7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS
sdp
sdp
Syntax
sdp sdp-id [sync-tag sync-tag] [create]
no sdp sdp-id
Context
[Tree] (config>redundancy>multi-chassis>peer>sync sdp)
Full Context
configure redundancy multi-chassis peer sync sdp
Description
This command specifies the manually configured spoke SDPs to be synchronized with the multi-chassis peer and a synchronization tag to be used while synchronizing these spoke SDPs with the multi-chassis peer.
Manually configured spoke SDPs with the specified sdp-id are synchronized according to the synchronization tag. If synchronization is required only for a subset of the spoke SDPs using the configured SDP, the range sub-command should be used. The range command and the sync-tag parameters are mutually exclusive.
The synchronization of PIM snooping is only supported for manually configured spoke SDPs but is not supported for spoke SDPs configured within an endpoint.
The synchronization of PIM snooping is not supported on any of the following when used with the configured sdp-id:
-
Mesh SDPs
-
Spoke SDPs in non-VPLS services
-
BGP-AD/BGP-VPLS (FEC 129) spoke SDPs
-
Spoke SDPs configured in endpoints
-
Pseudowire SAPs
-
ESM-over-MPLS Pseudowires
Non-existent spoke SDPs may be specified. If these spoke SDPs are created at a later time, then all states on the spoke SDPs are synchronized according to the synchronization tag and the synchronization protocols enabled.
A synchronization tag can be changed by entering the same command with a different synchronization tag. Changing the synchronization tag removes all states relating to the previous synchronization tag for the SDP and a new synchronization tag state is created.
Parameters
- sdp-id
-
Specifies the SDP of the spoke SDPs to be synchronized with the multi-chassis peer.
- sync-tag
-
Specifies a synchronization tag, up to 32 characters, to be used when synchronizing with the multi-chassis peer.
- create
-
Creates the SDP instance. The create keyword requirement can be enabled or disabled in the environment>create context.
Platforms
All
sdp
Syntax
sdp sdp-id
no sdp
Context
[Tree] (config>service>system>bgp-evpn>eth-seg sdp)
Full Context
configure service system bgp-evpn ethernet-segment sdp
Description
This command configures an sdp-id associated to the Ethernet-Segment. If the Ethernet-Segment is configured as all-active, then only a lag or PW port can be associated to the Ethernet-Segment. If the Ethernet-Segment is configured as single-active, then lag, port or sdp can be associated to the Ethernet-Segment. In any case, only one of the four objects can be configured in the Ethernet-Segment. A specified SDP can be part of only one Ethernet-Segment. Only user-configured SDPs can be added to an Ethernet-Segment.
Default
no sdp
Parameters
- sdp-id
-
Specifies the IP address.
Platforms
All
sdp
Syntax
[no] sdp sdp-id:vc-id
Context
[Tree] (config>service>vpls>pbb>backbone-vpls sdp)
Full Context
configure service vpls pbb backbone-vpls sdp
Description
This command configures attributes of a SDP binding on the B-VPLS service.
Parameters
- sdp-id
-
Specifies the SDP ID.
- vc-id
-
Specifies the VC ID.
Platforms
All