Professional Documents
Culture Documents
Skylight Element GX v7.9.4 CLI Command Guide Rev01
Skylight Element GX v7.9.4 CLI Command Guide Rev01
Skylight Element: GX
Version 7.9.4
Revision 1 — August 1, 2022
CLI Command Guide Skylight Element: GX Version 7.9.4
Publication Information
Skylight Element: GX Version 7.9.4 CLI Command Guide
Revision 1 — Publication date: August 1, 2022
Trademark Information
© 2022 Accedian Networks Inc. All rights reserved. Accedian™, the Accedian logo™, Skylight™, Skylight
Interceptor™ and per-packet intel™, are trademarks or registered trademarks of Accedian Networks Inc.
To view a list of Accedian trademarks visit: http://accedian.com/legal/trademarks.
All other company and product names may be trademarks of their respective companies. Accedian may,
from time to time, make changes to the products or specifications contained herein without notice. Some
certifications may be pending final approval; please contact Accedian for current certifications.
Accedian’s products are protected by patents as indicated on Accedian’s website, located at
http://www.accedian.com/en/legal.html
The mention of any product herein does not constitute an endorsement by Accedian Networks Inc.
The content of this publication is provided for informational use only, is subject to change without notice
and should not be construed as a commitment by Accedian Networks Inc. Accedian Networks Inc. assumes
no responsibility or liability for any errors or inaccuracies that may appear in this document.
Except as expressly permitted in writing, no part of this publication may be reproduced, stored in any
retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or
otherwise, without prior written consent of Accedian Networks Inc.
Changes are periodically made to the information herein; these changes will be incorporated into new
editions of this publication. Accedian Networks Inc. may make improvements and/or changes in the
products and/or software programs described in this publication at any time.
Contact
If you have comments regarding this manual, please address them to:
Tel: 514-331-6181
Fax: 514-331-2210
techpubs@accedian.com
accedian.com
Table of Contents
1.1 Requirements
This Command Guide describes all possible CLI commands with their parameters for Skylight
Element: GX v7.9.4 CLI Command Guide. It applies to the following products and models from
Accedian:
• Skylight element: GX (AMT-1000-GX)
• Skylight element: GX-S (AMT-1000-GX-S)
1.2 Organization
This manual includes the following sections:
Skylight element: GX Command Overview
This section provides a list of all Skylight element: GX CLI commands, grouped according to
their primary function.
Syntax Meta-Characters and Variables
This section provides a list of all syntax Meta-characters and variables used in the CLI
Command Guide.
CLI Commands
This section describes all CLI commands; commands are listed by name in alphanumerical
order.
1.3 References
Deploying telco equipment such as the Skylight element: GX requires the understanding of
various networking standards, technical specifications and technologies. This document
provides basic information about such standards and technologies.
1.4 Conventions
This section explains the conventions that are used in Accedian user documentation.
GUI descriptions and procedures:
• On-screen labels are displayed in bold:
Username field
• Selections required to navigate in the GUI are shown as follows:
Port ▶ Configuration
CLI command descriptions and procedures:
• Command and argument keywords are displayed in bold:
dns show
• Set of possible arguments are enclosed in curly brackets { }:
gps edit state { enable | disable }
• Arguments that must be replaced with a value are in angle brackets < > or italics:
dns edit hostname <hostname>
dns edit hostname hostname
• Optional arguments are enclosed in square brackets [ ]:
interface show [<interface-name>]
• Screen output in CLI procedures is displayed as follows:
Command executed successfully
Cautions describe situations in which failure to take an action or avoid an action could result in
damage to equipment or make it impossible to access the system. Cautions are enclosed in red
lines, for example:
CAUTION: If you modify a Management interface, you and other users may lose access to
the Web interface and the CLI.
2.5 Utilities
Command Name Description
\ Escape a meta-character.
<command-name> <key-word>
<attribute-name> <key-word>
<decimal> {0-9}+
<ip-addr> <0-255>.<0-255>.<0-255>.<0-255>
<mac-addr> <0-FF>:<0-FF>:<0-FF>:<0-FF>:<0-FF>:<0-FF>
<port> <0-65535>
<ipv6-addr> <0-FFFF>[:<0-FFFF>]+[:<0-FFFF> | :]
<ipv6-prefixLen> <0-128>
<url> <dns-name>[:<port>]/[<path>]<file-name>
<path> {<string>/}+
<file-name> <string>
<dns-name> <string>[.<string>]+
<port-name> <string>
<connector-name> <string>
4. CLI Commands
This section describes all CLI commands; commands are listed by name in alphanumerical
order.
Parameters:
<acl-name> <string>
{name <new-acl-name>} |
{index {<1-40>|<rule_name>} {
{type {ipsrc|macsrc}} |
{value <rule-value>} |
{action {drop|accept}} |
{rule_name <rule-name>} |
{priority <1-255>} |
{state {enable|disable}}
}+
}+
Parameters:
<acl-name> <string>
<new-acl-name> <string>
<rule-value> {<ip-addr>|<mac-addr>|<subnet-addr/subnet-addr-prefix>}
<rule-name> <string>
name The new ACL name
index The rule index or the rule name to edit a specific rule
type The rule type
value The rule value that match the type format
action The rule action if the type and value match
rule_name The rule name
priority The rule priority that determine the order of execution of the
rules
state The rule state
Show all interface definitions if no interface name is specified. If an interface name is specified,
only that interface will be displayed. Statistics based on the assigned ACL definition can also
be displayed if specified.
Syntax:
acl show interface [<interface-name> [stats]]
Parameters:
<interface-name> <string>
stats Display rules statistics based on the assigned ACL definition.
Syntax:
alarm show reporting
Syntax:
bandwidth-regulator clear regulator statistics [<regulator-name>]
Parameters:
<regulator-name> <string>
Parameters:
<regulator-name> <string>
<period-id> <decimal>
type Type of statistics to display:
clearable: Current statistics since last clear command.
persistent: Current statistics since system start.
historic: History buckets statistics. If the number of buckets is not
specified, the last 4 buckets will be displayed, starting from the
specified period. If no period is specified, the last 4 buckets will be
displayed.
buckets: Number of bandwidth regulator buckets to display.
period: Reference period for the bandwidth regulator history buckets.
Zero for the most recent period available.
{dhcp-client-id <client-id>} |
{id-mismatch {enable|disable} |
{adv-ip {<ip-addr>}} }}+
Parameters:
name The name to assign to the beacon instance.
domain The name of the discovery domain ID.
state Enable or disable beacon frame transmission.
rate Transmission rate of beacon frames, in seconds <3, 60, 600,
3600>.
dst-ip When neither of the use-interface and use-relay-ip options are
used, the beacon frames are sent to this address.
use-interface Enable usage of IP settings defined by the system interface
specified by the interface argument.
interface The name of a system interface. The interface must exist on this
system. The IP settings of this interface will be used to compute
the directed broadcast IP address to use to send the beacon
frames.
use-relay-ip Enable sending of frame directly to the DHCP Relay IP address
specified in the relay-ip argument.
relay-ip The DHCP Relay Agent IP address. The beacon frames are sent to
this DHCP Relay IP address in order to reach remote subnets. The
DHCP Relay must be configured to relay the beacon layer-3
frames which are based on DHCPOFFER frames.
relay-dst-subnet When used with a DHCP Relay Agent, this is the destination
subnet i.e. the subnet to reach on the other side of the DHCP
Relay.
ip-config-mode The IP configuration mode to be used by the remote device.
subnet IP subnet used in Auto and Auto-Static IP configuration modes.
netmask IP netmask used in Auto and Auto-Static IP configuration modes.
gateway IP gateway used in Auto and Auto-Static IP configuration modes.
ip-exclusion This is a comma-separated list of IP addresses that the remote
unit must exclude when computing an IP address in Auto and
Auto-Static IP configuration modes. Up to 100 IP addresses can
be specified.
IP address ranges can be expressed with dash (-) separated IP
addresses.
dhcp-hostname-option Tell the remote unit what option to use as a hostname in its DNS
configuration. Used only in DHCP IP configuration mode.
dhcp-client-id-option Tell the remote unit what option to use as a client ID in its DNS
configuration. Used only in DHCP IP configuration mode.
dhcp-hostname The hostname to use when the hostname <custom> option is
chosen. Used only in DHCP IP configuration mode.
dhcp-client-id The client ID to use when the client ID <custom> option is chosen.
Used only in DHCP IP configuration mode.
id-mismatch When enabled, forces the remote system to accept beacon even
if domain IDs do not match.
adv-ip IP address of an inventory collecting unit
dhcp-client-id-option Tell the remote unit what option to use as a client ID in its DNS
configuration. Used only in DHCP IP configuration mode.
dhcp-hostname The hostname to use when the hostname <custom> option is
chosen. Used only in DHCP IP configuration mode.
dhcp-client-id The client ID to use when the client ID <custom> option is chosen.
Used only in DHCP IP configuration mode.
id-mismatch When enabled, forces the remote system to accept beacon even
if domain IDs do not match.
adv-ip IP address of an inventory collecting unit
NOTE : The speed status for each fan is taken once every 24 hours; it is not a real-
time value.
Syntax:
board show status
Parameters:
<bridge-name> <string>
Syntax:
certificate import {
{type {pkcs7 | pkcs12 | PEM | DER}} |
{url <url>} |
{passcode}}+
Parameters:
type The type of the certificate being imported. Possible values are:
pkcs12: Used to import client certificates including the private key and
the CA chain of certificates.
pkcs7: Used to import multiple CA certificates.
x509-PEM: Used to import either:
A client or server certificate and its private key.
A single or multiple CA certificate.
x509-DER: Used to import single CA certificates.
url URL to reach the server and directory e.g.
tftp: tftp://192.168.1.1/certs/certificate.p7
ftp: ftp://192.168.1.1/certs/certificate.p7
passcode The passcode to decipher the certificate. Leave blank if the
certificate is not encrypted. A separate query prompt will be
displayed to allow the passcode to be specified. It cannot be
specified directly on the command line.
Parameters:
name The common name of the certificate to be displayed.
Syntax:
cfm add dmm {
{mep-idx <mep-index>} |
{index <decimal>} |
{rmep-id <1-8191>} |
{priority <0-7> } |
{enable {yes | no}} |
{name <string>} |
{interval <decimal>} |
{reference-period <decimal> } |
{ow-delay {enable | disable}} |
{ow-max-delay <decimal>} |
{ow-delay-threshold <decimal>} |
{ow-ad-threshold <decimal>} |
{ow-dv {enable | disable}} |
{ow-max-dv <decimal>} |
{ow-dv-threshold <decimal>} |
{ow-adv-threshold <decimal>} |
{tw-delay {enable | disable}} |
{tw-max-delay <decimal>} |
{tw-delay-threshold <decimal>} |
{tw-ad-threshold <decimal>} |
{tw-dv {enable | disable}} |
{tw-max-dv <decimal>} |
{tw-dv-threshold <decimal>} |
{tw-adv-threshold <decimal>}}+
<mep-index> = <decimal>
Parameters:
mep-idx Specifies the local MEP index from which DMM should be
initiated.
index A free DMM index. If the index is omitted, a free index is allocated
automatically.
rmep-id Specifies the remote MEPID to which DMM should be sent.
priority Specifies DMM VLAN priority. This parameter applies only to
VLAN based MEPs.
name A name assigned to reference this instance.
enable Enable or disable generating DMM frames.
interval Interval in milliseconds at which DMM should be sent.
reference-period Reference period in minutes.
ow-delay Enable or disable one-way delay results.
ow-max-delay Maximum one-way delay.
ow-delay-threshold Maximum consecutive one-way delay samples allowed greater
than ow-max-delay.
ow-ad-threshold Maximum one-way average delay.
ow-dv Enable or disable one-way delay variation results.
ow-max-dv Maximum one-way delay variation allowed.
ow-dv-threshold Maximum consecutive one-way delay variation samples allowed
greater than ow-max-dv.
ow-adv-threshold Maximum one-way average delay variation.
tw-delay Enable or disable two-way delay results.
tw-max-delay Maximum two-way average delay.
tw-delay-threshold Maximum consecutive two-way delay samples allowed greater
than tw-max-delay.
tw-ad-threshold Maximum two-way average delay.
tw-dv Enable or disable two-way delay variation results.
tw-max-dv Maximum two-way delay variation allowed.
tw-dv-threshold Maximum consecutive tw-way delay variation samples allowed
greater than tw-max-dv.
tw-adv-threshold Maximum two-way average delay variation.
Syntax:
cfm add domain {
{name <string> } |
{index <decimal>} |
{format {string | dns-name}} |
{level <0-7>} |
{mhf-creation <none | default | explicit>} |
{sndr-id-perm {none | chassis | manage | chassis-manage>}}+
Parameters:
name Unique name assigned to this Maintenance Domain.
index A free domain index. If the index is omitted, a free index is
allocated automatically.
format The Maintenance Domain name format.
level Maintenance level given to this Maintenance Domain.
mhf-creation Indicates if the management entity can create MHFs for VIDs on
which no Up MEP is configured. The valid values are:
none: No MHFs can be created.
default: Create MHFs if there is no lower active MD level or if there is a
MEP at the next active MD level on the port.
explicit: Create MHFs only if there is a MEP at the next active MD level on
the port.
sndr-id-perm Sender ID permission. Indicates what, if anything, is to be
included in the Sender ID TLV transmitted in CCMs, LBMs, LTMs,
and LTRs.
{ccm-interval <decimal> } |
{vce <vce-name>} |
{component <component-id>} |
{vlan-type {c-vlan | s-vlan | t-vlan | none}} |
{vid-list {<1-4094> [, <1-4094>]+}} |
{mepid-list {<1-8191> [, <1-8191>]+}} |
{mhf-creation <none | default | explicit | defer>} |
{sndr-id-perm {none | chassis | manage | chassis-manage | defer}} |
{rmep-auto-discovery {disable | enable}}}
{maid-string-format-mode {normal | legacy}}}+
Parameters:
name MEG name. The name should include the ICC and UMC in a single
string, as specified in Y.1731.
index A free Maintenance Association index. If the index is omitted, a
free index is allocated automatically.
md-idx Parent Maintenance Domain index. Cannot be used in
conjunction with md-name and md-name-format.
md-name Parent Maintenance Domain name. Cannot be used in
conjunction with md-idx.
md-name-format Parent Maintenance Domain name format. Cannot be used in
conjunction with md-idx. Default is "string".
ccm-interval Interval, in milliseconds, at which the CCMs are sent.
vce Indicate the VCE name from which to obtain the component ID,
instead of entering the component parameter directly.
component Specify the ID of the component on which this Maintenance
Association will be made.
vlan-type Specify the type of VLAN associated with this Maintenance
Association. If the value "none" is specified, the association is not
attached to any VLAN and the contents of the VLAN ID list are
ignored. When a VCE is specified, the correct type is
automatically selected.
vid-list A comma-separated list of VLAN ID values. If the VLAN ID list is
left empty, the association is not attached to a VLAN and the
VLAN type is set to "none" implicitly. If a vid-list is provided
without specifying the vlan-type, it is set to C-VLAN implicitly.
mepid-list A comma-separated list of MEPID values.
mhf-creation Indicates if the management entity can create MHFs for VIDs on
which no Up MEP is configured. Valid values are:
none: No MHFs can be created.
default: Create MHFs if there is no lower active MD level or if there is a
MEP at the next active MD level on the port.
explicit: Create MHFs only if there is a MEP at the next active MD level on
the port.
normal: CCM PDUs using this format will result in the Short MA Name
Length field having the correct value.
legacy: CCM PDUs generated using this format and whose Short MA
Name length is less than 13, will result in the Short MA Name
Length field having a fixed value of 13. When the Short MA Name
length is 13 or greater, the generated CCM PDU will have the
correct value in the Short MA Name Length field. This will enable
inter-operability with existing Accedian equipment running older
firmware versions and configured to use Character String format
with MD Name not present.
lowest-alarm-pri The lowest priority defect alarm that specifies the lowest priority
defect that is allowed to generate a Fault Alarm. Possible values
are: all, macRemErrXconAis, remErrXconAis, errXconAis, xconAis,
ais, or none.
fng-alarm-time Time that defects must be present before an alarm is raised (in
ms).
fng-reset-time Time that defects must be absent before resetting an alarm (in
ms).
fault-propagation Enable or disable EVC fault propagation.
fp-port Fault propagation port. Indicates toward which port, EVC faults
should be propagated.
interface-status-tlv Enable or disable the interface status TLV on a MEP. For a down
MEP, the fp-port's status is used for this TLV. For an up MEP, the
status is sourced from the port on which the MEP is created.
<mep-index> = <decimal>
Parameters:
mep-idx Specifies the local MEP index from which packet loss should be
performed.
index A free packet loss index. If the index is omitted, a free index is
allocated automatically.
rmep-id Remote MEP Maintenance association End Point Identifier.
enable Indicates if the configured packet loss measurements are
performed.
Syntax:
cfm assign interface { <name> }
Parameters:
Name The interface name to be associated with CFM.
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies a MEP.
<name> Identifies a MEP by name.
Syntax:
cfm delete dmm <dmm-index> | <name>
<dmm-index> = <decimal>
<name> = <string>
Parameters:
<dmm-index> Identifies the DMM instance to delete.
<name> Identifies the DMM instance to delete by name.
<pl-index> = <decimal>
<name> = <string>
Parameters:
<pl-index> Identifies the packet loss instance to delete.
<name> Identifies the packet loss instance to delete by name.
<component-id> <decimal>
level Indicates the default active MD level used by the MHF creation
algorithm when no other lower active MD level applies.
mhf-creation Indicates if the management entity can create MHFs for VIDs on
which no Up MEP is configured. The valid values are:
none: No MHFs can be created.
default: Create MHFs if there is no lower active MD level or if there is a
MEP at the next active MD level on the port.
explicit: Create MHFs only if there is a MEP at the next active MD level on
the port.
sndr-id-perm Sender ID permission. Indicates what, if anything, is to be
included in the Sender ID TLV transmitted in CCMs, LBMs, LTMs
and LTRs.
Syntax:
cfm edit dmm <dmm-index>|<name> {
{enable {yes | no}} |
{interval <decimal>} |
{name <string> } |
{reference-period <decimal> } |
{ow-delay {enable | disable}} |
{ow-max-delay <decimal>} |
{ow-delay-threshold <decimal>} |
{ow-ad-threshold <decimal>} |
{ow-dv {enable | disable}} |
{ow-max-dv <decimal>} |
{ow-dv-threshold <decimal>} |
{ow-adv-threshold <decimal>} |
{tw-delay {enable | disable}} |
{tw-max-delay <decimal>} |
{tw-delay-threshold <decimal>} |
{tw-ad-threshold <decimal>} |
{tw-dv {enable | disable}} |
{tw-max-dv <decimal>} |
{tw-dv-threshold <decimal>} |
{tw-adv-threshold <decimal>}}+
<dmm-index> = <decimal>
<name> = <string>
Parameters:
<dmm-index> Specifies the DMM instance to modify.
<name> Specifies the DMM instance to modify by name.
Enable Enable or disable generating DMM frames.
Interval Interval in milliseconds at which DMMs should be sent.
Name A name assigned to reference this instance.
reference-period Reference period in minutes.
ow-delay Enable or disable one-way delay results.
ow-max-delay Maximum one-way delay.
ow-delay-threshold Maximum consecutive one-way delay samples allowed greater
than ow-max-delay.
ow-ad-threshold Maximum one-way average delay.
ow-dv Enable or disable one-way delay variation results.
ow-max-dv Maximum one-way delay variation allowed.
ow-dv-threshold Maximum consecutive one-way delay variation samples allowed
greater than ow-max-dv.
ow-adv-threshold Maximum one-way average delay variation.
tw-delay Enable or disable two-way delay results.
tw-max-delay Maximum two-way average delay.
tw-delay-threshold Maximum consecutive two-way delay samples allowed greater
than tw-max-delay.
tw-ad-threshold Maximum two-way average delay.
tw-dv Enable or disable two-way delay variation results.
Parameters:
Error DMM test ID TLV cannot be modified if any DMM instances exist.
<ma-index> = <decimal>
Parameters:
ma-index Maintenance Association index. Identifies the MA to modify.
ccm-interval Interval, in milliseconds, at which the CCMs are sent.
mepid-list A comma-separated list of MEPID values.
mhf-creation Indicates if the management entity can create MHFs for VIDs on
which no Up MEP is configured. Valid values are:
none: No MHFs can be created.
default: Create MHFs if there is no lower active MD level or if there is a
MEP at the next active MD level on the port.
explicit: Create MHFs only if there is a MEP at the next active MD level on
the port.
defer: Use the Maintenance Domain parameter to determine how MHFs
are created.
sndr-id-perm Sender ID permission. Indicates what, if anything, is to be
included in the Sender ID TLV transmitted in CCMs, LBMs, LTMs
and LTRs.
rmep-auto-discovery Remote MEP auto-discovery. When enabled, remote MEPs will
be automatically added to the MA/MEG when the remote MEP's
CCM message is received.
maid-string-format-mode
<meg-index> = <decimal>
Parameters:
meg-index MEG index. Identifies the MEG to modify.
ccm-interval Interval, in milliseconds, at which the CCMs are sent.
mepid-list A comma-separated list of MEPID values.
mhf-creation Indicates if the management entity can create MHFs for VIDs on
which no Up MEP is configured. Valid values are:
none: No MHFs can be created.
default: Create MHFs if there is no lower active MD level or if there is a
MEP at the next active MD level on the port.
explicit: Create MHFs only if there is a MEP at the next active MD level on
the port.
<mep-index> = <decimal>
<name> = <string>
Parameters:
mep-index MEP index. Identifies the MEP to modify.
pvid Primary VLAN ID <0-4094>.
active Indicates the administrative state of the MEP. "true" indicates
that the MEP is to function normally and "false" that it is to cease
functioning.
cci-enable Indicates if the MEP will generate CCM messages.
ccm-seq-number Enable or disable CCM sequence number. When enabled, a MEP
transmits CCMs with a sequence number that increments by one
for each CCM. When disabled, a MEP transmits CCMs with a
sequence number set to zero.
name A name assigned to reference this instance.
csf-enable Enable or disable CSF. When enabled, a MEP transmits ETH-CSF
when a link failure is detected.
priority CCM, LTM, and CSF priority.
lowest-alarm-pri The lowest priority defect alarm that specifies the lowest priority
defect that is allowed to generate a Fault Alarm. Possible values
are: all, macRemErrXconAis, remErrXconAis, errXconAis, xconAis,
ais, or none.
fng-alarm-time Time that defects must be present before an alarm is raised (in
ms).
fng-reset-time Time that defects must be absent before resetting an alarm (in
ms).
fault-propagation Enable or disable EVC fault propagation.
fp-port Fault propagation port. Indicates toward which port EVC faults
should be propagated. When a MEP is configured on a VCE TP,
the correct fp-port is automatically selected.
interface-status-tlv Enable or disable the interface status TLV on a MEP. For a down
MEP, the fp-port's status is used for this TLV. For an up MEP, the
status is sourced from the port on which the MEP is created.
<pl-index> = <decimal>
<name> = <string>
Parameters:
<pl-index> Specifies the packet loss instance to modify.
<name> Specifies the packet loss instance by name.
enable Indicates if the configured packet loss measurements are
performed.
reference-period Packet loss reference period in minutes.
name A name assigned to reference this instance.
threshold Maximum number allowed of packets lost before raising an alarm
during the reference period.
threshold-ratio Maximum % of packets lost before issuing an alarm during the
reference period.
{near-end-threshold <decimal>} |
{far-end-threshold <decimal>} |
{interval <decimal>}}+
includes a Data TLV. By default, there is no Data TLV. In both cases, the loopback request
status is available from:
"cfm show mep status <mep-index>"
An active loopback request can be stopped using:
"cfm stop lbm"
Syntax:
cfm lbm {mep-idx <mep-index> | mep-name <name>}
{ {{rmep-id <1-8191>} |
{dst-mac-addr <mac-addr>}} |
{nbr-msg <decimal>} |
{interval <100-5000>} |
{vlan-priority <0-7>} |
{vlan-de {enable | disable}} |
{data <string>} |
{data-length <1-1488>}}+
<mep-index> = <decimal>
<name> = <string>
Parameters:
mep-index Specifies the local MEP index from which the loopback request
should be initiated.
mep-name Specifies the local MEP instance by name from which the
loopback request should be initiated.
rmep-id Specifies a remote MEP for loopback target.
dst-mac-addr Specifies a MAC address for loopback target.
nbr-msg Specifies the amount of loopback messages (LBM) to send.
Default value is 1 message.
Interval Specifies the interval between LBMs in milliseconds.
Default value is 1000.
vlan-priority Specifies the VLAN priority of LBMs.
vlan-de Specifies the VLAN drop eligible indicator value of LBMs.
data Specifies a data pattern for LBM Data TLV. By default, the Data
TLV is filled with incremental values.
data-length Specifies the data length of the LBM Data TLV. By default, the
length of the data parameter value is used.
<mep-index> = <decimal>
<name> = <string>
Parameters:
mep-idx Specifies the local MEP index from which the link trace request
should be initiated.
mep-name Specifies the local MEP instance by name from which the link
trace request should be initiated.
rmep-id Specifies a remote MEP for target for the link trace.
dst-mac-addr Specifies a MAC address for target for the link trace.
ttl Specifies the link trace time to live.
fdb-only Specifies whether or not the LTM should set the flag
"UseFDBonly" (IEEE 802.1ag) or the flag "HWonly" (Y.1731).
verbose Allows verbose mode. Default is non-verbose.
<dmm-index> = <decimal>
<name> = <string>
<period-id> = <decimal>
Parameters:
<dmm-index> Specifies the delay measurement instance.
<name> Specifies the delay measurement instance by name.
type Type of statistics to display:
historic: history buckets statistics. If the number of buckets is not
specified, the last 4 buckets will be displayed, starting from the
specified period. If no period is specified, the last available 4
buckets will be displayed.
buckets: Number of DMM buckets to display.
period: Reference period for the DMM history buckets. Zero for the most
recent period available.
<mep-index> = <decimal>
<name> = <string>
Parameters:
mep-idx Identifies a MEP by MEP index.
mep-name Identifies a MEP by name.
ltm-id Link trace transaction identifier. If omitted, the latest transaction
from that MEP is retrieved.
<ma-index> = <decimal>
Parameters:
<ma-index> Identifies a Maintenance Association.
<meg-index> = <decimal>
Parameters:
<meg-index> Identifies a MEG.
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies a MEP.
<name> Identifies a MEP instance by name.
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies a MEP.
<name> Identifies a MEP instance by name.
<pl-index> = <decimal>
<name> = <string>
Parameters:
<pl-index> Identifies a packet loss instance.
<name> Identifies a packet loss instance by name.
<pl-index> = <decimal>
<name> = <string>
<period-id> = <decimal>
Parameters:
<pl-index> Specifies the packet loss instance.
<name> Specifies the packet loss instance by name.
type Type of statistics to display:
historic: history buckets statistics. If the number of buckets is not
specified, the last 4 buckets will be displayed, starting from the
specified period. If no period is specified, the last available 4
buckets will be displayed.
buckets: Number of PL buckets to display.
period: Reference period for the PL history buckets. Zero for the most
recent period available.
Parameters:
<identifier> An optional instance name or index to display.
type Type of statistics to display.
historic: history buckets statistics.
If the number of buckets is not specified, the last 4 buckets will
be displayed, starting from the specified period. If no period is
specified, the last available 4 buckets will be displayed.
buckets: Number of SLM buckets to display.
period: Reference period for the SLM history buckets.
Zero for the most recent period available.
<cli-cmd-names> = <cli-cmd-name>[,<cli-cmd-name>]+
Parameters:
cli-cmd-name A CLI command whose configuration should be generated. It is
possible to specify many commands. Alternatively, if no
command is specified, all configuration will be generated.
<user-name> <string>
<password> <string>
Example:
configuration generate-script module port,interface,soam export-to-server
tftp://192.168.1.240/soam_config.txt
Examples:
configuration import http://mypc.com/newconfig.cfg
configuration import ftp://username:password@mypc.com/newconfig.cfg
Parameters:
<user-name> <string>
<password> <string>
<port-name> = <string>
<cos-pcp-map-list> = <cos-pcp-map>[,<cos-pcp-map>]+
<cos-pcp-map> = <cos-value>:<pcp-value>
<cos-value> = <0-7>
<pcp-value> = <0-7>
Parameters:
<port-name> The port to which this mapping applies.
encode-dei Determines if the frame color is encoded using DEI. When
enabled and the outgoing frame is marked yellow, the bit is set
to 1, otherwise, it is set to 0.
green-cos A comma separated list of cos to pcp mappings to apply when
outgoing frame color is green.
yellow-cos A comma separated list of cos to pcp mappings to apply when
outgoing frame color is yellow.
default-pre-marking Pre-marking color to be used for all frames if the input DSCP is
not in input-list.
default-green-out PCP value to be used if the outgoing frame color is green and the
input DSCP is NOT in input-list.
default-yellow-out PCP value to be used if the outgoing frame color is yellow and
the input DSCP is NOT in input-list.
yellow-out PCP value to be used if the outgoing frame color is yellow and
the input PCP is in input-list.
default-pre-marking Pre-marking color to be used for all frames if the input PCP is not
in input-list.
default-green-out PCP value to be used if the outgoing frame color is green and the
input PCP is NOT in input-list.
default-yellow-out PCP value to be used if the outgoing frame color is yellow and
the input PCP is NOT in input-list.
green-out PCP value to be used if the outgoing frame color is green and the
input IP precedence is in input-list.
yellow-out PCP value to be used if the outgoing frame color is yellow and
the input IP precedence is in input-list.
default-pre-marking Pre-marking color to be used for all frames if the input IP
precedence is not in input-list.
default-green-out PCP value to be used if the outgoing frame color is green and the
input IP precedence is NOT in input-list.
default-yellow-out PCP value to be used if the outgoing packet color is yellow and
the input IP precedence is NOT in input-list.
<port-name> = <string>
Parameters:
<port-name> A system port name to which these options apply.
mgmt-mode This parameter modifies the method used to select multicast and
broadcast frames required by system management interfaces,
such ARP and NDP, that are submitted to the CPU.
auto: The system determines automatically the best policies to apply
based on system interface configuration and hardware filtering
resources.
mac-oui: Only frames with a source MAC address containing a unit's MAC
OUI are submitted to the CPU.
policy: No broadcast nor multicast frames are selected by default for this
port. The user is responsible to configure policies with the action
"mgmt-oam", "mgmt-oam-drop" or "mgmt-oam-fwd" required
by system network interfaces configured on the specified port.
NOTE : Using mgmt-mode auto or mac-oui does not preclude configuring policies
with one of the mgmt-oam actions listed above.
<port-name> = <string>
Parameters:
<port-name> A system port name.
4.127 Date
date - Print or set the system date and time
Description:
Same as the UNIX date command. Display the current time in the given FORMAT or set the
system date.
Syntax:
date {option}... {MMDDhhmm[[CC]YY][.ss]} { '+format' }
Parameters:
d Print the specified date.
R Output RFC-2822 compliant date string.
s Set the current date to the specified date.
u Print or set Coordinated Universal Time.
%M minute (00..59)
%n a newline
%N nanoseconds (000000000..999999999)
%p locale's upper case AM or PM indicator (blank in many locales)
%P locale's lower case am or pm indicator (blank in many locales)
%r time, 12-hour (hh:mm:ss [AP]M)
%R time, 24-hour (hh:mm)
%s seconds since `00:00:00 1970-01-01 UTC' (a GNU extension)
%S second (00..60); the 60 is necessary to accommodate a leap
second
%t a horizontal tab
%T time, 24-hour (hh:mm:ss)
%u day of week (1..7); 1 represents Monday
%U week number of year with Sunday as first day of week (00..53)
%V week number of year with Monday as first day of week (01..53)
%w day of week (0..6); 0 represents Sunday
%W week number of year with Monday as first day of week (00..53)
%x locale's date representation (mm/dd/yy)
%X locale's time representation (%H:%M:%S)
%y last two digits of year (00..99)
%Y year (1970...)
%z RFC-2822 style numeric timezone (-0500) (a nonstandard
extension)
%Z time zone (e.g., EDT), or nothing if no time zone is determinable
Example:
set the date to December 1st 2006,15:48PM : date -s 120115482006
show the current day only : date '+%d'
dhcp-hostname The DHCP client custom host name (option 12) to use when
selecting custom dhcp-hostname-option.
dhcp-hostname-option The DHCP hostname option to set on the DHCP client.
server1 The first DNS address used if no DHCP server set.
server2 The second DNS address used if no DHCP server set.
{rpl-port <string>} |
{rpl-role <string>} |
{subring-without-vc {yes | no}} |
{version <decimal>} |
{vid-list <string>} |
{vlan-type <string>} |
{wtr <decimal>}}+
Parameters:
<name> The ERP instance name.
aps-vid The APS VLAN ID ranging (1 - 4095).
guard Guard timer duration in ms.
hold-off Hold off timer duration in ms.
index ERP instance index.
lag LAG name.
level MEG level.
mep0-identifier MEP name or index for ring port 0.
mep1-identifier MEP name or index for ring port 1.
name ERP instance name.
port0 Name of the physical port 0 used in the ERP.
port1 Name of the physical port 1 used in the ERP.
revertive Revertive mode of operation.
rpl-port Ring protection link port.
rpl-role Ring protection link role (none, owner, neighbour).
subring-without-vc Member of a sub-ring without a virtual channel.
version G.8032 protocol version.
vid-list VLAN ID list.
vlan-type C-VLAN or S-VLAN or T-VLAN type.
wtr Wait to restore timer in minutes.
{wtr <decimal>}}+
Parameters:
guard Guard timer duration in ms.
hold-off Hold off timer duration in ms.
mep0-identifier MEP name or index for ring port 0.
mep1-identifier MEP name or index for ring port 1.
name ERP instance name.
revertive Revertive mode of operation.
rpl-port Ring protection link port.
rpl-role RPL role.
version G.8032 protocol version.
vid-list VLAN ID list.
wtr Wait to restore timer in minutes.
Syntax:
erp show status [<identifier>]
Parameters:
identifier The ERP name or index
4.147 Exit/Quit
exit - Logout of the CLI
quit - Logout of the CLI
Description:
Logout of the CLI.
Syntax:
exit
quit
Parameters:
<filter-name> <string>
Parameters:
<filter-name> <string>
name A unique name to identify the filter.
disable | enable To enable or disable the field in the check.
dst-ipv4-addr The IPv4 destination address.
dst-ipv4-mask Wildcard mask to be applied to the IPv4 destination address.
Valid mask are prefix from 0 to 32 bits (ex. 0.0.0.0 -
255.255.255.255).
src-ipv4-addr The IPv4 source address.
src-ipv4-mask Wildcard mask to be applied to the IPv4 destination address.
Valid mask are prefix from 0 to 32 bits (ex. 0.0.0.0 -
255.255.255.255).
protocol Layer 4 protocol value (0 - 255).
header-length IPv4 header length in 32bit units (5 - 15).
ttl IPv4 time to live value (0 - 255).
icmp-type ICMP type (0 - 255).
icmp-code ICMP code (0 - 255).
destination-port Destination port for TCP and UDP protocols
(0 - 65535).
destination-port-last Destination port last value, used in range operation.
destination-port-oper Destination port operator. Valid operator types are: eq (equal) or
range (inclusive range).
source-port Source port for TCP and UDP protocols (0 - 65535).
source-port-last Source port last value, used in range operation.
source-port-oper Source port operator. Valid operator types are: eq (equal) or
range (inclusive range).
ip-qos-mode Choose between DSCP (RFC2474) or precedence (RFC791).
interpretation for the IP TOS field.
dscp The Diff-Serv CodePoint value (0 - 63).
dscp-last The last DSCP value, used in range operation.
dscp-oper Diff-Serv CodePoint operator. Valid operator types are: gt
(greater than), lt (less than), eq (equal) or range (inclusive range).
precedence The Precedence value (0 - 7).
precedence-last The last Precedence value, used in range operation.
precedence-oper Precedence field operator. Valid operator types are: gt (greater
than), lt (less than), eq (equal) or range (inclusive range).
ecn Explicit Congestion Notification value (0 - 3).
vlanstack-size Indicates the number of VLAN tags that packets must have in
order to match this filter (0 - 3).
vlan1-cfi First VLAN CFI may be 0 or 1. It is usually set to 0.
vlan2-cfi Second VLAN CFI may be 0 or 1. It is usually set to 0.
vlan1-id First VLAN ID may be any value between 0 and 4095.
Syntax:
firmware clear-download
Examples:
firmware download http://domain.com/AEN_6.4.2_35876.afl
firmware download ftp://username:password@domain.com/AEN_6.4.2_35876.afl
firmware download
ftps://username:password@domain.com:990/AEN_6.4.2_35876.afl
firmware download
sftp://username:password@domain.com:22/AEN_6.4.2_35876.afl
Parameters:
<user-name> <string>
<password> <string>
NOTES : Firmware prior to version 4.0 cannot be rolled back. The firmware on a unit
that has been factory reset cannot be rolled back (the rollback version is
unavailable).
If a firmware file has been downloaded as part of a two-step firmware upgrade, the
rollback version is no longer available.
Syntax:
firmware rollback
Examples:
firmware upgrade http://domain.com/AEN_6.4.2_35876.afl
firmware upgrade ftp://username:password@domain.com/AEN_6.4.2_35876.afl
firmware upgrade
ftps://username:password@domain.com:990/AEN_6.4.2_35876.afl
firmware upgrade sftp://username:password@domain.com:22/AEN_6.4.2_35876.afl
Parameters:
<user-name> <string>
<password> <string>
4.170 Help
help - Help will help you with commands you are not familiar with
Syntax:
help <command>
Parameters:
<command> <string>
Parameters:
period-mode Selects the mode in which the periods are retrieved to generate a
report file.
new: only the periods since the last report.
fixed: fixed number of periods.
all: all available periods.
local-periods Specifies the number of local periods to process in fixed mode.
include-disabled Specifies if the report should include the statistics for disabled
objects.
include-previous Specifies if the report should include the periods included in a
previous aborted file transfer. This is only used if period-mode is
"new".
url URL to reach the server and directory e.g.
http://mypc.com
ftp://username:password@mypc.com
sftp://username@mypc.com
tftp://mypc.com
scp://username@mypc.com:/target_directory
scp-password Password used for SCP and SFTP transfers.
{local-hours {<hour-value>}+} |
{local-minutes {<minutes-value>}+} |
{local-offset <0-(local-period - 1)>} |
{local-random-offset <0-900>} |
{local-period <5|10|15|20|30|60>}|
{local-mode <hourly|periodic>}}+
Parameters:
local-state Enables or disables the scheduling mechanism on the local device.
local-hours Sets the hour(s) at which the local statistics are reported
{00H00|01H00|02H00 ...}.
local-minutes When in hourly mode, sets the minute(s) at which the local
statistics are reported with 15-minute. granularity
{00H00|00H15|00H30|00h45}.
local-offset Sets the offset to add to the local-minutes. Adding an offset
spreads out the load on the file servers by distributing the upload
moments over time.
local-random-offset Randomly generates an extra offset between 0 and the specified
value that is added to the local offset. Expressed in seconds.
local-period When in periodic mode, the period at which the local statistics
are retrieved. Similar to local-minutes, but statistics are reported
every local-period minutes for the selected local-hours.
When in hourly mode, this parameter is ignored and the value of
local-period is 15 minutes.
local-mode Sets either periodic or hourly mode. In periodic mode, the minutes
that trigger statistics reporting are set using local-period;
whereas in hourly mode, the minutes that trigger statistics
reporting are set using local-minutes.
Syntax:
history show local
IPv6: Two IPv6 addresses can be configured (0 and 1). This is different from IPv4
aliases as the index is not specified in the interface name but as a p arameter of the
address. All IPv6 addresses are over the same interface.
Syntax:
interface {add|edit} <interface-name>|<alias-name>
{name <interface-name>|<alias-name>} |
{dhcp {enable|disable}} |
{dhcp-rt-info {enable|disable}} |
{dhcp-static {enable|disable}} |
{address {<ip-addr>|<ip-addr-prefix>}} |
{netmask {<ip-addr>}} |
{gateway {<ip-addr>}} |
{ipv6_enable {enable|disable}} |
{ipv6_dhcp {disabled|stateless|stateful}} |
{ipv6_radv {enable|disable}} |
{ipv6_static {enable|disable}} |
{ipv6_address <0-1> {<ipv6-addr>/<ipv6-prefixLen>
[-<ipv6-gateway>]}} |
{vlan1-id <vlan-id>} |
{vlan2-id <vlan-id>} |
{vlan1-ethertype {c-vlan | s-vlan | t-vlan}} |
{vlan2-ethertype {c-vlan | s-vlan | t-vlan}} |
{vlan1-priority <0-7>} |
{vlan2-priority <0-7>} |
{type {standard|vlan|bridge|vlan-in-vlan|bridge-vlan}} |
{name <interface-name> } |
{port <port-name> } |
{sub-intf <sub-intf-name-list> } |
{ip-override {enable|disable} } |
{force {enable|disable} } |
{state {enable|disable} } |
{dhcp-relay {enable|disable}} |
{ipv4-fwd {enable|disable}} |
{stp {enable|disable}} }+
{icmp_redirect {enable|disable} } |
{ipv6_ icmp_redirect {enable|disable} } |
Parameters:
<interface-name> <string>
<alias-name> <string>:0
<ip-addr-prefix> <ip-addr>/{1-32}
<vlan-id> <decimal>
<port-name-list> <string> [, <string>]*
name Interface or alias name
dhcp Enable or disable DHCP
dhcp-rt-info Use routing information learned via DHCP
dhcp-static Note: This option can only be used when DHCP is enabled. Use
static IP until an address is resolved by DHCP.
Invalid on Auto interface.
address Static interface IP address
netmask Interface network mask for static IP address
Syntax:
ipv4 edit options { { forwarding <enable|disable> } |
{ igmp-version <0,2,3> } }+
Parameters:
forwarding The IPv4 forwarding state.
igmp-version Set interface IGMP version (0, 2, 3). 0 means do not force any
version and use the system default.
Syntax:
interface advertisement show [<interface-name>|<alias-name>]
Parameters:
<interface-name> <string>
<alias-name> <string>:0
<domain> <string>
state Enable or disable beacon frame transmission
rate Transmission rate of beacon frames, in seconds <3, 60, 600,
3600>
subnet IP subnet used in auto IP config mode
netmask IP netmask used in auto IP config mode
gateway IP gateway used in auto IP config mode
ip-config-mode Tell which IP configuration mode to use on the remote device.
id-mismatch When enabled, tells the remote system to authorize beacon even
if domain IDs do not match.
dhcp-hostname-option Tell the remote unit what option to use as a hostname in its DNS
configuration.
dhcp-client-id-option Tell the remote unit what option to use as a client ID in its DNS
configuration.
dhcp-hostname The hostname to use when the hostname <custom> option is
chosen.
dhcp-client-id The client ID to use when the client ID <custom> option is chosen.
ip-exclusion In Auto and Auto IP Static configuration modes, a comma-
separated list of IP addresses to exclude on the remote units can
be specified. Up to 100 IP addresses can be specified. IP address
ranges can be expressed with dash (-) separated IP addresses.
Syntax:
interface delete <interface-name>|<alias-name>
Parameters:
<interface-name> <string>
<alias-name> <string>:0
Display of the new field 'Auxiliary MAC' will always be present on those platforms
the Dual MAC feature is enabled.
Output:
IPv4 interface
C414-4358: interface show Management
Interface name: Management
Interface type : Standard
Interface state : Enabled
IPv4 forwarding : Disabled
DHCP relay : Disabled
On port : Management
DHCP : Yes
Static+DHCP : Yes
Static IP : 192.168.1.254
IP address : 10.231.60.51
Netmask : 255.255.0.0
Default gateway : 10.231.0.1
ICMP redirect : Enabled
IPv6 interface
Parameters:
<serial-number> <string>
Parameters:
forwarding The IPv4 forwarding state.
icmp_redirect Enable or disable the global ICMP redirects.
The default value is enable
igmp-version Set interface IGMP version (0, 2, 3). 0 means do not force any
version and use the system default.
Output:
C408-1777: ipv4 show options
Options Value
-------------------------------- ----------------
Forwarding Disabled
ICMP redirect Enabled
IGMP version 2
4.195 Keepalive
keepalive - Allow to keep a CLI session alive.
Description:
The CLI session is kept alive using this simple command.
Syntax:
keepalive
{rule-vid-from <vid>} |
{rule-vid-to <vid>} |
{rule-vid-pcp <pcp>} |
{rule-vid-cfi <cfi>} |
{rule-type {c-vlan | s-vlan}}
{cos-mapping <cos-mode>} |
{cos-map-pcp <pcp>} |
{cos-map-cfi <cfi>} |}+
Parameters:
<rule-name> L2PT rule name.
state Enable or disable the L2PT rule.
catchall Enable or disable the catchall mode of a rule.
mode Selects the operation mode of the L2PT rule:
drop: Frames matching the specific rule are dropped.
forward: Frames are sent unaltered from the incoming port to the
outgoing port. Optionally, EVC mapping can be enabled on
forwarding rules.
tunnel: Frames matching the specific rule get their destination MAC
address replaced by the MAC specified in the rule parameters
when ingressing the specified inport. Frames matching the
specific rule get their original destination MAC address put back
when ingressing the specified outport. Tunneling rules are
bidirectional.
peer: The frames are sent to software layers for further processing.
protocol The Layer-2 Control Protocol to be processed by this specific rule.
inport The rule's ingress port. For tunneling rules, this specifies the port
where the frames to be tunneled ingress.
outport The rule's egress port. For tunneling rules, this specifies the port
where the frames to be de-tunneled ingress.
unique-id The unique identifier used by the tunneling rules. This is used to
build a unique replacement MAC address.
replacement-mac The multicast MAC address to use as a replacement when
protocol tunneling is performed. The following replacement MAC
can be used:
cisco: 01:00:0C:CD:CD:D0 is used.
accedian: 01:15:AD:CC:xx:yy is used where:
xx: the unique-id.
yy: the protocol id.
evc-mapping Allows forwarding rules to perform EVC mapping:
none: Frames are forwarded unaltered.
push: A tag of vlan1-type is added.
pop: If the VLAN type and ID both match, the tag is removed.
Syntax:
l2pt clear [<rule-name>]
Parameters:
<rule-name> L2PT rule name.
Syntax:
l2pt show configuration [<rule-name>]
Parameters:
<rule-name> L2PT rule name.
NOTES : State variables for the port are encoded as individual bits within a single
octet as follows:
LACP_Activity is encoded in bit 0. This flag indicates the Activity controlval ue with
regard to this link. Active LACP is encoded as 1; Passive LACP is encoded as 0.
LACP_Timeout is encoded in bit 1. This flag indicates the Timeout control value with
regard to this link. Short Timeout is encoded as 1; Long Timeout is encoded as 0.
Aggregation is encoded in bit 2. If TRUE (encoded as 1), this flag indicates that the
system considers this link to be Aggregateable, i.e.: a potential candidate for
aggregation. If FALSE (encoded as 0), the link is considered to be Individual, i.e. this
link can be operated only as an individual link.
If FALSE (encoded as 0), then this link is currently OUT_OF_SYNC, i.e.: it is not in
the right Aggregation.
Defaulted is encoded in bit 6. If TRUE (encoded as 1), this flag indicates that the
Actor Receive machine is using Defaulted operational Partner information,
administratively configured for the Partner. If FALSE (encoded as 0), the operational
Partner information in use has been received in an LACPDU;
Expired is encoded in bit 7. If TRUE (encoded as 1), this f lag indicates that the Actor
Receive machine is in the EXPIRED state; if FALSE (encoded as 0), this flag indicates
that the Actor Receive machine is not in the EXPIRED state.
S PECIAL NOTE : The received values of Defaulted and Expired state are not used by
LACP. However, knowing their values can be useful when diagnosing protocol
problems.
Syntax:
lacp show status [<agg-identifier>]
Parameters:
<agg-identifier> <string>
NOTE : swap-* actions apply only to custom loopbacks (user defined filter).
Parameters:
<port-name> Only physical, non-management ports are accepted.
state Enable execution of the loop-detection instance.
name A unique name. If the name is omitted, a free name is allocated
automatically.
interval Beacon transmission rate (1-30 seconds). Default: 1.
index A free index. If the index is omitted, a free index is allocated
automatically.
auto-block Enable auto-block mechanism.
revertive Enable revertive mode for auto-block mechanism.
Syntax:
loop-detection clear tunnel counters [<name | index>]
Parameters:
name Identifies the loop-detection instance to clear.
index Identifies the loop-detection instance to clear by index.
Syntax:
loop-detection show all counters
Syntax:
loop-detection show link counters
igmp-version Set interface IGMP version (0-3). 0 means do not force any
version, use the kernel default.
webs-port Set the web server TCP port.
Parameters:
<server-address> <ip-addr> | <ipv6-addr> | <dns-name>
{efsse-threshold <decimal>} |
{efsse-window <10-9000>} }+
Parameters:
<instance-name> <string>
<oam-name> <string>
name New name assigned to the OAM instance
port Port to bind this OAM instance
state Administrative state
mode OAM instance mode, active or passive
max-pdu-size Max OAM PDU size
event-re-transmit Number of Event re-transmits
efe-threshold Errored Frame Event threshold
efe-window Errored Frame Event window
efpe-threshold Errored Frame Period Event threshold
efpe-window Errored Frame Period Event window
efsse-threshold Errored Frame Seconds Summary Event threshold
efsse-window Errored Frame Seconds Summary Event window
Parameters:
<instance-name> <string>
Syntax:
paa {add|edit} l2 <probe-name> {
{state {disable | enable}} |
{mode { source | sink | bi-dir } } |
{local-index <decimal> } |
{peer-index <decimal> } |
{port <port-name> } |
{dst-mac-addr <mac-addr> } |
{vlan1-id [<0-4095>] [enable|disable] } |
{vlan1-priority <0-7> } |
{vlan2-id [<0-4095>] [enable|disable] } |
{vlan2-priority <0-7> } |
{vlan1-type {c-vlan | s-vlan}} |
{vlan2-type {c-vlan | s-vlan}} |
{pkt-size <66-1500> } |
{validate-vlan1-id {disable | enable} } |
{rx-vlan1-id [<0-4095>] } |
{couple-tx-rx-vlan1-id {disable | enable} } |
Syntax:
paa {add|edit} udp <probe-name> {
{state {disable | enable}} |
{mode { source | sink | bi-dir } } |
{local-index <decimal> } |
{peer-index <decimal> }
{dst-ipv4-addr <ip-addr> } |
{udp-dest-port <decimal> } |
{udp-src-port <decimal> } |
{dscp <0-63> } |
{ecn <0-3> } |
{vlan1-priority <0-7> } |
{validate-vlan1-priority {disable | enable} } |
{rx-vlan1-priority <0-7> } |
{couple-tx-rx-vlan1-priority {disable | enable} } |
{validate-dscp {disable | enable} } |
{rx-dscp <0-7> } |
{couple-tx-rx-dscp {disable | enable} } |
{pkt-size <66-1472> } |
{sampling-period <decimal> } |
{cc-threshold <decimal> } |
{pkt-loss-ref-period <decimal> } |
{pkt-loss-threshold <decimal> } |
{ow-ref-period <decimal> } |
{ow-join-period <decimal> } |
{ow-max-delay <decimal> } |
{ow-delay-threshold <decimal> } |
{ow-ad-threshold <decimal> } |
{ow-max-dv <decimal> } |
{ow-dv-threshold <decimal> } |
{ow-adv-threshold <decimal> } |
{tw-ref-period <decimal> } |
{tw-max-delay <decimal> } |
{tw-delay-threshold <decimal> } |
{tw-ad-threshold <decimal> } |
{tw-max-dv <decimal> } |
{tw-dv-threshold <decimal> } |
{tw-adv-threshold <decimal> } |
{igmp-ref-period <decimal> } |
{join-max-delay <decimal> } |
{join-delay-threshold <decimal> } |
{join-ad-threshold <decimal> } |
{leave-max-delay <decimal> } |
{leave-delay-threshold <decimal> } |
{leave-ad-threshold <decimal> } }+
Parameters:
<probe-name> Probe name.
state Enable or disable the PAA probe.
mode Indicates if a probe generates (source) or collects
(sink) measurement packets or does both (bi-
dir).
local-index Specifies the local identifier for the probe. If it is
omitted or set to 0 when the instance is added,
the system will automatically allocate a value to
the local identifier. The range is 0 to 300.
peer-index Specifies the remote peer identifier.
dst-ipv4-addr The peer IPv4 destination address.
udp-dest-port Specifies destination UDP port (default 8793,
valid ports > 1023).
udp-src-port Specifies source UDP port (default 8793, valid
ports > 1023).
dscp The Diff-Serv CodePoint value.
ecn The Explicit Congestion Notification value.
vlan1-priority First VLAN priority bits. This applies only if the
outgoing interface is encapsulated in a VLAN.
validate-vlan1-priority Enable or disable VLAN 1 priority validation.
couple-tx-rx-vlan1-priority Couple Tx and Rx VLAN 1 priority values for
VLAN 1 priority validation.
rx-vlan1-priority Expected VLAN 1 priority value received by the
remote unit.
validate-dscp Enable or disable DSCP validation.
couple-tx-rx-dscp Couple Tx and Rx DSCP values for DSCP
validation.
rx-dscp Expected DSCP value received by the remote
unit.
pkt-size Packet size. Does not include the headers (UDP,
IP, Ethernet) and the FCS bytes.
sampling-period Interval at which PAA measurement packets are
sent.
cc-threshold Continuity check threshold. Number of
consecutive sampling periods without receiving
peer packets before declaring loss of continuity.
pkt-loss-ref-period Packet loss reference period.
Syntax:
paa {add|edit} udpipv6 <probe-name> {
{state {disable | enable}} |
{mode { bi-dir } } |
{local-index <decimal> } |
{peer-index <decimal> }
{dst-ipv6-addr <ip-addr> } |
{udp-dest-port <decimal> } |
{udp-src-port <decimal> } |
{traffic-class <0-63> } |
{ecn <0-3> } |
{vlan1-priority <0-7> } |
{validate-vlan1-priority {disable | enable} } |
{rx-vlan1-priority <0-7> } |
{couple-tx-rx-vlan1-priority {disable | enable} } |
{validate-traffic-class {disable | enable} } |
{rx-traffic-class <0-7> } |
{couple-tx-rx-traffic-class {disable | enable} } |
{pkt-size <66-1452> } |
{sampling-period <decimal> } |
{cc-threshold <decimal> } |
{pkt-loss-ref-period <decimal> } |
{pkt-loss-threshold <decimal> } |
{ow-ref-period <decimal> } |
{ow-max-delay <decimal> } |
{ow-delay-threshold <decimal> } |
{ow-ad-threshold <decimal> } |
{ow-max-dv <decimal> } |
{ow-dv-threshold <decimal> } |
{ow-adv-threshold <decimal> } |
{tw-ref-period <decimal> } |
{tw-max-delay <decimal> } |
{tw-delay-threshold <decimal> } |
{tw-ad-threshold <decimal> } |
{tw-max-dv <decimal> } |
{tw-dv-threshold <decimal> } |
{tw-adv-threshold <decimal> } }+
Parameters:
<probe-name> Probe name.
state Enable or disable the PAA probe.
mode Indicates that a probe generates and collects
measurement packets (bi-dir).
local-index Specifies the local identifier for the probe. If it is
omitted or set to 0 when the instance is added,
the system will automatically allocate a value to
the local identifier. The range is 0 to 300.
peer-index Specifies the remote peer identifier.
dst-ipv6-addr The peer IPv6 destination address.
udp-dest-port Specifies destination UDP port (default 8793,
valid ports > 1023).
udp-src-port Specifies source UDP port (default 8793, valid
ports > 1023).
traffic-class The Differentiated Services Code Point value.
ecn The Explicit Congestion Notification value.
vlan1-priority First VLAN priority bits. This applies only if the
outgoing interface is encapsulated in a VLAN.
validate-vlan1-priority Enable or disable VLAN 1 priority validation.
couple-tx-rx-vlan1-priority Couple Tx and Rx VLAN 1 priority values for
VLAN 1 priority validation.
rx-vlan1-priority Expected VLAN 1 priority value received by the
remote unit.
validate-traffic-class Enable or disable traffic class validation.
couple-tx-rx-traffc-class Couple Tx and Rx traffic class values for traffic
class validation.
rx-traffic-class Expected traffic class value received by the
remote unit.
pkt-size Packet size. Does not include the headers (UDP,
IP, Ethernet) and the FCS bytes.
Syntax:
paa show status [<probe-name>]
Parameters:
<probe-name> <string>
Syntax:
permission-group {edit|delete} <group-name> {
{ {add-permission|delete-permission}
{Acl|Alarms|All-add|All-edit|All-enable|CFM|Config|
Filters|Firmware|
History|Log|L2PT|Management|OAM|PAA|Policies|Port|Protection|
RFC-2544|SAT-Protocol|SAT-reporting|Service Availability|
Service mapping|Sessions|Shaping|Traffic|Twamp|Users|Y.1564},+ }
{sub-permission <permission group>
<sub-permission name> {enable|disable}} }
Parameters:
<group-name> <string>
add-permission Permission added to the permission-group.
delete-permission Permission deleted from the permission-group.
sub-permission Sub-permission of the permission group.
<permission group> Permission group which has sub-permission
<sub-permission name> Sub-permission depends on each permission group.
4.277 Ping
ping - send ICMP ECHO_REQUEST to network hosts
Description:
Ping sends ICMP(v4 or v6) ECHO_REQUESTs to a network host which will send back and
ECHO_RESPONSE to test the path between the two hosts.
Usage:
ping [OPTIONS] HOST
Options:
-4,-6 Force IP or IPv6 name resolution
-c CNT Send only CNT pings
-s SIZE Send SIZE data bytes in packets (default:56)
-I IFACE/IP Use interface or IP address as source
-W SEC Seconds to wait for the first response (default:10) (after all -c
CNT packets are sent)
-w SEC Seconds until ping exits (default:infinite) (can exit earlier with -c
CNT)
-q Quiet, only displays output at start and when finished
4.278 Ping6
ping6 - send ICMP ECHO_REQUEST to network hosts (IPv6)
Description:
ping6 is the IPv6 version of ping, it sends ICMPv6 ECHO_REQUESTs to a
network host which will send back and ECHO_RESPONSE to test the path
between the two hosts.
Usage:
ping6 [OPTIONS] HOST
Options:
-c CNT Send only CNT pings
-s SIZE Send SIZE data bytes in packets (default:56)
-I IFACE/IP Use interface or IP address as source
-W SEC Seconds to wait for the first response (default:10) (after all -c
CNT packets are sent)
-w SEC Seconds until ping exits (default:infinite) (can exit earlier with -c
CNT)
-q Quiet, only displays output at start and when finished
Syntax:
pmcollect edit configuration {<parameter> <value>}*
Syntax:
policy edit { Traffic-x} <policy-id> {
{ state {enable | disable}} |
{ out-port <port-name>} |
{ queuing-profile <queuing-profile-name>} |
{ filter {l2 | ipv4 | ipv6 | vlan} <filter-name>} |
{ action {permit | drop | MGMT-OAM | MGMT-OAM-drop |
MGMT-OAM-fwd | none}} |
{ monitor {enable <monitor-name> | disable}} |
{ evc-encapsulation {none | push | pop | replace | pop-replace |
push-preserve | preserve-vlan-new-cfi-pcp |
push-push | pop-pop | push-replace}} |
{ evc-ethertype {c-vlan | s-vlan | t-vlan} |
{ evc-ethertype2 {c-vlan | s-vlan | t-vlan} |
{ evc-vlan-id <0-4095>} |
{ evc-vlan-id2 <0-4095>} |
{ cos-mapping {preserve | direct | map}} |
{ map1-state {enable | disable}} |
{ map1-type {pcp-vlan | pcp-vlaninvlan | precedence | dscp}} |
{ map1-cos-profile <cos-profile-name>} |
{ map1-regulator-set {enable <regulator-set-name> | disable}} |
{ map2-state {enable | disable}} |
{ map2-type {pcp-vlan | pcp-vlaninvlan | precedence | dscp}} |
{ map2-cos-profile <cos-profile-name>} |
{ map2-regulator-set {enable <regulator-set-name> | disable}}
|
{ green-cfi <0-1>} |
{ yellow-cfi <0-1>} |
{ green-pcp <0-7>} |
{ yellow-pcp <0-7>} |
{ pre-marking {green | yellow | red} |
{ regulator {enable <regulator-name> | disable}}
}+
Parameters:
<policy-id <decimal>
<filter-name> <string>
<regulator-name> <string>
state Enable or disable the policy.
out-port Outgoing port for this policy.
queuing-profile The queuing profile associated with this outgoing port.
NOTE : None, MGMT-OAM, MGMT-OAM & Drop and MGMT-OAM & Forward actions
are not supported when the filte r type is VID set .
{protection {enable|disable}} |
{protection-mode {link-status|lacp-status|
erp-status}} |
{working-connector <connector-name>} |
{revertive {enable|disable}} |
{revert-period <decimal>} |
{link-time-out <decimal>}
{lldp-state {enable|disable}}
{lldp-rate <decimal>}
{media-selection-mode {auto|manual}} |
{media-selection-conn {SFP|RJ45}} |
{version <1-2>} }+
Parameters
<port-identifier> <string>
<port-alias> <string>
<advertisement-value> {100M-HD|100M-FD|1G-HD|1G-FD|10G-
FD|pause|asym-pause}
name New name assigned to the port.
alias The "alias" name for the port, as specified by a
network manager.
state Port administrative state.
mtu Maximum transmission unit, which is platform
dependent and includes all headers.
NOTE : When the MTU is set to exceed a value of 2000, it is important that the ports
passing traffic through the unit be configured with a matching speed. If the speed
does not match, FIFO errors could occur.
-3 (8 messages / second)
-2 (4 messages / second)
-1 (2 messages / second)
0 (1 message / second)
1 (1 message / 2 seconds) <- default value
2 (1 message / 4 seconds)
3 (1 message / 8 seconds)
sync Specifies the interval of Sync message from the master.
Possible values:
-4 (16 messages / second)
-3 (8 messages / second)
-2 (4 messages / second)
-1 (2 messages / second)
0 (1 message / second) <- default value
1 (1 message / 2 seconds)
pdn Specifies the domain number of the primary PTP master.
Possible values: 0 to 255
Default value : 4
sdn Specifies the domain number of the secondary PTP master.
Possible values: 0 to 255
Default value : 4
dscp When using PTP, the priority of the packets can be set in the
DiffServ Code Point.
vlan-priority When using PTP, the priority of the packets can be set in the
VLAN priority bits if the link is through a VLAN.
NOTE : Communication with the grandmaster clock is only supported via unicast
negotiation (defined in clause 16.1 of IEEE 1588-2008). Multicast negotiation is not
supported.
NOTE : The new parameters are only effective on the next login attempt.
Syntax:
radius edit {
{auth-method {pap}} |
{auth-server1-host {<ip-addr> | <ipv6-addr> | <dns-name>}} |
{auth-server1-port <decimal>} |
{auth-server1-secret <string>} |
{auth-server1-source <ip-addr>} |
{auth-server2-host {<ip-addr> | <ipv6-addr> | <dns-name>}} |
{auth-server2-port <decimal>} |
{auth-server2-secret <string>} |
{auth-server2-source <ip-addr>} |
{auth-server3-host {<ip-addr> | <ipv6-addr> | <dns-name>}} |
{auth-server3-port <decimal>} |
{auth-server3-secret <string>} |
{auth-server3-source <ip-addr>} |
{radius-timeout <decimal>} |
{radius-retries <decimal>} |
{realm <string>} |
{vendor-specific {enable | disable}} }+
Parameters:
auth-method Authentication method to use.
auth-server1-host RADIUS host server to authenticate to.
Parameters:
generator Set the working rate for the RFC-2544 generator and testsuite,
and Y.1564 testing.
regulator Set the working rate for all bandwidth regulator.
shaper Set the working rate for the shaper.
4.298 Reboot
Reboots the unit
regulator Bandwidth regulator to be used for all packets that have a DSCP
in input-list.
default-regulator Bandwidth regulator to be used for all packets that do NOT have
a DSCP in input-list.
NOTE : All units contain pre-programmed RFC-2544 loopbacks for "layer-2" and "l2-
accedian" frames. When testing with "l2-generic" frames or layer-3 packets, you
need to configure a custom loopback in the peer unit. This loopback must perform a
swap action on the MAC addresses, IP addresses and port numbers, as applicable.
Refer to the "oam loopback" command for more information on how to create a
custom loopback.
Packet and Flow are sub-sections of the generator and have their own exclusive set of
parameters, as described below.
Syntax:
rfc2544 generator edit {{port <port-name>} |
{exclude-vlan-size {yes | no}} |
{packet1 <packet-params>} |
{packet2 <packet-params>} |
{flow1 <flow-params>} |
{flow2 <flow-params>}} }+
Parameters:
port Name of the port to which to send the flow(s).
exclude-vlan-size The frame length is increased by the size of the
VLAN tag header(s) being added to the frame.
<packet-params> Generator packet header configuration (see below).
<flow-params> Generator flow profile configuration (see below).
Packet syntax:
rfc2544 generator edit <packet-name>
{ {dst-mac-addr <mac-addr>} |
{packet-type {layer-2 | layer-3 | l2-accedian |
l2-generic | ip-multicast | l3-generic}} |
{ethertype <0-65535>} |
{vlan1-header {enable | disable}} |
{vlan1-ethertype {0x8100 | 0x88a8 | 0x9100}} |
{vlan1-priority <0-7>} |
{vlan1-id <0-4095>} |
{vlan1-cfi <0-1>} |
{vlan2-header {enable | disable}} |
{vlan2-ethertype {0x8100 | 0x88a8 | 0x9100}} |
{vlan2-priority <0-7>} |
{vlan2-cfi <0-1>} |
{vlan2-id <0-4095>} |
{dscp <0-63>} |
{ecn <0-3>} |
{ttl <0-255>} |
{dst-ipv4-addr <ip-addr>} |
{src-ipv4-addr <ip-addr>} |
{destination-port <0-65535>} |
{source-port <0-65535>} |
{y1731-level <0-7>}}+
Packet parameters:
packet-name packet[n] where "n" is included in <1-2> (not modifiable).
packet-type Used to define specific fields in the test packet.
ethertype The Ethernet type identifies the frame contents. This parameter
is deprecated and no longer needed. Its syntax still remains valid
for backward compatibility. Its value is set automatically based
on the value of packet-type. For example: 0x0800 for Layer-3,
0x8902 for Layer-2, 0x88FC for Layer-2 Accedian or Layer-2
generic.
dst-mac-addr This is the Ethernet MAC destination address.
vlan1-header Enable or disable VLAN 1 parameters in the frames.
vlan1-ethertype First VLAN protocol ID set to C-VLAN (0x8100) for 802.1Q
network, T-VLAN (0x9100) for 802.1Q tunneling network, or S-
VLAN (0x88A8) for 802.1AD network.
Parameters:
flow-name flow[n] where "n" is included in <1-2> (not modifiable).
description <string> Description identifying the packet and its characteristics.
traffic-type Type of traffic may be one of the following:
constant: To send frames at a specific bit rate (Kbps). You
need to specify the Bit rate.
burst: To send a predefined number of frames at every
period. You must specify the Packets per Burst. For the Constant
traffic type, specify the bit rate (expressed in Kbps).
Supported values are:
0 to < 12.5 Mbps: Steps of 0.125 Mbps
> 13 Mbps to 1 Gbps: Steps of 1 Mbps
For Burst traffic type, specify the number of frames to send per
period (Packets per Burst) and the period, expressed in
milliseconds, between each burst of frames (Inter-Burst Gap).
You must select a Bit Rate that does not exceed the capacity of
the outgoing port used for that test. Failure to do so will result in
inaccurate results.
packet-size Define the packet size, this includes the Ethernet header and the
FCS. The size can be a fixed value or a random value, chosen
between a minimum and a maximum value.
payload-pattern Define the pattern to fill the remaining spaces in the transmitted
packet. The pattern can be a 32-bit value, an incremental byte, an
incremental word or a random pattern from the list.
duration Duration of the flow can be specified in seconds, in bytes, in
packets or can be continuous until user interruption.
type Type of flow testing being done:
out-of-service:
two-way loopback using the full link bandwidth.
in-service:
one-way test for sharing a traffic regulator with client traffic.
Note that when the flow type is In-service, you must
select a Regulator.
regulator Regulator selected for in-service testing.
{vlan1-priority <0-7>} |
{vlan1-id <0-4095>} |
{vlan1-cfi <0-1>} |
{vlan2-header {enable | disable}} |
{vlan2-ethertype {0x8100 | 0x88a8 | 0x9100}} |
{vlan2-priority <0-7>} |
{vlan2-cfi <0-1>} |
{vlan2-id <0-4095>} |
{dscp <0-63>} |
{ecn <0-3>} |
{ttl <0-255>} |
{dst-ipv4-addr <ip-addr>} |
{src-ipv4-addr <ip-addr>} |
{destination-port <0-65535>} |
{source-port <0-65535>} |
{y1731-level <0-7>}}+
Packet parameters:
packet-type Used to define specific fields in the test packet.
dst-mac-addr This is the Ethernet MAC destination address.
ethertype The Ethernet type identifies the frame contents. This parameter
is deprecated and no longer needed. Its syntax still remains valid
for backward compatibility. Its value is set automatically based
on the value of packet-type. For example: 0x0800 for Layer-3,
0x8902 for Layer-2, 0x88FC for Layer-2 Accedian or Layer-2
generic.
vlan1-header Enable or disable VLAN 1 parameters in the frames.
vlan1-ethertype First VLAN protocol ID set to C-VLAN (0x8100) for 802.1Q
network, T-VLAN (0x9100) for 802.1Q tunneling network, or S-
VLAN (0x88A8) for 802.1AD network.
vlan1-cfi First VLAN CFI may be 0 or 1. It is usually set to 0.
vlan1-id First VLAN ID may be any value between 0 and 4095.
vlan1-priority First VLAN priority. The range is 0 to 7, with 7 being the highest
priority. Normal traffic has priority 0.
vlan2-header Enable or disable VLAN 2 parameters in the frames.
vlan2-ethertype* Second VLAN protocol ID set to C-VLAN (0x8100) for 802.1Q
network, T-VLAN (0x9100) for 802.1Q tunneling network, or S-
VLAN (0x88A8) for 802.1AD network
vlan2-cfi Second VLAN CFI may be 0 or 1. It is usually set to 0.
vlan2-id Second VLAN ID may be any value between 0 and 4095.
vlan2-priority Second VLAN priority. The range is 0 to 7, with 7 being the
highest priority. Normal traffic has priority 0.
dscp The Diff-Serv CodePoint value (0 - 63).
{repeat <decimal>} |
{sizes {64bytes | 128bytes |
256bytes | 512bytes |
1024bytes | 1280 bytes |
1514bytes | jumbo}}
{state {enable | disable}} |
}
}
{delay {{duration <decimal>} |
{frameloss <decimal>} |
{sizes {64bytes | 128bytes |
256bytes | 512bytes |
1024bytes | 1280 bytes |
1514bytes | jumbo}}
{state {enable | disable}} |
}
}
{throughput {{duration <decimal>} |
{frameloss <decimal>} |
{minimum <decimal>} |
{maximum <decimal>} |
{step <decimal>} |
{fine-stepping {enable | disable}} |
{sizes {64bytes | 128bytes |
256bytes | 512bytes |
1024bytes | 1280 bytes |
1514bytes | jumbo}}
{state {enable | disable}} |
}
}
{frameloss {{duration <decimal>} |
{step <decimal>} |
{sizes {64bytes | 128bytes |
256bytes | 512bytes |
1024bytes | 1280 bytes |
1514bytes | jumbo}}
{state {enable | disable}} |
}
}
}+
Parameters:
name <string> Unique name for this testsuite.
description <string> Description identifying the testsuite and its
characteristics.
port Name of the port to which to send the flow(s).
jumbo Size of the jumbo frames <0-10240>.
binary-duration Duration of each trial during the binary search for the maximum
throughput. By default, this is set to 2 seconds. Binary duration
can vary from 1 to 10 seconds.
strict-failure Failure on Duplicate or Out-Of-Order.
verbose Display all attempts in report file.
exclude-vlan-size The frame length is increased by the size of the
VLAN tag header(s) being added to the frame.
peer Peer packet header configuration (see packet syntax and
parameters below).
back2back Back-to-back test settings.
duration: Duration of the test in milliseconds.
repeat: Number of bursts to perform for each packet size.
sizes: Frame sizes to use. Any combination is valid.
state: Enable or disable back2back test settings.
delay Delay and delay variation test settings.
duration: Duration of the test in seconds.
frameloss: Acceptable difference between measured frame
loss (0.1%).
sizes: Frame sizes to use. Any combination is valid.
state: Enable or disable delay test settings.
throughput Throughput test settings.
duration: Duration of the test in seconds.
step: Granularity of the min-max range.
fine-stepping: Enable fine stepping in case of low bandwidth
testing (below 12 Mbps).
minimum: Minimum rate in Mbps.
maximum: Maximum rate in Mbps.
frameloss: Acceptable difference between measured frame
loss (0.1%).
sizes: Frame sizes to use. Any combination is valid.
state: Enable or disable throughput test settings.
frameloss Frameloss test settings.
duration: Duration of the test in seconds.
step: Granularity of the min-max range.
vlan1-priority First VLAN priority. The range is 0 to 7, with 7 being the highest
priority. Normal traffic has priority 0.
vlan2-header Enable or disable VLAN 2 parameters in the frames.
vlan2-ethertype Second VLAN protocol ID set to C-VLAN (0x8100) for 802.1Q
network, T-VLAN (0x9100) for 802.1Q tunneling network, or S-
VLAN (0x88A8) for 802.1AD network.
vlan2-cfi Second VLAN CFI may be 0 or 1. It is usually set to 0.
vlan2-id Second VLAN ID may be any value between 0 and 4095.
vlan2-priority Second VLAN priority. The range is 0 to 7, with 7 being the
highest priority. Normal traffic has priority 0.
dscp The Diff-Serv CodePoint value (0 - 63).
ecn The Explicit Congestion Notification value (0 - 3).
ttl This is the IPv4 time to live value (0 - 255).
dst-ipv4-addr The IPv4 destination address.
src-ipv4-addr The IPv4 source address (valid only for l3-generic).
destination-port This is the destination port for UDP protocol (0 - 65535).
source-port This is the source port for UDP protocol (0 - 65535).
y1731-level Y.1731 Maintenance Entity Group level (0-7).
The displayed status for each report can be one of the following:
Failed: An error occurred during the testsuite execution.
Running: The testsuite is currently running.
Stopped: A user stopped the testsuite during its execution.
Completed: The testsuite has completed.
Syntax:
rfc2544 testsuite show reports [<filename>]
Parameters:
<filename> <string> Unique filename associated with the report.
Parameters:
filename <string> Unique filename associated with the testsuite.
{destination <ipv6-addr>/<ipv6-
prefixLen>} |
{gateway <ipv6-addr>} |
{interface <interface-name>} }+
Parameters:
<route-name> <string> The name of the route. It can be a brief description of
the route, e.g. "Default".
<interface-name> <string> The interface with which the route is associated. This is
only for specific situations when a target exists on a different
network for that interface. In most situations, the interface is
determined automatically.
type Route type may either be Network for a range of addresses or
Host for a specific IP address.
destination Network or host address of the route. Use 0.0.0.0 (for IPv4) or
::/0 (for IPv6) to denote the default route.
netmask Mask assigned to the route. Only used for network routes.
gateway Gateway address associated with this route or default gateway
address.
interface The interface with which the route is associated. This is only for
specific situations when a target exists on a different network for
that interface. In most situations, the interface is determined
automatically.
{hli-window-size <decimal>} |
{time-interval <decimal>}}+
Parameters:
<sa-name> A unique name to identify a service availability instance.
window-size The number of consecutive Time Intervals used to assess Service
Availability for this instance. Default value is 10.
reporting-period A reporting period over which periodic availability counters are
evaluated in addition to the monotonic counters.
time-interval The interval of time during which the metric is evaluated. Default
value is 1 second. Allowed values are 1, 5, 10, 20, or 60 seconds.
hli-window-size The number of consecutive Time Intervals used to assess
Consecutive High Loss Intervals for this instance. Default value is
3.
<sa-name> = <string>
Parameters:
name The name of a service availability instance. If omitted, clears all
instances of the selected counters.
type The type of counter to clear:
periodic : Clear periodic counters. Default.
monotonic: Clear monotonic counters.
all: Clear all counters.
<sa-name> = <string>
<metric-name> = <string>
Parameters:
<sa-name> The name of a service availability instance.
<metric-name> The name of the metric to remove.
<sa-name> = <string>
Parameters:
<sa-name> A unique name identifying a service availability instance.
<sa-name> = <string>
<metric-name> = <string>
<delay-thrld> = <decimal>
<plr-thld> = <decimal>
Parameters:
<sa-name> The name of a service availability instance.
<metric-name> The name of metric instance inside the service availability
instance.
name The new name to assign to the metric instance
<sa-name> = <string>
<port-name> = <string>
Parameters
<sa-name> The name of the SA instance.
name A new name to assign to the service instance.
window-size The number of consecutive seconds over which
to assess availability. Default is 10.
time-interval The interval of time during which the metric is
evaluated. Default value is 1 second. Allowed
values are 1, 5, 10, 20 or 60 seconds.
hli-window-size The number of consecutive time intervals used
to assess Consecutive High Loss Intervals for this
instance. Default value is 3.
reporting-period A reporting period over which availability
counters are evaluated in addition to the
monotonic counters. Default value is 15 minutes.
state The instance state:is (In Service): Availability
must be assessed.
<metric-name> = <string>
<sa-name> = <string>
Parameters:
<sa-name> The name of a service availability instance.
<metric-name> The name of the metric to display.
<sa-name> = <string>
Parameters:
<sa-name> Optional service instance name to display.
counters for all instances are displayed. Additionally, if the history feature is enabled, history
information may be displayed by specifying the type.
Syntax:
sa show service counters [<sa-name>] [type historic {buckets | period }
value]
<sa-name> = <string>
Parameters:
<sa-name> An optional instance name to display.
type historic The type of history statistics to retrieve. Options are buckets or
periods.
value the period index or the number of buckets to display.
tacacs+ | local-tacacs+ |
tacacs+-local | strict-tacacs+-local}} |
{maxsessions <decimal>} |
{maxclisessions <decimal>} |
{maxwebsessions <decimal>} |
{maxnetconfsessions <decimal>} |
{timeoutcli <0-1800>} |
{timeoutweb <0-1800>} |
{timeoutnetconf <0-1800>} |
{telnet-server {enable | disable}} |
{file-transfer-timeout <decimal>}}+
Parameters
auth-order Authentication client to use in order of availability.
maxsessions Total number of CLI and WEB sessions that are supported at the
same time.
maxclisessions Maximum number of WEB sessions that are supported at the
same time.
maxwebsessions Maximum number of WEB sessions that are supported at the
same time.
maxnetconfsessions Maximum number of NETCONF sessions that are supported at
the same time.
timeoutcli Maximum number of seconds that a CLI session can remain idle
before it is automatically logged out. (0 means use maximum
timeout).
timeoutweb Maximum number of seconds that a WEB session can remain idle
before it is automatically logged out. (0 means use maximum
timeout).
timeoutnetconf Maximum number of seconds that a NETCONF session can
remain idle before it is automatically logged out. (0 means use
maximum timeout).
telnet-server Enable or disable the telnet server on the unit.
file-transfer-timeout Maximum number of seconds that a file Transfer
session can remain idle before it automatically
close the connection.
(min. 900sec and max. 3600sec)
notices Enable or disable notices.
NOTE : A speed marked with a * in the output identifies the overridden speed as
oppose to the detected speed.
contact-info The textual identification of the contact person for this managed
node, together with information on how to contact this person
(see RFC-1213 for more details).
ro-community Community string used for Read-Only operations.
rw-community Community string used for Read-Write operations.
system-location The physical location of this node. For instance, it can be the
address of the building and the floor number (see RFC-1213 for
more details).
system-name An administratively-assigned name for this managed node. By
convention, this is the node's fully-qualified domain name (see
RFC-1213 for more details).
authentication-trap Enable this option to have a trap generated when authentication
to the agent fails. Map to the generic trap 4(1.3.6.1.6.3.1.1.5.5).
link-trap Enable this option to have a trap generated when link status
changes. Maps to generic traps 2(1.3.6.1.6.3.1.1.5.3 linkDown) and
3(1.3.6.1.6.3.1.1.5.4 linkUp).
{host-community <string>} |
{host-name <string>} |
{host-port <1-65535>}}+
Parameters:
host-state Enable/Disable the sending of traps to the configured host.
host-community Community string used to send SNMP traps to configured host.
host-name This command defines the host name or IP address of the server
to which the traps (and/or inform notifications) are sent. The unit
sends a Cold Start trap when it starts and upon authentication
failure.
host-port This command defines the UDP port to use when sending traps
(the well-known SNMP trap port 162 is used by default).
Syntax:
snmp-trap show
4.365 Syntax
syntax - Display CLI syntax
Description:
Display CLI syntax explanations.
Syntax:
syntax
Note: The new parameters take effect upon the next login attempt.
Syntax:
tacacs-plus edit <parameter> <value>
Note: The new parameters take effect upon the next login attempt.
Syntax:
tacacs-plus edit {
Syntax:
tech-support {export}
[{ ftp | ftps |
scp | sftp | tftp }://[<user-name>:<password>@]<url>]
Parameters:
<user-name> <string>
<password> <string>
Examples:
tech-support export ftp://username:password@mypc.com/nnewreport.bz2
tech-support export ftps://username:password@mypc.com:990/newreport.bz2
tech-support export sftp://username:password@mypc.com:22/newreport.bz2
tech-support export scp://username:password@mypc.com:22/newreport.bz2
Syntax:
{show report-transmission} |
4.386 Traceroute
traceroute - Trace the route to HOST (IPv4)
Description:
traceroute tracks the route packets take through an IP network on their way to a given host.
Usage:
traceroute [-46FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]
[-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]
[-z PAUSE_MSEC] HOST [BYTES]
Options:
-4,-6 Force IP or IPv6 name resolution
-F Set the don't fragment bit
-I Use ICMP ECHO instead of UDP datagrams
-l Display the TTL value of the returned packet
-d Set SO_DEBUG options to socket
-n Print numeric addresses
-r Bypass routing tables, send directly to HOST
-v Verbose
-m Max time-to-live (max number of hops)
-p Base UDP port number used in probes
(default 33434)
-q Number of probes per TTL (default 3)
4.387 Traceroute6
traceroute6 - Trace the route to HOST (IPv6)
Description:
traceroute6 tracks the route packets take through an IPv6 network on their way to a given
host.
NOTE : The traceroute command supports both IPv4 and IPv6, so traceroute6 is
equivalent to traceroute -6, however some parameters used in IPv4 may not be
valid for IPv6.
Usage:
traceroute6 [-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]
[-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]
HOST [BYTES]
Syntax:
twamp-gen add {
{name <string>} |
{state {enable | disable}} |
{interval <decimal>} |
{reference-period <decimal> } |
{pkt-loss-threshold <0-100>} |
{continuity-check <decimal>} |
{tw-avg-delay-thrs <decimal>} |
{tw-avg-dv-thrs <decimal>} |
{tw-max-delay-thrs <decimal>} |
{tw-max-dv-thrs <decimal>} |
{tw-max-delay <decimal>} |
{tw-max-dv <decimal>} |
{ow-near-end-avg-delay-thrs <decimal>} |
{ow-near-end-avg-dv-thrs <decimal>} |
{ow-near-end-max-delay-thrs <decimal>} |
{ow-near-end-max-dv-thrs <decimal>} |
{ow-near-end-max-delay <decimal>} |
{ow-near-end-max-dv <decimal>} |
{ow-far-end-avg-delay-thrs <decimal>} |
{ow-far-end-avg-dv-thrs <decimal>} |
{ow-far-end-max-delay-thrs <decimal>} |
{ow-far-end-max-dv-thrs <decimal>} |
{ow-far-end-max-delay <decimal>} |
{ow-far-end-max-dv <decimal>} |
{dscp <0-63>} |
{ecn <0-3>} |
{pkt-size <14-1472>} |
{vlan1-priority <0-7>} |
{src-port <decimal>} |
{dst-port <decimal>}
{dst-ip <ip-addr>}}+
Parameters:
name A name assigned to reference this instance.
state Enable or disable generating TWAMP packets.
interval Interval in milliseconds at which TWAMP
packets should be sent.
reference-period Reference period in minutes.
pkt-loss-threshold Threshold (in %) at which an Excessive Packet
Loss (EPL) alarm is declared.
continuity-check Maximum number of consecutive lost packets
allowed.
tw-max-delay Maximum two-way delay allowed.
tw-max-dv Maximum two-way delay variation allowed.
tw-max-delay-thrs Maximum consecutive two-way delay samples
allowed greater than tw-max-delay.
tw-max-dv-thrs Maximum consecutive two-way delay samples
allowed greater than tw-max-dv.
tw-avg-delay-thrs Maximum two-way average delay.
tw-avg-dv-thrs Maximum two-way average delay variation.
ow-near-end-max-delay Maximum one-way near-end delay allowed.
ow-near-end-max-dv Maximum one-way near-end delay variation
allowed.
ow-near-end-max-delay-thrs Maximum consecutive one-way near-end delay
samples allowed greater than ow-near-end-
max-delay.
Syntax:
twamp-gen edit <index>
{{name <string>} |
{state {enable | disable}} |
{interval <decimal>} |
{reference-period <decimal> } |
{pkt-loss-threshold <0-100>} |
{continuity-check <decimal>} |
{tw-avg-delay-thrs <decimal>} |
{tw-avg-dv-thrs <decimal>} |
{tw-max-delay-thrs <decimal>} |
{tw-max-dv-thrs <decimal>} |
{tw-max-delay <decimal>} |
{tw-max-dv <decimal>} |
{ow-near-end-avg-delay-thrs <decimal>} |
{ow-near-end-avg-dv-thrs <decimal>} |
{ow-near-end-max-delay-thrs <decimal>} |
{ow-near-end-max-dv-thrs <decimal>} |
{ow-near-end-max-delay <decimal>} |
{ow-near-end-max-dv <decimal>} |
{ow-far-end-avg-delay-thrs <decimal>} |
{ow-far-end-avg-dv-thrs <decimal>} |
{ow-far-end-max-delay-thrs <decimal>} |
{ow-far-end-max-dv-thrs <decimal>} |
{ow-far-end-max-delay <decimal>} |
{ow-far-end-max-dv <decimal>} |
{dscp <0-63>} |
{ecn <0-3>} |
{pkt-size <14-1472>} |
{vlan1-priority <0-7>} |
{src-port <decimal>} |
{dst-port <decimal>}
{dst-ip <ip-addr>}}+
<index> = <decimal>
Parameters:
name A name assigned to reference this instance.
state Enable or disable generating TWAMP packets.
interval Interval in milliseconds at which TWAMP
packets should be sent.
reference-period Reference period in minutes.
pkt-loss-threshold Threshold (in %) at which an Excessive Packet
Loss (EPL) alarm is declared.
continuity-check Maximum number of consecutive lost packets
allowed.
tw-max-delay Maximum two-way delay allowed.
tw-max-dv Maximum two-way delay variation allowed.
tw-max-delay-thrs Maximum consecutive two-way delay samples
allowed greater than tw-max-delay.
tw-max-dv-thrs Maximum consecutive two-way delay samples
allowed greater than tw-max-dv.
tw-avg-delay-thrs Maximum two-way average delay.
tw-avg-dv-thrs Maximum two-way average delay variation.
ow-near-end-max-delay Maximum one-way near-end delay allowed.
ow-near-end-max-dv Maximum one-way near-end delay variation
allowed.
ow-near-end-max-delay-thrs Maximum consecutive one-way near-end delay
samples allowed greater than ow-near-end-
max-delay.
ow-near-end-max-dv-thrs Maximum consecutive one-way near-end delay
samples allowed greater than ow-near-end-
max-dv.
ow-near-end-avg-delay-thrs Maximum one-way near-end average delay.
ow-near-end-avg-dv-thrs Maximum one-way near-end average delay
variation.
ow-far-end-max-delay Maximum one-way far-end delay allowed.
ow-far-end-max-dv Maximum one-way far-end delay variation
allowed.
ow-far-end-max-delay-thrs Maximum consecutive one-way far-end delay
samples allowed greater than ow-far-end-max-
delay.
ow-far-end-max-dv-thrs Maximum consecutive one-way far-end delay
samples allowed greater than ow-far-end-max-
dv.
Parameters:
index Specifies the TWAMP instance.
period-id Specifies the period id.
type Type of results to display:
Historic: History buckets results. If the number of buckets
is not specified, the last 4 buckets will be
displayed, starting from the specified period. If
no period is specified, the last 4 buckets will be
displayed.
buckets Number of TWAMP buckets to display.
period Reference period for the TWAMP history
buckets. Zero for the most recent period
available.
Syntax:
twamp show statistics
Parameters:
<user-name> <string>
4.409 Version
version - Display CLI version
Description:
Display CLI version.
Syntax:
version
Syntax:
virtual-connection edit vca <vca-name> {
{name <vca-name>} |
{vc-list <vc-name>+} }+
Parameters:
<vca-name> <string>. Unique name associated to the VCA instance.
name A new name for the VCA instance.
vc-list A comma separated list of VCE or implicit VCA containing a VCE
tunnel instances referenced by name.
tp-a-vid For VID values 1-4095, all combinations are allowed. Ex: <1-10, 15,
20-25>.
tp-a-pcp-mapping CoS profile name with the type PCP.
tp-z Defines the type of interface tp-z is connected to. The TP can be
connected to another VCE (internal) or an external port
(external).
tp-z-port Specifies the physical port when tp-z is configured as external.
tp-z-vid It is applicable when 'vid-relay-action' is set to 'translate' or 'tag'.
Only a single VID may be specified.
tp-z-pcp-mapping CoS profile name with the type PCP.
frame-type Defines the acceptable frames coming to a VCE.
vid-relay-action Usage is dependent on VCE type. Used to translate tp-a-vid to
tp-z-vid when a single VLANID is used. If a set of VIDs is
provided for 'tp-a-vid' then this parameter must be set to
'preserve'.
When 'all-to-one' is enabled and type is 'Operator' or type is
'Tunnel', the value should be 'tag'.
For all other cases, set as required.
Syntax:
y1564 edit report filename <filename> {
{description <desc>} |
{note <note>} |
{technician <tech. name>}}+
<filename> - <string> Unique filename associated with the activation.
Parameters:
description <string> Information about test being described.
note <string> Additional Information about test being described.
technician <string> Name of technician executing test.
{dst-mac-addr-overwrite {enable|disable}} |
{dst-mac-addr <mac-addr> } |
{y1731-level-overwrite {enable|disable}} |
{y1731-level <0-7>} |
{vlan1-header {enable|disable}} |
{vlan1-ethertype {c-vlan|s-vlan}} |
{vlan1-priority <0-7>} |
{vlan1-id <0-4095>} |
{vlan1-cfi <0-1>} |
{vlan2-header {enable|disable}} |
{vlan2-ethertype {c-vlan|s-vlan}} |
{vlan2-priority <0-7>} |
{vlan2-cfi <0-1>} |
{vlan2-id <0-4095>} |
{fe-vlan1-priority-check {disable | enable}} |
{fe-vlan1-dei-check {disable | enable}} |
{fe-vlan1-id-check {disable | enable}} |
{fe-vlan2-priority-check {disable | enable}} |
{fe-vlan2-dei-check {disable | enable}} |
{fe-vlan2-id-check {disable | enable}} |
{fe-dscp-check {disable | enable}} |
{fe-vlan1-priority <0-7> {disable | enable}} |
{fe-vlan1-dei <0-1> {disable | enable}} |
{fe-vlan1-id <0-4095> {disable | enable}} |
{fe-vlan2-priority <0-7> {disable | enable}} |
{fe-vlan2-dei <0-1> {disable | enable}} |
{fe-vlan2-id <0-4095> {disable | enable}} |
{fe-dscp <0-63> {disable | enable}}}+
Syntax:
y1564 edit test <test-name> {
{name <test-name>} |
{description <string>} |
{configuration {enable | disable}} |
{step-duration {1-60} |
{performance {enable | disable}} |
{test-duration {1-1440} |
{parallel {enable | disable}}
{burst-sla {enable | disable}} |
{port <port-name>} |
{delay-type {one-way-delay | two-way-delay}} |
{time-sync-mandatory {enable | disable}} |
{packet-type {layer-2| layer-3| l2-accedian| l2-generic}} |
{dst-ipv4-addr <ip-addr>} |
{destination-port <0-65535>} |
{source-port <0-65535>} |
{dscp <0-63>} |
{dst-mac-addr <mac-addr>} |
{y1731-level <0-7>}}+
Parameters:
name The name of the the test.
description Short description of the Y.1564 test.
configuration Enable Y.1564 configuration test.
step-duration Duration of each step during the configuration test in seconds.
performance Enable Y.1564 performance test.
test-duration Duration of each step during the performance test in minutes.
parallel Enable Y.1564 parallel service configuration test.
burst-sla Enable Y.1564 burst SLA test.
port Name of the port to which to send the test traffic.
delay-type Type of delay measurement.
time-sync-mandatory Enable time synchronization verification.
packet-type Used to define specific fields in the test packet.
dst-ipv4-addr The IPv4 destination address.
destination-port The destination port for UDP protocol (0 - 65535).
source-port The source port for UDP protocol (0 - 65535).
dscp The Diff-Serv CodePoint value (0 - 63).
dst-mac-addr This is the Ethernet MAC destination address.
y1731-level Y.1731 Maintenance Entity Group level (0-7).
Parameters:
filename <string> Unique filename where the report will be stored.