Professional Documents
Culture Documents
Skylight Element: LX
Version 7.9.4
Revision 1 — August 1, 2022
CLI Command Guide Skylight Element: LX Version 7.9.4
Publication Information
Skylight Element: LX 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 the LX
v7.9.4 Performance Element CLI Command Guide. It applies to the following products and
models from Accedian:
• Skylight element: LX (AMO-10000-LX-S)
1.2 Organization
This manual includes the following sections:
Skylight element: LX Command Overview
This section provides a list of all Skylight element: LX 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: LX 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.
Description:
Use this command to add a new ACL definition to the ACL service. Newly-created ACL
definitions do not contain any rules and are disabled by default.
You may edit the definition using the "acl edit list" command to add rules to it. To enable a
definition, you must assign it to an interface.
Syntax:
acl add list <acl-name>
Parameters:
<acl-name> <string>
Description:
Delete an existing interface definition from the ACL service.
Syntax:
acl delete interface <interface-name>
Parameters:
<interface-name> <string>
Description:
Delete an existing ACL list from the ACL service. The ACL list state must be set to
"Unassigned" before deleting the list.
Syntax:
acl delete list <acl-name>
Parameters:
<acl-name> <string>
Description:
Edit an existing interface definition from the ACL service. Any changes made to the interface
definition will be automatically executed and saved if valid.
ACL and Bridge:
Assigning an ACL to a sub-interface that belongs to a bridge is not supported. The ACL must
be assigned to the bridge itself.
Syntax:
acl edit interface <interface-name> {
{acl_name <acl-name>} |
{acl_types <acl-types>} |
{state {enable|disable}}
}+
Parameters:
<acl-name> <string>
<acl-types> {cli|web|snmp|netconf|icmp}
[,{cli|web|snmp|netconf|icmp}]*
acl_name The ACL name
Description:
Edit an existing ACL definition from the ACL service. Any changes made to the ACL definition
will be automatically executed and saved if valid.
Syntax:
acl edit list <acl-name> {
{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
Description:
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.
Description:
Show all ACL definitions if no ACL name is specified. If an ACL name is specified, only that
interface will be displayed.
Syntax:
acl show list [<acl-name>]
Parameters:
<acl-name> <string>
Description:
Alarm edit allows you to change the configuration of an alarm.
Syntax:
alarm edit <alarm-number> {{disable | enable} |
{service-affecting {yes | no}} |
{severity {minor | major | critical | informational}} |
Parameters:
<alarm-number> <decimal>.<decimal>.<decimal>
<description-text> <string>
description The alarm description.
disable Disable the alarm. If the alarm is triggered, nothing happens (see
the note below).
enable Enable the alarm. If the alarm is triggered, it will be reported as
defined (see the note below).
service-affecting Tag the alarm as service-affecting or not.
severity The severity level of the alarm when it is raised.
state Enable or disable the alarm. If the alarm is triggered when
enabled, it will be reported as defined. Otherwise, nothing will
happen.
NOTE: Using "disable" or "enable" as stand-alone arguments, i.e. not preceded by "state", is
deprecated. This syntax remains valid for backward compatibility, but the best practice is
to always use "state enable" and "state disable".
Description:
Enable alarm status reporting via different ways.
Syntax:
alarm reporting {{led {disable | enable}} |
{snmp {disable | enable}} |
{syslog {disable | enable}} |
{802.3ah {disable | enable}} |
{threshold-on <1-5000>} |
{threshold-off <1-15000>}}
Parameters:
led Enable the LEDs on the front panel of the unit to report the
alarms.
snmp Enable the reporting of alarms via SNMP traps.
syslog Enable the reporting of alarms via entries in the syslog.
802.3ah Enable reporting of alarms via 802.3ah OAM PDUs.
threshold-on The delay (in milliseconds) after an event is detected and before
the alarm notification occurs.
threshold-off The delay (in milliseconds) after the event status goes back to
normal and before the alarm notification clears.
Description:
Display the alarm reporting behavior.
Syntax:
alarm show configuration [<alarm-id>] [more]
Parameters:
<alarm_id> <decimal>.<decimal>.<decimal>
Description:
Display the alarm reporting parameters.
Syntax:
alarm show reporting
Description:
Display alarm status based on specified parameters. If an alarm number is specified, the
detailed status for this alarm is displayed. If no alarm number is specified, the status of all
applicable alarms is displayed in a table format. By default, only the alarms that are enabled
and active are displayed. If the option "all" is specified, the status will be displayed for all
possible alarms.
Syntax:
alarm show status [<alarm_number> | active | all | more]
Parameters:
<alarm_number> <decimal>.<decimal>.<decimal>
Description:
application edit allows selecting and managing validation on how certificates are used when
sending or receiving files through a secure channel (https or ftps). For example, firmware
upgrades and configuration import/export using the CLI.
Syntax:
application edit filetransfers {
{name <name>} |
{validate {enable | disable}} |
{client {enable | disable}}}+
Parameters:
name The common name of the certificate to be associated with the
specified application.
validate For client type applications, perform peer certificate validation.
This includes, expiration dates, hostname and CA chain.
client For client type applications, enable or disable the use of the
selected client certificate.
Description:
application edit allows selecting and managing validation on how certificates are used by the
web GUI application.
Syntax:
application edit web {{name <name>}}
Parameters:
name The common name of the certificate to be associated with the
specified application.
Description:
Shows a summary of the SSL certificates applications. All applications making possible use of
certificates are listed here.
Syntax:
application show
Description:
With bandwidth-regulator add envelope, you can create a new bandwidth regulator envelope
instance.
Syntax:
bandwidth-regulator add envelope <envelope-name> {
{ranking <regulator-name list>}
{coupling-flag <enable | disable>} }+
Parameters:
<envelope-name> <string>
ranking A comma separated list of regulator names that are part of the
envelope in order of priority. (highest to lowest)
coupling-flag Determine whether the coupling flag will be used or not for this
regulator envelope.
Description:
With bandwidth-regulator add, you can create a new bandwidth regulator instance.
Supported rate values:
- 0 to maximum port speed (steps of 125 kbps)
The burst size must be greater than the port Maximum Transfer Unit (MTU).
Syntax:
bandwidth-regulator add regulator <regulator-name> {
{cir <0-10000000>} |
{cbs <1-8000>} with cbs*1000000 >= cir-max |
{eir <0-10000000>} |
{ebs <1-8000>} with ebs*1000000 >= eir-max |
{color-mode {aware | blind}} |
{coupling-flag {true | false}}
{cir-max <0-10000000>} |
{eir-max <0-10000000>} }+
Parameters:
<regulator-name> <string>
cir Committed Information Rate in kbps.
cbs Committed Burst Size in KiB (1024 bytes).
eir Excess Information Rate in kbps.
ebs Excess Burst Size in KiB. (1024 bytes).
color-mode Determine whether the regulator is color-aware or color-blind.
coupling-flag Determine whether the coupling flag will be used or not for this
regulator.
cir-max Maximum Committed Information Rate in kbps.
eir-max Maximum Excess Information Rate in kbps.
Description:
Clear the bandwidth regulator statistics. If <regulator-name> is not specified, all bandwidth
regulators statistics will be cleared.
Syntax:
bandwidth-regulator clear regulator statistics [<regulator-name>]
Parameters:
<regulator-name> <string>
Description:
bandwidth-regulator delete envelope will delete the specified bandwidth regulator envelope
instance.
Syntax:
bandwidth-regulator delete envelope <envelope-name>
Parameters:
<envelope-name> <string>
Description:
bandwidth-regulator delete will delete the specified bandwidth regulator instance.
Syntax:
bandwidth-regulator delete regulator <regulator-name>
Parameters:
<regulator-name> <string>
Description:
With bandwidth-regulator edit envelope, you can edit an existing bandwidth regulator
envelope instance.
Syntax:
bandwidth-regulator edit envelope <envelope-name> {
{name <envelope-name>}
{ranking <regulator-name list>}
{coupling-flag <enable | disable>} }+
Parameters:
<envelope-name> <string>
name A new name for the envelope.
ranking A comma separated list of regulator names that are part of the
envelope in order of priority. (highest to lowest)
coupling-flag Determine whether the coupling flag will be used or not for this
regulator envelope.
Description:
With bandwidth-regulator edit, you can change the parameters of an existing bandwidth
regulator instance.
Supported rate values
- 0 to maximum port speed (steps of 125 kbps)
The burst size must be greater than the port Maximum Transfer Unit (MTU).
Syntax:
bandwidth-regulator edit regulator <regulator-name> {
{name <regulator-name>} |
{cir <0-10000000>} |
{cbs <1-8000>} with cbs*1000000 >= cir-max |
{eir <0-10000000>} |
{ebs <1-8000>} with ebs*1000000 >= eir-max |
{cir-max <0-10000000>} |
{eir-max <0-10000000>} }+
Parameters:
<regulator-name> <string>
Name A new name for the bandwidth regulator.
cir Committed Information Rate in kbps.
cbs Committed Burst Size in KiB (1024 bytes).
eir Excess Information Rate in kbps.
ebs Excess Burst Size in KiB (1024 bytes).
cir-max Maximum Committed Information Rate in kbps.
eir-max Maximum Excess Information Rate in kbps
Description:
Without arguments, this command displays the bandwidth-regulator envelope configuration
summary in a table format. When specifying a bandwidth-regulator envelope name, this
command displays the detailed configuration for that bandwidth-regulator envelope.
Syntax:
bandwidth-regulator show envelope configuration [<envelope-name>]
Parameters:
<envelope-name> <string>
Description:
Without arguments or with the modifier summary, this command displays the bandwidth-
regulator configuration summary in a table format. When specifying a bandwidth-regulator
name, this command displays the detailed configuration for that bandwidth-regulator.
Syntax:
bandwidth-regulator show regulator configuration [<regulator-name>]
Parameters:
<regulator-name> <string>
Description:
Display the bandwidth regulator statistics.
Syntax:
bandwidth-regulator show regulator statistics <regulator-name> {
{ type {clearable | persistent | historic}} |
{ buckets <0-16>} |
{ period <period-id>}}+
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.
Description:
Configure a beacon layer-3 instance for management purpose. A beacon may be configured to
discover remote devices by sending a special frame on the network using the IP settings
provided.
Syntax:
beacon add l3 name {<beacon-name>}
{domain-id {<domain>}} |
{state {enable|disable}} |
{rate {<transmission rate>}} |
{dst-ip {<ip-addr>}} |
{use-interface {enable|disable}} |
{interface {<interface name>}} |
{use-relay-ip {enable|disable}} |
{relay-ip {<ip-addr>}} |
{relay-dst-subnet {<ip-addr>}} |
{ip-config-mode {local|auto|dhcp|auto-static}} |
{subnet {<ip-addr>}} |
{netmask {<ip-addr>}} |
{gateway {<ip-addr>}} |
{ip-exclusion {<ip-addr1, ip-addr2, ...>}} |
{dhcp-hostname-option <none,custom,serial-number,current>} |
{dhcp-client-id-option <none,custom,serial-number>} |
{dhcp-hostname <hostname>} |
{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 uses 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.
Description:
Delete an existing beacon layer-3 instance.
Syntax:
beacon delete l3 <beacon-name>
Parameters:
<beacon-name> The name of the beacon instance to delete.
Description:
Configure a beacon layer-3 instance for management purpose. A beacon may be configured to
discover remote devices by sending a special frame on the network using the IP settings
provided.
Syntax:
beacon edit l3 <beacon-name>
{name {<beacon-name>}} |
{domain-id {<domain>}} |
{state {enable|disable}} |
{rate {<transmission rate>}} |
{dst-ip {<ip-addr>}} |
{use-interface {enable|disable}} |
{interface {<interface name>}} |
{use-relay-ip {enable|disable}} |
{relay-ip {<ip-addr>}} |
{relay-dst-subnet {<ip-addr>}} |
{ip-config-mode {local|auto|dhcp|auto-static}} |
{subnet {<ip-addr>}} |
{netmask {<ip-addr>}} |
{gateway {<ip-addr>}} |
{ip-exclusion {<ip-addr1, ip-addr2, ...>}} |
{dhcp-hostname-option <none,custom,serial-number,current>} |
{dhcp-client-id-option <none,custom,serial-number>} |
{dhcp-hostname <hostname>} |
{dhcp-client-id <client-id>} |
{id-mismatch {enable|disable} |
{adv-ip {<ip-addr>}} }}+
Parameters:
<beacon-name> The name of the beacon instance to edit.
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 uses 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
Description:
Immediately sends one beacon layer-3 frame based on the configuration of the chosen beacon
instance.
Syntax:
beacon send l3 one-shot <beacon-name>
Parameters:
<beacon-name> The name of the beacon instance configuration to use for
sending the one frame. The beacon-name must refer to an
existing instance and the instance must be enabled.
Description:
Specifying a beacon name provides detailed configuration about this beacon, otherwise the
command provides a summary of configurations for all beacons.
Syntax:
beacon show l3 configuration [<beacon-name>]
Parameters:
<beacon-name> The name of the beacon instance to show.
Description:
Display the CPU usage over a period of time. Available periods are:
- Last second
- Last completed 15 seconds period average
- Last completed 30 seconds period average
- Last completed 60 seconds period average
- Last completed 5 minutes period average
Syntax:
board show cpu
Description:
Displays unit board information: MAC base address, unit identifier, firmware version,
assembly, and serial number. Also displays sub-assembly information, if any.
Syntax:
board show info
Description:
Display the system start time in the following format:
Thu Jan 1 00:00:00 UTC 1970
Syntax:
board show start-time
Description:
Display information about power supplies and the temperature sensor.
Syntax:
board show status
Description:
Display the system uptime in the following format: up xx days, HH:MM
Syntax:
board show uptime
Description:
Display the system uptime in the following format: up xx seconds
Syntax:
board show uptime-seconds
Description:
For a specific bridge name, this command clears all statistics.
Syntax:
bridge clear statistics [<bridge-name>]
Parameters:
<bridge-name> <string>
Description:
With bridge edit, you can change the parameters of an existing bridge instance.
Syntax:
bridge edit <bridge-name> {
{aging-time <decimal>} |
{forward-delay <decimal>} |
{hello-time <decimal>} |
{path-cost <sub-intf> <decimal>} |
{port-priority <sub-intf> <decimal>} |
{priority <decimal>} |
{protocol {stp | rstp}} |
{mac-addr {bridge-ga | provider-bridge-ga}} |
{message-max-age <decimal>} }+
Parameters:
<bridge-name> <string>
aging-time Bridge aging time can vary from 30 to 600 seconds.
forward-delay Forward time can vary from 4 to 30 seconds.
hello-time Hello time can vary from 1 to 2 seconds.
path-cost Path cost of the port can vary from 1 to 200 Million.
port-priority Port priority, value must be between 16 and 240. in steps of 16
priority Bridge priority, value must be between 4096 and 61440, in steps
of 4096.
protocol Configure STP or RSTP.
mac-addr Destination MAC address used to transmit BPDU. Can be the
Bridge Group Address or the Provider Bridge Group address.
message-max-age Maximum message age can vary from 6 to 40 seconds.
Description:
Without arguments, this command displays a configuration summary for all bridges in a table
format. With a specific bridge name argument, this command displays the detailed
configuration information for that specific bridge.
Syntax:
bridge show configuration [<bridge-name>]
Parameters:
<bridge-name> <string>
Description:
For a specific bridge name, this command displays all statistics.
Syntax:
bridge show statistics [<bridge-name>]
Parameters:
<bridge-name> <string>
Description:
Without arguments, this command displays a status summary for all bridges in a table format.
With a specific bridge name argument, this command displays the detailed status information
for that specific bridge.
Syntax:
bridge show status [<bridge-name>]
Parameters:
<bridge-name> <string>
Description:
Perform time domain reflectometry diagnostics for a copper port.
Syntax:
cable-test perform [<connector-name> | <port-name>]
Description:
Show cable diagnostics information
Syntax:
cable-test show [<connector-name> | <port-name>]
Description:
certificate delete allows you to remove a SSL certificate present in the unit.
Syntax:
certificate delete {name}
Parameters:
name The common name of the certificate to be removed.
Description:
certificate import allows you to download and activate a SSL certificate from a remote server
through ftp, ftps, http, https, or tftp protocol.
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.
Description:
Shows a summary of the SSL certificates present in the unit if no name is specified. If a
common name is specified, the certificate contents are displayed.
Syntax:
certificate show {[name]}
Parameters:
name The common name of the certificate to be displayed.
Description:
Create delay measurement for a MEP.
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.
Description:
Create a Maintenance Domain. A Maintenance Domain defines a level and a name for a
network or part of a network for which faults in connectivity are to be managed. A
Maintenance Domain is required to create a MA with CCM MAID that includes the
Maintenance Domain name.
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.
Description:
Create a Maintenance Association. A Maintenance Association defines a set of MEPs, each
configured with the same MAID and MD Level, established to verify the integrity of a single
service instance. An MA can also be thought of as a full mesh of Maintenance Entities among
a set of MEPs configured.
Syntax:
cfm add ma {
{name <string> } |
{index <decimal>} |
{md-idx <decimal>} |
{md-name <string>} |
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.
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
Controls the behaviour of the generation of CCM PDUs using
Character-String (2) format with MD Name not present (1).
Valid values are:
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.
Description:
Create Y.1731 MEG.
Syntax:
cfm add meg {
{name <string> } |
{name-format <icc-based | string> } |
{index <decimal>} |
{level <0-7> } |
{ccm-interval <decimal> } |
{vce <vce-name>} |
{component <component-id>} |
{vlan-type {c-vlan | s-vlan | t-vlan | none}} |
{vid-list {<1-4094> [, <1-4094>]+}} |
Parameters:
name MEG name. The name should include the ICC and UMC in a single
string, as specified in Y.1731.
name-format MEG name format. The valid values are:
icc-based: ITU Carrier Code format (Y.1731).
string: RFC-2579 Display String.
index A free maintenance association index. If the index is omitted a
free index is allocated automatically.
level Maintenance Level given to this MEG.
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 MEG. If the value
"none" is specified, the MEG is not attached to a VLAN and the
contents of the VLAN ID list are ignored.
vid-list A comma-separated list of VLAN ID values. If the VLAN ID list is
left empty, the MEG is not attached to a VLAN and the VLAN
type is set to none 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.
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
Description:
Create Maintenance association End Point.
Syntax:
cfm add mep {{ma-idx <decimal> } |
{ma-name <string> } |
{meg-idx <decimal> } |
{meg-name <string> } |
{meg-name-format <icc-based | string> }} {
{index <decimal>} | {mep-id <1-8191> } |
{name <string>} |
{direction <up | down> } |
{port <port-name> } |
{vce <vce-name>} |
{tp <tp-a | tp-z>} |
{pvid <0-4094> } |
{active <yes | no> } |
{cci-enable <yes | no> } |
{ccm-seq-number <enable | disable> } |
{csf-enable <yes | no> } |
{priority <0-7> } |
{lowest-alarm-pri <lowest-alarm-pri-choice>} |
{fng-alarm-time <decimal> } |
{fng-reset-time <decimal> } |
Parameters:
meg-idx MEG index. Identifies the MEG that MEP belongs to.
Cannot be used in conjunction with meg-name, meg-name-
format, ma-idx and ma-name.
meg-name MEG name. Identifies the MEG that MEP belongs to by name.
Cannot be used in conjunction with meg-idx, ma-idx and ma-
name.
meg-name-format MEG name format. Cannot be used in conjunction with meg-idx,
ma-idx and ma-name.
index A free MEP index. If the index is omitted, a free index is allocated
automatically. This should not be confused with the MEPID
specified using mep-id.
ma-idx Maintenance Association index. Identifies the Maintenance
Association to which this MEP belongs. Cannot be used in
conjunction with meg-idx, meg-name, meg-name-format and
ma-name.
ma-name Maintenance Association name. Identifies the Maintenance
Association to which this MEP belongs by name. Cannot be used
in conjunction with meg-idx, meg-name, meg-name-format and
ma-idx.
mep-id MEP identifier <1-8191>.
name A name assigned to reference this instance.
direction Direction, up or down.
port Indicates the port used by this MEP.
vce Indicates the VCE used by this MEP. The terminination point
must also be specified if VCE is used. Cannot be used in
conjunction with port.
tp Indicated the termination point of the VCE.
pvid Primary VLAN ID <0-4094>.
active Indicates the administrative state of the MEP. "yes" indicates that
the MEP is to function normally, and "no" 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.
Description:
Create packet loss measurement for a MEP. Packet loss measurements are based on Remote
MEP CCM sequence number. Remote MEP should have CCM sequence number generation
enabled to perform packet loss measurements.
Syntax:
cfm add pkt-loss {
{mep-idx <mep-index>} |
{index <decimal>} |
{rmep-id <1-8191>} |
{enable {yes | no}} |
{reference-period <decimal> } |
{threshold <decimal>} |
{threshold-ratio <decimal>} }+
<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.
reference-period Packet loss reference period in minutes.
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.
Description:
Creates an SLM instance.
Syntax:
cfm add slm mep-idx <decimal> rmep-id <decimal> {{index <decimal>}
{name <string>}
{priority <decimal>}
{reporting-period <decimal>}
{interval <decimal>}
{state <enable| disable>}
{near-end-threshold <decimal>}
{far-end-threshold <decimal>}
}+
Parameters:
index The SLM instance index.
name A unique name to identify an SLM instance.
mep-idx The local MEP index.
rmep-id The remote MEP ID.
priority The priority of the SLM frames.
interval The SLM frames transmission rate.
state The state of the instance (disabled by default).
Description:
Assign an existing interface to CFM to be used to define the outer tag in a Q-in-Q CFM frame.
Syntax:
cfm assign interface { <name> }
Parameters:
Name The interface name to be associated with CFM.
Description:
Clear individual MEP statistics.
Syntax:
cfm clear mep statistics <mep-index>|<name>
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies a MEP.
<name> Identifies a MEP by name.
Description:
Clear continuous packet loss measurement results. Periodic and historical measurement
results are not affected.
Syntax:
cfm clear pkt-loss result [<pl-index> | <name>]
<pl-index> = <decimal>
<name> = <string>
Parameters:
<pl-index> Specifies the packet loss instance.
<name> Specifies the packet loss instance by name.
Description:
Clear slm results.
Syntax:
cfm clear slm result <identifier>
Parameters:
<identifier> A unique name to identify an instance of SLM or the SLM index.
Description:
Clear global CFM statistics. This does not affect individual MEP statistics.
Syntax:
cfm clear statistics
Description:
Clear VSP results.
Syntax:
cfm clear vsp result [<identifier>]
<identifier> = <decimal>
Parameters:
<identifier> An optional unique index identifying the instance.
Description:
Delete a delay measurement instance.
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.
Description:
Delete a Maintenance Domain. When a Maintenance Domain is deleted, all the objects (MAs,
MEPs, DMMs, and Packet Loss instances) inside that Maintenance Domain are deleted.
Pseudo Maintenance Domains "Y.1731 level 0" to "Y.1731 level 7" cannot be deleted.
Syntax:
cfm delete domain <md-index>
<md-index> = <decimal>
Parameters:
<md-index> Identifies the Maintenance Domain to delete.
Description:
Delete a Maintenance Association (MA). When an MA is deleted, all the objects (MEP, DMM,
and Packet Loss instances) inside that MA are deleted.
Syntax:
cfm delete ma <ma-index>
<ma-index> = <decimal>
Parameters:
<ma-index> Identifies the Maintenance Association to delete.
Description:
Delete a MEG. When a MEG is deleted, all the objects (MEP, DMM, and Packet Loss instances)
inside that MEG are deleted.
Syntax:
cfm delete meg <meg-index>
<meg-index> = <decimal>
Parameters:
<meg-index> Identifies the MEG to delete.
Description:
Delete a Maintenance association End Point. When a MEP is deleted, all the objects (DMM and
Packet Loss instances) inside that MEP are deleted.
Syntax:
cfm delete mep <mep-index>|<name>
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies the MEP to delete.
<name> Identifies the MEP to delete by name.
Description:
Delete a Packet Loss measurement instance.
Syntax:
cfm delete pkt-loss <pl-index>|<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.
Description:
Delete an SLM instance.
Syntax:
cfm delete slm <identifier>
Parameters:
<identifier> A unique identifier for the SLM instance or SLM index.
Description:
The MHF default parameters control the MHF creation for VIDs that are not attached to an
MA within a VLAN component. For each component port, a VID is attached to an MA at a
specific MD level, if at this level a MEP exists on that port or if an Up MEP exists on another
port.
For a given VID, the default MHF MD level plus the set of Maintenance Associations that
include that VID define the VID's active MD levels. The MD level at which MHFs could be
created on a port for a given VID is the VID's lowest active MD level that is higher than any
MEP configured on that port.
If at this level the VID is attached to an MA, the MA parameters control the MHF creation.
Otherwise, the MHF default parameters control the MHF creation.
Syntax:
cfm edit defaults {{vce <vce-name>} | {component <component-id>}}
{
{level <0-7>} |
{mhf-creation <none | default | explicit>} |
{sndr-id-perm <none | chassis | manage | chassis-manage>}}
Parameters:
<vce-name> <string>
<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.
Description:
Modify default MAID string-based format mode of MEG string-based instances. This value is
used to control the default value when creating a new MA/MEG.
Syntax:
cfm edit default-maid-string-format-mode {normal | legacy}
Description:
Modify a delay measurement instance.
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>} |
<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.
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.
Description:
Controls the behaviour of the generation of DMM PDUs. When enabled, the Test ID TLV
will be included in the DMM PDUs as well as it will be decoded and used to associate the
DMR PDUs to the DMM object.
Syntax:
cfm edit dmm-test-id-tlv {enable | disable}
Parameters:
Error DMM test ID TLV cannot be modified if any DMM instances exist.
Description:
Edit a Maintenance Domain. Once created, only the sender ID permissions can be modified.
Syntax:
cfm edit domain <md-index>
{mhf-creation <none | default | explicit>} |
{sndr-id-perm {none | chassis | manage | chassis-manage>}}+
<md-index> = <decimal>
Parameters:
<md-index> Maintenance Domain index.
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.
Description:
Modify Maintenance Association attributes.
Syntax:
cfm edit ma <ma-index> {
{ccm-interval <decimal> } |
{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}}}+
<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
Controls the behaviour of the generation of CCM PDUs using
Character-String (2) format with MD Name not present (1).
Valid values are:
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.
Description:
Modify Y.1731 MEG attributes.
Syntax:
cfm edit meg <meg-index> {
{ccm-interval <decimal>} |
{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}}}+
<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.
defer: Use the Maintenance Domain parameter to determine how MHFs
are created.
Description:
Modify a Maintenance association End Point.
Syntax:
cfm edit mep <mep-index> | <name> {
{pvid <0-4094> } |
{active <yes | no> } |
{cci-enable <yes | no> } |
{csf-enable <yes | no> } |
{ccm-seq-number <enable | disable> } |
{name <string> } |
{priority <0-7> } |
{lowest-alarm-pri <lowest-alarm-pri-choice>} |
{fng-alarm-time <decimal> } |
{fng-reset-time <decimal> } |
{fault-propagation <enable | disable> } |
{fp-port <port-name> }
{interface-status-tlv <enable | disable> } }+
<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.
If you are enabling CSF on a port that supports media selection,
you must set the media-selection option to Manual.
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.
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.
Description:
Modify a packet loss measurement instance. Packet loss measurements are based on Remote
MEP CCM sequence number. Remote MEP should have CCM sequence number generation
enabled to perform packet loss measurements.
Syntax:
cfm edit pkt-loss <pl-index>|<name> {
{enable {yes | no} } |
{reference-period <decimal> } |
{name <string> } |
{threshold <decimal>} |
{threshold-ratio <decimal>} }+
<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.
Description:
Edit an SLM instance.
Syntax:
cfm edit slm <identifier>
{{name <string>} |
{reference-period <decimal>} |
{state <enable | disable>} |
{near-end-threshold <decimal>} |
{far-end-threshold <decimal>} |
{interval <decimal>}}+
Parameters:
<identifier> A unique identifier for the SLM instance or SLM index.
name A unique name to identify an SLM instance.
state The state of the instance (Disabled by default).
reference-period A reference period over which periodic counters are evaluated in
addition to the monotonic counters.
near-end- threshold The near-end frame loss threshold. (1 = 0.000001%)
far-end- threshold The far-end frame loss threshold. (1 = 0.000001%)
interval The SLM frames transmission rate.
Description:
Edit the VSP configuration.
Syntax:
cfm edit vsp {{meg-level <decimal | all>} |
{state <enable | disable>}}+
Parameters:
state The state of the instance (disabled by default).
meg-level The MEG level used.
Description:
Initiate a CFM loopback request from a MEP. The MEP is specified by MEP index or by MEP
name. The target address is identified by MAC address or by remote MEPID. When identifying
the target by remote MEPID, the remote MEP MAC address should be resolved into the
remote MEP database. Otherwise, an invalid state error will be returned.
If the parameters "rmep-id" and "dst-mac-addr" are omitted, a single multicast LBM is sent
without Data TLV. The command waits five seconds for responses and displays the address of
each responder. Otherwise, the loopback is initiated and the command completes
immediately. In the latter case, if the parameter "data" or "data-length" is provided, the LBM
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.
Description:
Initiate a CFM link trace request from a MEP. The MEP is specified by MEP index or by MEP
name. The target address is identified by MAC address or by remote MEPID. When identifying
the target by remote MEPID, the remote MEP MAC address should be resolved into the
remote MEP database. Otherwise, an invalid state error will be returned.
In verbose mode, the command waits a few seconds to display replies before completing. In
non-verbose mode, the command completes immediately and returns a link trace transaction
identifier. In both cases, the link trace transaction identifier allows displaying results from
recent link traces using the "cfm show ltr" command.
Syntax:
cfm ltm {{mep-idx <mep-index> | mep-name <name>}
{{rmep-id <1-8191>} |
{dst-mac-addr <mac-addr>}} |
{ttl <1-255>} |
{fdb-only <yes | no> } |
{verbose <yes | no>} }+
<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.
Description:
The MHF default parameters control the MHF creation for VIDs that are not attached to a
Maintenance Association within a VLAN component. For each component port, a VID is
attached to an MA at a specific MD level, if at this level a MEP exists on that port or if an Up
MEP exists on another port.
For a given VID, the default MHF MD level plus the set of Maintenance Associations that
include that VID define the VID's active MD levels. The MD level at which MHFs could be
created on a port for a given VID is the VID's lowest active MD level that is higher than any
MEP configured on that port.
If at this level the VID is attached to an MA, the MA parameters control the MHF creation.
Otherwise, the MHF default parameters control the MHF creation.
Syntax:
cfm show defaults [{vce <vce-name>} | {component <component-id>}]
Parameters:
<vce-name> <string>
<component-id> <decimal>
Description:
Show default MAID string-based format mode value
Syntax:
cfm show default-maid-string-format-mode
Description:
Display a summary of the configured DMM instances. When an instance identifier is specified,
a detailed configuration report is displayed.
Syntax:
cfm show dmm configuration [<dmm-index> | <name>]
Parameters:
<dmm-index> <decimal> Identifies a delay measurement instance.
<name> <string> Identifies a delay measurement instance by name.
Description:
Display delay measurements results.
Syntax:
cfm show dmm result [ [<dmm-index> | <name>] {
{ type {historic}} |
{ buckets <0-16>} |
{ period <period-id>}}+ ]
<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.
Description:
Show DMM Test ID TLV state.
Syntax:
cfm show dmm-test-id-tlv {enable | disable}
Description:
Display a summary of the configured Maintenance Domain instances. When a domain index is
specified, a detailed configuration report is displayed.
Syntax:
cfm show domain configuration [<md-index>]
<md-index> = <decimal>
Parameters:
<md-index> Identifies a Maintenance Domain.
Description:
Display the list of interfaces assigned to CFM.
Syntax:
cfm show interface <interface-index>
Parameters:
<interface-index> An optional CFM interface index to display.
Description:
Display data about latest CFM PDU discarded. A CFM PDU can be discarded if it is malformed
or if no maintenance point is associated to it.
Syntax:
cfm show latest error [ detailed ]
Parameters:
detailed Shows detailed PDU information.
Description:
Show link trace responses associated with a recent link trace request.
Syntax:
cfm show ltr {mep-idx <mep-index> | mep-name <name>} [ltm-id <decimal>]
<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.
Description:
Display a summary of the configured Maintenance Association instances. If an instance index
is specified, a detailed configuration report is displayed.
Syntax:
cfm show ma configuration [<ma-index>]
<ma-index> = <decimal>
Parameters:
<ma-index> Identifies a Maintenance Association.
Description:
Display a summary MAID string format mode of the configured MEG instances. If an instance
index or an instance name along with an instance name format are specified, a detailed
configuration report is displayed.
Syntax:
cfm show ma-maid-string-format-mode [ma-idx]
<ma-index> = <decimal>
Parameters:
<ma-index> - Identifies a Maintenance Association.
Description:
Display a summary of the configured MEG instances. If an instance index is specified, a
detailed configuration report is displayed.
Syntax:
cfm show meg configuration [<meg-index>]
<meg-index> = <decimal>
Parameters:
<meg-index> Identifies a MEG.
Description:
Display a summary of the configured MEP instances. If an instance identifier is specified, a
detailed configuration report is displayed.
Syntax:
cfm show mep configuration [<mep-index> | <name>]
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies a MEP.
<name> Identifies a MEP instance by name.
Description:
Display a MEP database summary. If an remote MEPID is specified, a detailed report is
displayed.
Syntax:
cfm show mep database <mep-index> | <name> [rmep-id <1-8191>]
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies a MEP.
<name> Identifies a MEP instance by name.
rmep-id Identifies a remote MEPID.
Description:
Display a summary of MEP statistics. If an instance identifier is specified, a detailed statistics
report is displayed.
Syntax:
cfm show mep statistics [<mep-index> | <name>]
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies a MEP.
<name> Identifies a MEP instance by name.
Description:
Display a summary of MEP status. If an instance identifier is specified, a detailed status report
is displayed.
Syntax:
cfm show mep status [<mep-index> | <name>]
<mep-index> = <decimal>
<name> = <string>
Parameters:
<mep-index> Identifies a MEP.
<name> Identifies a MEP instance by name.
Description:
Display a summary of the configured packet loss instances. If an instance identifier is specified,
a detailed configuration report is displayed.
Syntax:
cfm show pkt-loss configuration [<pl-index> | <name>]
<pl-index> = <decimal>
<name> = <string>
Parameters:
<pl-index> Identifies a packet loss instance.
<name> Identifies a packet loss instance by name.
Description:
Display Lacket Loss measurement results.
Syntax:
cfm show pkt-loss result [ [<pl-index> | <name>] {
{ type {historic}} |
{ buckets <0-16>} |
{ period <period-id>}}+ ]
<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
Description:
Display SLM configuration. If an instance identifier is specified, a detailed configuration report
is displayed for the specified instance. Otherwise, a configuration summary for all instances is
displayed.
Syntax:
cfm show slm configuration [<identifier>]
<identifier> = <string | decimal>
Parameters:
<identifier> An optional instance name or index to display.
Description:
Display SLM counters. If an instance name or index is specified, detailed counters are
displayed for the specified instance. Otherwise, a summary of all available counters for all
instances are displayed.
Syntax:
cfm show slm result [<identifier> [type {continuous | periodic|
historic} {bucket | period} <decimal>]]
Parameters:
<identifier> An optional instance name or index to display.
type Type of statistics to display.
historic: history buckets statistics.
Description:
Display the CFM stack summary information.
Syntax:
cfm show stack
Description:
Display global CFM statistics.
Syntax:
cfm show statistics
Description:
Display VSP configuration.
Syntax:
cfm show vsp configuration
Description:
Display VSP results.
Syntax:
cfm show vsp result
Description:
Stops all active CFM loopback request.
Syntax:
cfm stop lbm
Description:
This command removes the association between an interface and CFM. It does not delete the
interface itself.
Syntax:
cfm unassign interface { <name> }
Parameters:
name The interface name to be disassociated with CFM.
Description:
Use to enable or disable CLI Logger state. Optional keyword "force" can be used to prevent
interactive prompt
Syntax:
clilog edit { state { <enable | disable> [ force ] } }
Description:
Show current configuration of CLI Logger.
Syntax:
clilog show configuration
Description:
Show all logged commands of CLI Logger.
Syntax:
clilog show log
Description:
The configuration cancel command allows you to cancel the latest request to roll back or to
reset the current configuration to factory defaults.
Syntax:
configuration cancel
Description:
The configuration changes command allows you to see the number of configuration changes
that took place since the system is up.
Syntax:
configuration changes
Description:
The configuration command allows you to export the existing unit configuration to a file. This
command also allows exporting from the screen. Typing "configuration export" without any
parameters will dump the configuration file to the stdout.
Syntax:
configuration {export}
[{ ftp | ftps |
scp | sftp | tftp }://[<user-name>:<password>@]<url>]
Examples:
configuration export ftp://username:password@mypc.com/newconfig.cfg
configuration export ftps://username:password@mypc.com:990/newconfig.cfg
configuration export sftp://username:password@mypc.com:22/newconfig.cfg
configuration export scp://username:password@mypc.com:22/newconfig.cfg
Parameters:
<user-name> <string>
<password> <string>
Description:
The configuration command allows you to export the existing unit configuration in a CLI-
importable format either on screen or to an external server.
Syntax:
configuration generate-script
{module <cli-cmd-names> }
{export-to-server [{ ftp | ftps | http |
https | sftp | tftp }
://[<user-name>:<password>@]<url>]}
<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
Description:
The configuration import command allows to import a configuration file that was previously
exported from the same type of unit.
This command also allows importing a configuration file from stdin.
This is useful when a TFTP, FTP or HTTP server is not available for hosting.
Syntax:
configuration import
{http | tftp | ftp | sftp}://[<user-name>:<password>@]<url>
Examples:
configuration import http://mypc.com/newconfig.cfg
configuration import ftp://username:password@mypc.com/newconfig.cfg
Parameters:
<user-name> <string>
<password> <string>
Description:
The configuration reset command allows you to reset your current configuration to the
factory default settings.
Syntax:
configuration reset
Description:
The configuration rollback command allows you to reset your current configuration to the
same state as the last time it was booted.
Syntax:
configuration rollback
Description:
Disable CLI on the serial console.
Syntax:
console disable
Description:
Enable CLI on the serial console.
Syntax:
console enable
Description:
Show serial console configuration.
Syntax:
console show
Description:
This command allows to configure port CoS mappings. When EVC mapping performs an
action on two VLAN tags, this mapping determines the PCP of the egress frame outer tag
based on internal CoS and color assigned at ingress classification.
Syntax:
cos-pcp-map edit <port-name> { {encode-dei {enable | disable}} |
{green-cos <cos-pcp-map-list>} |
{yellow-cos <cos-pcp-map-list>} }+
<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.
Description:
This command allows to display port CoS mappings for one port.
Syntax:
cos-pcp-map show configuration <port-name>
Parameters:
<port-name> <string>
Description:
With these commands, you can create a new DSCP CoS profile or change the parameters of an
existing DSCP CoS profile.
Syntax:
cos-profile {add|edit} dscp <cos-profile-name> {
{name <cos-profile-name>} |
{encode-dei {enable | disable} } |
{input-list {<0-63> [,|- <0-63>]}+ } |
{pre-marking {green | yellow} } |
{green-out <0-7> } |
{yellow-out <0-7> } |
{default-pre-marking {green | yellow} } |
{default-green-out <0-7> } |
{default-yellow-out <0-7> }}+
Parameters:
<cos-profile-name> <string>
name New name when editing an exiting profile.
encode-dei Set DEI bit to 1 if the outgoing frame color is yellow.
input-list A comma-separated list of DSCP or DSCP range (x-y) values.
pre-marking Pre-marking color to be applied to frames if the input DSCP is in
input-list.
green-out PCP value to be used if the outgoing frame color is green and the
input DSCP is in input-list.
yellow-out PCP value to be used if the outgoing frame color is yellow and
the input DSCP is in input-list.
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.
NOTE: If input-list is omitted, the default-* parameters interpret the input-list as a 0-63
range.
Description:
With these commands, you can create a new PCP CoS profile or change the parameters of an
existing PCP CoS profile.
Syntax:
cos-profile {add|edit} pcp <cos-profile-name> {
{name <cos-profile-name>} |
{decode-dei {enable | disable} } |
{encode-dei {enable | disable} } |
{input-list {<0-7> [,|- <0-7>]}+ } |
{pre-marking {green | yellow} } |
{green-out <0-7> } |
{yellow-out <0-7> } |
{default-pre-marking {green | yellow} } |
{default-green-out <0-7> } |
{default-yellow-out <0-7> }}+
Parameters:
<cos-profile-name> <string>
name New name when editing an existing profile.
decode-dei Use incoming DEI as a pre-marking color (0=green, 1=yellow).
encode-dei Set DEI bit to 1 if the outgoing frame color is yellow.
NOTE: If input-list is omitted, the default-* parameters interpret the input-list as a 0-7
range.
Description:
With these commands, you can create a new IP precedence CoS profile or change the
parameters of an existing IP precedence CoS profile.
Syntax:
cos-profile {add|edit} precedence <cos-profile-name> {
{name <cos-profile-name>} |
{encode-dei {enable | disable} } |
{input-list {<0-7> [,|- <0-7>]}+ } |
{pre-marking {green | yellow} } |
{green-out <0-7> } |
{yellow-out <0-7> } |
{default-pre-marking {green | yellow} } |
{default-green-out <0-7> } |
{default-yellow-out <0-7> }}+
Parameters:
<cos-profile-name> <string>
name New name when editing an existing profile.
NOTE: If input-list is omitted, the default-* parameters interpret the input-list as a 0-7
range.
Description:
Delete the specified CoS profile.
Syntax:
cos-profile delete <cos-profile-name>
Parameters:
<cos-profile-name> <string>
Description:
Displays CoS profile configuration. Specifying a profile name will display a detailed
configuration for this profile. Otherwise, a configuration summary for all CoS profiles will be
displayed.
Syntax:
cos-profile show configuration [<cos-profile-name>]
Parameters:
<cos-profile-name> <string>
Description:
The CPU OAM options modify the criterion used to submit various frames to the CPU for
processing. These options are configurable per port.
Syntax:
cpu edit oam-options <port-name>
{mgmt-mode {auto|mac-oui|policy}}
<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.
Description:
Shows the configuration of CPU OAM options. The CPU OAM options modify the criterion
used to submit various frames to the CPU for processing. These options are configurable per
port.
Syntax:
cpu show oam-options [<port-name>]
<port-name> = <string>
Parameters:
<port-name> A system port name.
4.128 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.
Description:
The dhcp-relay edit is used to modify the DHCP-relay configuration.
Syntax:
dhcp-relay edit { {state <enable|disable>} |
{server1 <ip-addr>} |
{server2 <ip-addr>} }+
Parameters:
state The state of DHCP relaying.
server1 The first DHCP server address.
server2 The second DHCP server address.
Description:
The dhcp-relay show configuration command displays the DHCP-relay configuration.
Syntax:
dhcp-relay show configuration
Description:
dns edit allows you to choose the server and the interface to use for the DNS service.
Syntax:
dns edit [ {dhcp {enable <interface-name> | disable}} |
{dhcp6 {enable <interface-name> | disable}} |
{domain <string>} |
{hostname <string>} |
{dhcp-hostname <string>} |
{dhcp-hostname-option <custom|serial-number|current>}
{dhcp-client-id <string>} |
{server1 <ip-addr|ipv6-addr>} |
{server2 <ip-addr|ipv6-addr>} ]+
Parameters:
<interface-name> <string>
dhcp Enable/disable use of DNS settings obtained via DHCP.
<interface-name> specifies the interface to use for obtaining
DHCP information.
dhcp6 Enable/disable use of DNS settings obtained via DHCPv6.
<interface-name> specifies the interface to use for obtaining
DHCP information.
domain The domain name associated with the DNS.
hostname The name of the unit.
dhcp-client-id The DHCP client identifier (option 61). An empty string forces
MAC address as client ID.
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.
Description:
Show the DNS configuration. The "Domain", "DNS server 1" and "DNS server 2" fields are only
used if "Use DHCP result" is set to Disabled.
Syntax:
dns show
Description:
With dry-contact-input edit, you can change the parameters of one of the available dry-
contact input.
Syntax:
dry-contact-input edit <id> {
{state {enable|disable}} |
{normal-state {close|open}} |
{sampling-period <100-1000>} }+
Parameters:
<id> <decimal>
state Enable/disable the use of the dry-contact input. When enabled,
the alarm point for this input are created and the input is
monitored according to the following monitoring configurations.
normal-state Selects the normal state of the input. An alarm is raised, when
the input state is different from the normal state for more than 3
consecutives samples. The input sampling rate is determined by
the value of the input sampling period.
sampling-period Determines the time, in milliseconds, between two consecutive
readings of the input state. The values must be specified within
the range of 100 and 1000 milliseconds in steps of 100
milliseconds.
Description:
Display all configuration parameters of the available dry-contact input.
Syntax:
dry-contact-input show configuration
Description:
Display status of the available dry-contact input.
Syntax:
dry-contact-input show status
Description:
Create an Ethernet Ring Protection.
Syntax:
erp add <name> {
{aps-vid <1-4095>} |
{guard <decimal>} |
{hold-off <decimal>} |
{index <decimal>} |
{lag <string>} |
{level {0-7}} |
{mep0-idx <decimal>} |
{mep0-identifier <string> |
{mep1-identifier <string>} |
{port0 <string>} |
{port1 <string>} |
{revertive {yes | no}} |
{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.
Description:
Sends a clear command to an ERP instance.
Syntax:
erp clear command <identifier>
Parameters:
identifier The ERP index or name.
Description:
Clear statistics of an ERP instance.
Syntax:
erp clear statistics <identifier>
Parameters:
identifier The ERP index or name.
Description:
Delete an Ethernet Ring Protection.
Syntax:
erp delete <identifier>
Parameters:
identifier The ERP name or index.
Description:
Edit an Ethernet Ring Protection.
Syntax:
erp edit {
{guard <decimal>} |
{hold-off <decimal>} |
{mep0-identifier <string> |
{mep1-identifier <string>} |
{name <string>} |
{revertive {yes | no}} |
{rpl-port <string>} |
{rpl-role <string>} |
{version <decimal>} |
{vid-list <string>} |
{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.
Description:
Remove all learned MAC addresses from the filtering database.
Syntax:
erp flush-fdb
Description:
Forced switching of a ring port.
Syntax:
erp force-switch <identifier> port <string>
Parameters:
identifier The ERP name or index
port The port to block.
Description:
Manual switching of a ring port.
Syntax:
erp manual-switch <identifier> port <string>
Parameters:
identifier The ERP name or index
port The port to block.
Description:
Shows the configuration of ERP instances.
Syntax:
erp show configuration [<identifier>]
Parameters:
identifier The ERP name or index
Description:
Shows the statistics of ERP instances.
Syntax:
erp show statistics [<identifier>]
Parameters:
identifier The ERP name or index
Description:
Shows the status of ERP instances.
Syntax:
erp show status [<identifier>]
Parameters:
identifier The ERP name or index
Description:
Shows the vlan-fdb of ERP instances.
Syntax:
erp show vlan-fdb <identifier>
Parameters:
identifier The ERP name or index
4.148 Exit/Quit
exit - Logout of the CLI
quit - Logout of the CLI
Description:
Logout of the CLI.
Syntax:
exit
quit
Description:
Use the fan-test edit command to modify the fan test parameters
Syntax:
Fan-test edit {{retry-period <1-24>}}+
Parameters:
retry-period In case a fan test fails, this value will be used to set retry period
of fan test.
Description:
Use this fan-test show command to display fan test configuration and result.
Syntax:
Fan-test show
Description:
Use the fan-test start command to start fan test.
Syntax:
Fan-test start
Description
When fault propagation is enabled for a port, its link status (up or down) depends on the
opposite port status or EVC status. Fault propagation could be based on link status only, or
link status and EVC status.
In link status only operation mode, a link down on the opposite port is propagated to the
specified port. Link status fault propagation is allowed in both directions. It can be enabled on
a port and its opposite port.
In EVC status operation mode, the status of PAA probe(s) and/or CFM MEP(s) are propagated
to the specified port. At least one PAA probe or CFM MEP should be free of connectivity
errors to enable the specified port. If there is no PAA probe and no CFM MEP configured in
EVC fault propagation mode for the specified port, that port will stay down. When enabled for
a port, fault propagation should be disabled on the opposite port.
Syntax
sfp command {<connector-name> | <port-name>}
Description:
When fault propagation is enabled for a port, a link down on the opposite port will be
propagated to that port.
These commands are deprecated and have been kept for backward compatibility purpose. The
command "fault-propagation edit" should be used instead.
Syntax:
fault-propagation {enable | disable} {<port-name>}
Description:
Show fault propagation configuration.
Syntax:
fault-propagation show [<port-name>]
Description:
filter delete ipv4 will delete the specified IPv4 filter.
Syntax:
filter delete ipv4 <filter-name>
Parameters:
<filter-name> <string>
Description:
filter delete ipv6 will delete the specified IPv6 filter.
Syntax:
filter delete ipv6 <filter-name>
Parameters:
<filter-name> <string>
Description:
filter delete l2 will delete the specified Layer 2 filter.
Syntax:
filter delete l2 <filter-name>
Parameters:
<filter-name> <string>
Description:
With these commands, you can create a new filter or change the parameters of an existing
filter instance.
Syntax:
filter {add|edit} ipv4 <filter-name> {
{name <filter-name>} |
{dst-ipv4-addr <ip-addr> {disable | enable} } |
{dst-ipv4-mask <ip-addr>} |
{src-ipv4-addr <ip-addr> {disable | enable} } |
{src-ipv4-mask <ip-addr>} |
{protocol <0-255> {disable | enable}} |
{header-length <0-15> {disable | enable}} |
{ttl <0-255> {disable | enable}} |
{ip-cos-mode {dscp-mode | precedence-mode}} |
{dscp <0-63> {disable | enable}} |
{dscp-last <0-63> {disable | enable}} |
{dscp-oper {lt | gt | eq | range}} |
{precedence <0-7> {disable | enable}} |
{precedence-last <0-7> {disable | enable}} |
{precedence-oper {lt | gt | eq | range}} |
{ecn <0-3> {disable | enable}} |
{icmp-type <0-255> {disable | enable}} |
{icmp-code <0-255> {disable | enable}} |
{destination-port <0-65535> {disable | enable}} |
{destination-port-last <0-65535> {disable | enable}} |
{destination-port-oper {eq | range}} |
{source-port <0-65535> {disable | enable}} |
{source-port-last <0-65535> {disable | enable}} |
{source-port-oper {eq | range}} |
{vlanstack-size <0-3> {disable | enable}} |
{vlan1-cfi <0-1> {disable | enable}} |
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).
Description:
With these commands, you can create a new filter or change the parameters of an existing
filter instance.
Syntax:
filter {add|edit} ipv6 <filter-name> {
{name <filter-name>} |
{dst-ipv6-addr <ip-addr> {disable | enable} } |
{dst-ipv6-prefix <0-128>} |
{src-ipv6-addr <ip-addr> {disable | enable} } |
{src-ipv6-prefix <0-128>} |
{next-header <0-255> {disable | enable}} |
{hop-limit <0-255> {disable | enable}} |
{ip-cos-mode {dscp-mode | precedence-mode}} |
{dscp <0-63> {disable | enable}} |
{dscp-last <0-63> {disable | enable}} |
{dscp-oper {lt | gt | eq | range}} |
{precedence <0-7> {disable | enable}} |
{precedence-last <0-7> {disable | enable}} |
{precedence-oper {lt | gt | eq | range}} |
{icmp-type <0-255> {disable | enable}} |
{icmp-code <0-255> {disable | enable}} |
{destination-port <0-65535> {disable | enable}} |
{destination-port-last <0-65535> {disable | enable}} |
{destination-port-oper {eq | range}} |
{source-port <0-65535> {disable | enable}} |
{source-port-last <0-65535> {disable | enable}} |
{source-port-oper {eq | range}} |
{vlan1-cfi <0-1> {disable | enable}} |
{vlan2-cfi <0-1> {disable | enable}} |
{vlan1-id <0-4095> {disable | enable}} |
{vlan1-id-last <0-4095> {disable | enable}} |
{vlan1-id-oper {lt | gt | eq | range}} |
{vlan2-id <0-4095> {disable | enable}} |
{vlan2-id-last <0-4095> {disable | enable}} |
{vlan2-id-oper {lt | gt | eq | range}} |
Parameters:
<filter-name> <string>
name A unique name to identify the filter.
disable | enable To enable or disable the field in the check.
dst-ipv6-addr The IPv6 destination address.
dst-ipv6-prefix Prefix length to be applied to the IPv6 destination address. Valid
prefix are from 0 to 128.
src-ipv6-addr The IPv6 source address.
src-ipv6-prefix Prefix length to be applied to the IPv6 source address. Valid
prefix are from 0 to 32 bits.
next-header Next header value (0 - 255).
hop-limit Hop limit value (0 - 255).
icmp-type ICMP type (0 - 255).
icmp-code ICMP code (0 - 255).
destination-port Destination port for UDP protocol (0 - 65535).
source-port Source port for UDP protocol (0 - 65535).
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 type 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 type are:
gt (greater than), lt (less than), eq (equal) or range (inclusive
range).
ecn Explicit Congestion Notification value (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.
Description:
With these commands, you can create a new filter or change the parameters of an existing
filter instance.
Syntax:
filter {add|edit} l2 <filter-name> {
{name <filter-name>} |
{dst-mac-addr <mac-addr> {disable | enable} } |
{dst-mac-mask <mac-addr>} |
{src-mac-addr <mac-addr> {disable | enable} } |
{src-mac-mask <mac-addr>} |
Parameters:
<filter-name> <string>
name A unique name to identify the filter.
disable | enable To enable or disable the field in the check.
dst-mac-addr Ethernet MAC destination address.
dst-mac-mask Wildcard mask to be applied to the MAC destination address.
Valid mask is a prefix of 16, 24, 25, 45, 48, or multicast bits (ex.
FF:FF:00:00:00:00, FF:FF:FF:FF:FF:FF, 01:00:00:00:00:00).
src-mac-addr Ethernet MAC source address.
src-mac-mask Wildcard mask to be applied to the MAC source address. Valid
mask is a prefix of 16, 24, 25, 45, 48, or multicast bits (ex.
FF:FF:00:00:00:00, FF:FF:FF:FF:FF:FF, 01:00:00:00:00:00).
ethertype The encapsulated Ethernet type identifies the 16-bit sub-protocol
label field or the original IEEE 802.3 length field.
vlanstack-size Indicates the number of VLAN tags that packets must have in
order to match this filter (0 - 3).
Description:
This command displays a filter configuration. Specifying a filter name provides detailed
configuration about this filter. Otherwise, the command displays summary configuration for
all filters.
Syntax:
filter show {l2 | ipv4 | ipv6} [<filter-name>]
Parameters:
<filter-name> <string>
Description:
Use this command to activate the firmware file that was previously downloaded to the flash.
Once it is activated, the unit will reboot.
Syntax:
firmware activate
Description:
Use this command to delete the previously-downloaded firmware file from the flash memory.
Syntax:
firmware clear-download
Description:
Use this command to download a different firmware file to the unit for activation at a later
date. The unit's rollback firmware version (if any) is overwritten.
Syntax:
firmware download
{ftp | ftps | http | https | sftp | tftp}://[<user-name>:<password>@]<url>
Examples:
Parameters:
<user-name> <string>
<password> <string>
Description:
Use this command to revert the unit's firmware and configuration values back to the previous
version.
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
Description:
Use this command to upgrade the unit to a different firmware version.
Syntax:
firmware upgrade
{ftp | ftps | http | https | sftp | tftp}://[<user-name>:<password>@]<url>
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>
Description:
Use this command to display the unit's current firmware version, as well as the rollback
version or downloaded version (if any).
Syntax:
firmware version
4.168 Help
help - Help will help you with commands you are not familiar with.
Syntax:
help <command>
Parameters:
<command> <string>
Description:
history edit file allows to change parameters used to generate and upload the report files to a
remote server.
Syntax:
history edit file {
{period-mode {new | fixed | all}} |
{local-periods <1-128>} |
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.
Description:
With history local edit, you can change the parameters of the history buckets mechanism.
Syntax:
history edit local {
{paa-state {disable | enable}} |
{paa-filing {disable | enable}} |
{paa-period <1-60>} |
{policy-state {disable | enable}} |
{policy-filing {disable | enable}} |
{policy-period <1-60>} |
{port-state {disable | enable}} |
{port-filing {disable | enable}} |
{port-period <1-60>} |
{regulator-state {disable | enable}} |
{regulator-filing {disable | enable}} |
{regulator-period <1-60>} |
{sfp-state {disable | enable}} |
{sfp-filing {disable | enable}} |
{sfp-period <1-60>} |
{shaper-state {disable | enable}} |
{shaper-filing {disable | enable}} |
{shaper-period <1-60>} |
{soamdmm-state {disable | enable}} |
{soamdmm-filing {disable | enable}} |
{soamdmm-period <1-60>} |
{soampl-state {disable | enable}} |
{soampl-filing {disable | enable}} |
{soampl-period <1-60>} |
{soamsa-state {disable | enable}} |
{soamsa-filing {disable | enable}} |
{soamsa-period <1-60>} |
{soamsametric-state {disable | enable}} |
{soamsametric-filing {disable | enable}} |
{soamsametric-period <1-60>} |
{soamslm-state {disable | enable}} |
{soamslm-filing {disable | enable}} |
{soamslm-period <1-60>} |
{systemhealth-state {disable | enable}} |
{systemhealth-filing {disable | enable}} |
{systemhealth-period <1-60>} |
{twamp-state {disable | enable}} |
{twamp-filing {disable | enable}} |
{twamp-period <1-60>}}+
Parameters:
paa-state Enable or disable PAA history.
paa-filing Enable filesystem storage of the PAA history buckets.
paa-period Reference period for the PAA history buckets.
policy-state Enable or disable policy history.
policy-filing Enable filesystem storage of the policy history buckets.
policy-period Reference period for the policy history buckets.
port-state Enable or disable port history.
port-filing Enable filesystem storage of the port history buckets.
Description:
With the history edit scheduling command, you can modify how reporting history bucket data
is scheduled.
Syntax:
history edit scheduling {
{local-state {disable | enable}} |
{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.
Description:
history show file displays the report file generation configuration parameters.
Syntax:
history show file
Description:
history show local displays the local history configuration parameters.
Syntax:
history show local
Description:
history show scheduling displays the scheduling configuration parameters.
Syntax:
history show scheduling
Description:
Configure an IP interface for management purpose. Interfaces can be set to to acquire their IP
configuration from a DHCP server or can be manually configured with a static IP. The subnet
can be defined using the Address Prefix Length along with the IP (e.g. 192.168.1.100/24) or by
entering the network mask using the netmask keyword.
NOTES: IPv4 aliases: Interfaces can be configured for dual-homing by specifying an alias
name instead of an interface name. Currently only an alias ID of 0 (zero) can be defined.
When specifying an alias, only the address, netmask and gateway parameters can be
configured. An aliased interface is always set up as a static IP address (no DHCP) and is on
a distinct interface.
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 parameter 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} } |
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
gateway A default gateway address provides a shortcut to creating a
default gateway through the route configuration. Only one
default gateway can be set per unit.
ipv6_enable Enable or disable IPv6 on the interface.
ipv6_dhcp Enable DHCPv6 in stateful or stateless mode or disable it. (used if
IPv6 is enabled).
ipv6_radv Enable or disable IPv6 router advertisement autoconfiguration
(used if IPv6 is enabled).
ipv6_static Enable or disable IPv6 static addresses (used if IPv6 is enabled).
ipv6_address Static interface IPv6 addresses, with prefix and optional default
gateway (used if IPv6 and IPv6 static addresses are enabled).
Note: Can be reset by setting the value to ::/0.
type Interface type
vlan1-id VLAN ID for VLAN interface type (1 - 4094)
vlan2-id VLAN ID used when VLAN-in-VLAN type is chosen (1 - 4094)
vlan1-ethertype Ethertype used in the VLAN tag (C-VLAN, S-VLAN, or T-VLAN)
vlan2-ethertype Ethertype used in the VLAN-in-VLAN (.1q in .1q) tag (C-VLAN, S-
VLAN, or T-VLAN)
vlan1-priority Set VLAN priority
vlan2-priority Set VLAN priority in the VLAN-in-VLAN (.1q in .1q) tag
port Interface port
sub-intf Sub-interface list for bridge interface
ip-override Used on a bridge interface, to clear IP address of all sub-
interfaces to 0.0.0.0.
force Used to force a change to the interface that the user is currently
logged into.
state Enable or disable the interface.
dhcp-relay Enable or disable DHCP relaying on this interface.
ipv4-fwd Enable or disable IPv4 forwarding on this interface.
stp Enable or disable Spanning-Tree Protocol
icmp_redirect Enable or disable the global IPv4 ICMP redirects.
The default value is enable
ipv6_icmp_redirect Enable or disable the global IPv6 ICMP redirects.
The default value is enable
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.
Description:
Configure an advertisement instance on the interface for management purpose. An
advertisement instance may be configured to send interface information to another system
for inventory purposes. The advertisement instance is coupled with the interface of the same
name, so any change to the interface name or port will affect the advertisement instance.
Syntax:
interface {edit} <advertisement-name> { {state {enable|disable}} |
{ip-state {enable|disable}} |
{ip-address <IPv4 address>} |
{rate <transmission rate>} |
{format {ACP} |
{use-beacon-rate {enable|disable} }}+
Parameters:
<advertisement-name> <string>
state Enable or disable layer-2 advertisement frame transmission
ip-state Enable or disable layer-3 advertisement frame transmission
rate Transmission rate of advertisement frames, in seconds <3, 60,
600, 3600>
format Only ACP is supported for now.
use-beacon-rate When enabled, makes the advertisement transmission rate the
same as the beacon reception rate.
ip-address The destination IP address to be used in layer-3 advertisement
frames.
Description:
Specifying an interface or alias name provides detailed configuration about this
advertisement, otherwise the command provides summary configuration forall
advertisements in a table format.
Syntax:
interface advertisement show [<interface-name>|<alias-name>]
Parameters:
<interface-name> <string>
<alias-name> <string>:0
Description:
Used to display information about the auxiliary MAC interface including the Port on which it is
configured and the MAC address assigned to this interface.
Syntax:
interface auxiliary-mac show
Description:
Configure a beacon instance on the interface for management purpose. A beacon may be
configured to discover remote devices by sending a special frame on the network, through the
interface it is tied to. The beacon is coupled with the interface of the same name, so any
change to the interface name or port will affect the beacon instance.
Syntax:
interface beacon {edit} <interface-name> { {state {enable|disable}} |
{rate <transmission rate>} |
{domain-id <domain>} |
{subnet {<ip-addr>}} |
{netmask {<ip-addr>}} |
{gateway {<ip-addr>}} |
{dhcp-hostname-option <none,custom,serial-number,current>} |
{dhcp-client-id-option <none,custom,serial-number>} |
{dhcp-hostname <hostname>} |
{dhcp-client-id <client-id>} |
{ip-config-mode {local|auto|dhcp|auto-static}} |
{id-mismatch {enable|disable} }}+
Parameters:
<interface-name> <string>
<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.
Description:
Specifying an interface or alias name provides detailed configuration about this beacon,
otherwise the command provides summary configuration for all beacons in a table format.
Syntax:
interface beacon show [<interface-name>|<alias-name>]
Parameters:
<interface-name> <string>
<alias-name> <string>:0
Description:
Delete an existing interface or alias. When deleting the interface, if an alias had been
previously configured, it will also be deleted.
Syntax:
interface delete <interface-name>|<alias-name>
Parameters:
<interface-name> <string>
<alias-name> <string>:0
Description:
Configure the attributes related to beacon discovery on the auto interface. The discovery
instance may be configured to listen for beacons on selected ports and automatically
configure an interface upon reception of a valid beacon.
Syntax:
interface discovery {edit} { {state {enable|disable}} |
{media-selection {enable|disable}} |
{id-matching {enable|disable}} |
{domain-id <domain_id>} |
{forward-on-bridge {enable|disable}} |
{discovery-ports <port_list>} |
{level [All,<0-7>]} |
{forward-match-ports {port_list|null}} |
{forward-mismatch-ports {port_list|null}}}+
Parameters:
state Enable or disable discovery on the auto interface
media-selection Enable or disable auto media selection for beacon discovery. Note
that when the Discovery state is disabled, auto media-selection is
also disabled.
id-matching When enabled, validate beacon by matching the domain ID from
the beacon with the locally-configured ID.
domain-id The local domain ID, used to match the beacon domain ID.
discovery-ports Ports on which to listen for beacon frames. At least one port
must be selected. Multiple ports in the list must be separated by
commas.
level Specifies level [All, [0-7]] given to ACP frames.
forward-on-bridge When enabled, forward all beacons and information frames on
the bridge, if the auto interface is part of a bridge
forward-match-ports Forward all beacons and information frames on these selected
ports when domain IDs match. Multiple ports in the list must be
separated by commas. The list can be cleared by using the value
"null" for this parameter. This is overridden by the forward-on-
bridge attribute, if enabled.
forward-mismatch-ports Forward all beacons and information frames on these selected
ports when domain IDs do not match. Multiple ports in the list
must be separated by commas. The list can be cleared by using
Description:
Show the attributes related to beacon discovery on the auto interface.
Syntax:
interface discovery {show}
Parameters:
Domain The local domain ID, used to match the beacon domain
ID.
State State of discovery on the auto interface.
Auto media-selection State of auto media selection for beacon discovery.
ID matching State of beacon validation by matching the domain ID
with the locally configured one.
Level The level [All, [0-7]] given to ACP frames.
Last effective beaconer MAC The source MAC address of the last effective beacon
received that changed the configuration of the Auto
interface.
Discovery ports Ports on which we listen for beacon frames.
Forward on bridge Forwarding state of all beacons and information frames
on the bridge, if the auto interface is part of a bridge.
Forward on match Forwarding state of all beacons and information frames
on these selected ports when domain IDs match.
Forward on mismatch Forwarding state of all beacons and information frames
on these selected ports when domain IDs do not match.
Description:
This command is used to clear the system primary interface selection.
Syntax:
interface primary clear
Description:
This command is used to select the system primary interface generally used for management.
Syntax:
interface primary set <interface-name>
Parameters:
<interface-name> <string>
Description:
This command is used to display the name of the system primary interface.
Syntax:
interface primary show
Description:
Convert IP address into physical address for all interfaces.
Syntax:
interface refresh
Description:
This command displays a summary of the configuration for all interfaces in a table format.
Specifying an interface or alias name will display the detailed configuration for this interface.
Syntax:
interface {show|ipv6_show} [<interface-name>|<alias-name>]
Parameters:
<interface-name> <string>
<alias-name> <string>:0
show To show interface IPv4 related configurations.
ipv6_show To show interface IPv6 related configurations.
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
Description:
Change inventory related settings.
Syntax:
inventory edit {{state <enable | disable>}
{adv-filter <enable | disable> } }+
{ warning-threshold <decimal> } }+
Parameters:
state Enable or disable inventory gathering.
adv-filter Enable of disable advertisement frame filtering. Use this option
to filter the advertisement frames based on the beacon
configuration state of the interfaces. The advertisement frames
will be taken into account only if they are received on a port that
has an interface configured with the beacon state set to "enable".
warning-threshold Threshold for the Inventory almost full value
Description:
Shows an inventory of remote devices from which an advertisement has been received. If a
serial number is specified, detailed inventory information will be displayed for the
corresponding remote device.
Syntax:
inventory show <serial-number>
Parameters:
<serial-number> <string>
Description:
This command is used to modify IPv4 options.
Syntax:
ipv4 edit options { { forwarding <enable|disable> } |
{ icmp_redirect <enable | disable> } |
{ igmp-version <0,2,3> } }+
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.
Description:
This command displays configured IPv4 options.
Syntax:
ipv4 show options { forwarding <enable|disable> } |
{ icmp_redirect <enable|disable> } |
{ igmp-version <0,2,3> } }+
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.193 Keepalive
keepalive - Allow to keep a CLI session alive.
Description:
The CLI session is kept alive using this simple command.
Syntax:
keepalive
Description:
Create or modify a Layer-2 Protocol Tunneling rule. Configure the rule operation mode and
parameters.
Syntax:
l2pt {add|edit} <rule-name> {
{state {disable | enable}} |
{catchall {disable | enable}} |
{mode {drop | forward | tunnel | peer} } |
{protocol {stp | lacp | lamp | oam | auth | e-lmi | lldp | cdp | bpdu
| gmrp | gvrp | uld | pagp | pvst | vtp | dtp | stp-uf |
pb-ga | pb-gvrp | cisco-cfm | pause}} |
{inport <port-name> } |
{outport <port-name> } |
{unique-id [<1-64>]} |
{replacement-mac {cisco | accedian}} |
{evc-mapping {none | push | pop}} |
{vlan1-type {c-vlan | s-vlan}} |
{vlan2-type {c-vlan | s-vlan}} |
{vid-list <list>}
{vlan-filtering {disable | enable}} |
{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.
replace: The tag in the incoming frame is replaced.
vlan1-type First VLAN ethertype. For tunneling rules, specifies the ethertype
of the first VLAN tag. For forwarding ethertype rules with EVC
mapping enabled, specifies the of the VLAN pushed to or popped
from the frame.
vlan2-type Second VLAN ethertype. For tunneling rules, specifies the
ethertype of the second VLAN tag.
vid-list Specifies which VLAN tags to insert in the tunneled or forwarded
frames. For tunnels, the format is a list of comma-separated
groups formatted as vlan1:vlan2. The second tag (Q-in-Q) entry is
optional.
For forwarding rules, the format is a single numerical vlan-id.
Double-tagging is not supported in this mode.
vlan-filtering Enables per-VLAN filtering for this L2PT rule. Only the frames
with a VLAN ID matching the one specified in the rule-vid and
Description:
Allows to clear a L2PT rule statistics.
Syntax:
l2pt clear [<rule-name>]
Parameters:
<rule-name> L2PT rule name.
Description:
Allows to delete a L2PT rule.
Syntax:
l2pt delete {<rule-name>}
Parameters:
<rule-name> L2PT rule name.
Description:
Allows to control L2PT global parameters, affecting the feature's general settings.
Syntax:
l2pt edit-global {
{state {disable | enable}} |
{management-state {disable | enable}} |
{port <port-name> state {disable | enable}} }
Parameters:
state Enable or disable L2PT on all traffic ports or on a specific port if
used with the port parameter.
management-state Enable or disable L2PT on all management ports.
<port-name> Port to which this options apply.
Description:
Specifying a L2PT rule provides detailed configuration about this L2PT rule, otherwise the
command provides summary configuration for all L2PT rules in a table format.
Syntax:
l2pt show configuration [<rule-name>]
Parameters:
<rule-name> L2PT rule name.
Description:
The command provides summary statistics for all L2PT rules in a table format.
Syntax:
l2pt show statistics
Description:
Clear the LACP aggregation group statistics. If <agg-identifier> is not specified, all aggregation
group statistics will be cleared.
Syntax:
lacp clear statistics [<agg-identifier>]
Parameters:
<agg-identifier> <string>
Description:
Edit a LACP aggregation group configuration.
Syntax:
lacp edit <agg-identifier> {system-priority <decimal>} |
{timer-mode <custom|short|long|sub50ms>}}+
Parameters:
<agg-identifier> Aggregator group instance name.
system-priority Priority assigned to this system.
timer-mode Time to wait before sending LACPDU (custom, short, long,
sub50ms).
Description:
Display an LACP aggregation group configuration.
Syntax:
lacp show configuration [<agg-identifier>]
Parameters:
<agg-identifier> <string>
State The state of the aggregator. The possible states are Enabled and
Disabled.
Timeout The time to wait before sending LACPDU. The choices are Long
(802.3ad Long Timeout), Short (802.3ad Short Timeout) and
Custom (Accedian Custom timeout allowing for sub-50ms
protection switching).
System priority The priority of the LACP system. The end of the LACP link that
has the highest priority determines which link is active. The
higher the number, the lower the priority. Range: 1 to 65535.
Port name The name of the port.
Port priority The port in the LAG that should be active for the LACP system.
The priority can change dynamically depending on the revertive
mode configuration.
Port number The number of the port.
Description:
This command displays the statistics of link aggregation group (LAG), which contains:
aggregator-name: The name of the LAG
Tx LACPDU: Number of LACPDU transmitted
Syntax:
lacp show statistics [<agg-identifier>]
Parameters:
<agg-identifier> <string>
Description:
Display LACP aggregation group status which contains:
Aggregator Name: The name of the LAG group
System: The MAC address of the port set as working (actor) in the LACP
system.
System priority: The priority of the LACP system. The end of the LACP link that
has the highest priority determines which link is active. The
higher the number, the lower the priority. Range: 1 to 65535.
Key: The IEEE aggregation key of the port.
Port ID: The LACP port identifier.
Port MAC address: The port MAC address.
Port state: The state of the port. The port state is expressed as an
hexadecimal value, where individual bits within a single octet
represent different state elements. The actor and partner can
have one or more states numbered from 1 to 8.
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 controlvalue 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.
Synchronization is encoded in bit 3. If TRUE (encoded as 1), the system considers this link
to be IN_SYNC, i.e. it has been allocated to the correct Link Aggregation Group, the group
has been associated with a compatible Aggregator, and the identity of the Link
Aggregation Group is consistent with the System ID and operational Key information
transmitted.
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 flag 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.
Special 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>
Description:
Edit the configuration of LLDP for one port.
Syntax:
lldp edit <port-name> { {rate <1-3600>} |
{state <enable | disable>} }+
Parameters:
rate LLDP frame transmission rate in seconds [1-3600]. This
command is equivalent to "port edit <port-name> lldp-rate".
state Enable or disable LLDP frame transmission. This command is
equivalent to "port edit <port-name> lldp-state".
Description:
Displays the configuration of LLDP globally or on a per-port basis.
Syntax:
lldp show configuration [<port-name>]
Description:
Displays LLDP information sent to neighbors for a specific port.
Syntax:
lldp show local-info <port-name>
Description:
Displays statistics for LLDP neighbors for one or all ports.
Syntax:
lldp show neighbors [<port-name>]
Description:
Displays statistics for LLDP globally or on a per-port basis.
Syntax:
lldp show statistics [<port-name>]
Description:
loopback edit allows you to edit OAM loopback configurations
Syntax:
loopback edit <instance-name> {{timeout <decimal>} |
{ type {iometrix-l1 | exfo-l2 | exfo-l3 | anacise-l2 |
anacise-l3 | custom}} |
{ state {enable | disable}} |
{ filter {l2 | ipv4 | ipv6} <filter-name>} |
{ swap_mac {enable | disable}} |
{ swap-ip {enable | disable}} |
{ swap-port {enable | disable}} |
{ drop-opposite-traffic {enable | disable}} |
{ remote-lpbk-acterna {enable | disable}} |
{ remote-lpbk-sunrise {enable | disable}} |
{ remote-lpbk-veex {enable | disable}} |
{ remote-lpbk-oam {enable | disable}} |
Parameters:
<instance> <string>
<filter-name> <string>
type Set loopback type to:
iometrix-l1: Loop back all frames that have a destination MAC address of
00:30:79:FF:FF:FF.
exfo-l2: Loop back all frames that have a source MAC OUI of 00:03:01.
exfo-l3: Loop back all UDP echo service packets.
anacise-l2: Loop back all frames that have a source MAC OUI of 00:18:75.
anacise-l3: Loop back all UDP echo service packets.
custom: Loop back all traffic that match a user defined filter.
timeout Set a timeout period for the loopback to stay active
state Enable or disable the OAM loopback
filter Specify an associated filter type and name
swap-mac Enable or disable MAC address swapping
swap-ip Enable or disable IP address swapping
swap-port Enable or disable port swapping
drop-opposite-traffic Enable or disable dropping of opposite traffic
remote-lpbk-acterna Enable or disable remote loopback for JDSU/Acterna
remote-lpbk-sunrise Enable or disable remote loopback for Sunrise
remote-lpbk-veex Enable or disable remote loopback for VeEX
remote-lpbk-oam Enable or disable remote loopback for OAM 802.3ah
discovery-lpbk Enable (accept) or disable (discard) JDSU/Acterna discovery
loopback commands
tagged-cmds Enable (accept) or disable (discard) tagged loopback commands.
persistent Enable or disable loopback at startup time. This option can only
be set for manual loopbacks with no timeouts.
NOTE: swap-* actions apply only to custom loopbacks (user defined filter).
Description:
loopback show allows you to see the configuration of the OAM loopback.
Syntax:
loopback show [<instance-name>]
Parameters:
<instance-name> <string>
Description:
Add a link-based loop-detection instance.
Syntax:
loop-detection add link <port-name> {{state {enable | disable} } |
{name <string> } |
{interval <1-30> } |
{index <1-1000> } |
{auto-block {enable | disable} } |
{revertive {enable | disable} } }+
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.
Description:
Add a tunnel-based loop-detection instance.
Syntax:
loop-detection add tunnel <interface-name> {{state {enable | disable} } |
{name <string> } |
{interval <1-30> } |
{index <1-1000> } |
{auto-block {enable | disable} } |
{revertive {enable | disable} } }+
Parameters:
<interface-name> Only single-tagged VLAN interfaces 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 (2-30 seconds). Default: 2.
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.
Description:
Clear statistics of all loop-detection counters, including sent frames, received frames and loop-
detected frames.
Syntax:
loop-detection clear all counters
Description:
Clear statistics of loop-detection global counter, including sent frames, received frames and
loop-detected frames.
Syntax:
loop-detection clear global-counter
Description:
Clear statistics of a link-based loop-detection instance, including sent frames, received frames
and loop-detected frames.
Syntax:
loop-detection clear link counters [<name | index>]
Parameters:
name Identifies the loop-detection instance to clear.
index Identifies the loop-detection instance to clear by index.
Description:
Clear statistics of a tunnel-based loop-detection instance, including sent frames, received
frames and loop-detected frames.
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.
Description:
Delete an existing link-based loop-detection instance.
Syntax:
loop-detection delete link <name | index>
Parameters:
name Identifies the loop-detection instance to delete.
index Identifies the loop-detection instance to delete by index.
Description:
Delete an existing tunnel-based loop-detection instance.
Syntax:
loop-detection delete tunnel index <name | index>
Parameters:
name Identifies the loop-detection instance to delete.
index Identifies the loop-detection instance to delete by index.
Description:
Send a one-shot loop-detection beacon.
Syntax:
loop-detection diagnostic send <port-name>
{vlan-state <enable | disable> }
{vlan-id <0-4094> }
{vlan-ethertype <c-vlan | s-vlan | t-vlan> }
{timeout <3-30> }
Parameters:
port-name Outgoing physical port.
vlan-enable Enable encapsulation of VLAN in the beacon.
vlan-id VLAN ID.
vlan-ethertype VLAN ethertype.
timeout Timeout (3-30 seconds). Default: 3.
Description:
Show the loop-detection beacon status.
Syntax:
loop-detection diagnostic show-status
Description:
Edit link-based loop-detection instance attributes.
Syntax:
loop-detection edit link <name | index> {{state {enable | disable} } |
{new-name <string> } |
{interval <1-30> } |
{auto-block {enable | disable} } |
{revertive {enable | disable} } }+
Parameters:
name Identifies the loop-detection instance to edit.
index Identifies the loop-detection instance to edit by index.
state Enable execution of the loop-detection instance.
new-name Unique name associated to the loop-detection instance.
interval Beacon transmission rate in seconds.
auto-block Enable auto-block mechanism.
revertive Enable revertive mode for auto-block mechanism.
Description:
Edit tunnel-based loop-detection instance attributes.
Syntax:
loop-detection edit tunnel <name | index> {{state {enable | disable} } |
{name <string> } |
{interval <2-30> } |
{auto-block {enable | disable} } |
{revertive {enable | disable} } }+
Parameters:
name Identifies the loop-detection instance to edit.
index Identifies the loop-detection instance to edit by index.
state Enable execution of the loop-detection instance.
new-name Unique name associated to the loop-detection instance.
interval Beacon transmission rate in seconds.
auto-block Enable auto-block mechanism.
revertive Enable revertive mode for auto-block mechanism.
Description:
Display a configuration summary of all loop-detection instances.
Syntax:
loop-detection show all configuration
Description:
Display beacon statistics of each loop-detection instance, including sent frames, received
frames and loop-detected frames.
Syntax:
loop-detection show all counters
Description:
Display the state of each loop-detection instance, whether it is loop-detected or not.
Syntax:
loop-detection show all status
Description:
Display a summary beacon statistics for all instances, including sent frames, received frames
and loop-detected frames.
Syntax:
loop-detection show global-counter
Description:
Display a configuration summary of all link-based loop-detection instances.
Syntax:
loop-detection show link configuration
Description:
Display statistics of each link-based loop-detection instance, including sent frames, received
frames and loop-detected frames.
Syntax:
loop-detection show link counters
Description:
Display the state of each link-based loop-detection instance, whether it is loop-detected or
not.
Syntax:
loop-detection show link status
Description:
Display a configuration summary of all tunnel-based loop-detection instances.
Syntax:
loop-detection show tunnel configuration
Description:
Display statistics of each tunnel-based loop-detection instance, including sent frames,
received frames and loop-detected frames.
Syntax:
loop-detection show tunnel counters
Description:
Display the state of each tunnel-based loop-detection instance, whether it is loop-detected or
not.
Syntax:
loop-detection show tunnel status
Description:
Block traffic link-based loop-detection instance attributes.
Syntax:
loop-detection traffic block link <name | index>
Parameters:
name Identifies the loop-detection instance to edit.
index Identifies the loop-detection instance to edit by index.
Description:
Block traffic tunnel-based loop-detection instance attributes.
Syntax:
loop-detection traffic block tunnel <name | index>
Parameters:
name Identifies the loop-detection instance to edit.
index Identifies the loop-detection instance to edit by index.
Description:
Clear traffic link-based loop-detection instance attributes.
Syntax:
loop-detection traffic clear link <name | index>
Parameters:
name Identifies the loop-detection instance to edit.
index Identifies the loop-detection instance to edit by index.
Description:
Clear traffic tunnel-based loop-detection instance attributes.
Syntax:
loop-detection traffic clear tunnel <name | index>
Parameters:
name Identifies the loop-detection instance to edit.
index Identifies the loop-detection instance to edit by index.
Description:
Configure the system settings in the unit.
Syntax:
mode {edit} { { svlan-type <ethertype-value> } |
{ igmp-version <0-3> } |
{ webs-port {443 | <1024-65535>} }}
Parameters:
svlan-type Set the system-wide S-VLAN Ethertype value.
<ethertype-value> The Ethertype value (0x88a8 or 0x9100).
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.
Description:
Displays the general system settings currently configured in the unit.
Syntax:
mode show
Description:
Modifies the configuration of the traffic monitors.
Syntax:
monitor edit <monitor-name> {
{name <monitor-name>} |
{state <enable | disable>} |
{destination <port>}}+
Parameters:
<monitor-name> <string>
name Modify the name of the monitor.
state Enable or disable monitoring.
destination Specify the destination of the monitored traffic. This can only be
PORT-8 or PORT-12, when PORT-12 is present.
Description:
Displays the configuration of the traffic monitors. If a monitor name is specified, detailed
monitor configuration is displayed. Otherwise, a configuration summary is displayed in a table
format.
Syntax:
monitor show configuration [<monitor-name>]
Description:
Edit the "Message of the Day" that is displayed when users log in the unit.
Syntax:
motd edit <new-message>
Parameters:
<new-message> <string>
Description:
Show the "Message of the Day" that is displayed when users log in the unit.
Syntax:
motd show
Description:
Edit management traffic regulation parameters.
Syntax:
mtr edit { {state {enable | disable} } |
{rate <64-10000>} |
{latency <50-2000>} |
{burst <1522-4000>} }+
Parameters:
state Enable or disable management traffic regulation.
rate Specifies the average data rate in kilobits/second.
latency Specifies the transmit queue size by indicating the maximum
time, in milliseconds. Packets must wait inside the transmit
queue.
burst Specifies the maximum burst size in bytes.
Description:
Enable or disable management traffic regulation. This is equivalent to mtr edit state {enable |
disable}.
Syntax:
mtr {enable | disable}
Description:
Show management traffic regulation configuration.
Syntax:
mtr show
Description:
Used to edit the NETCONF agent configuration.
Syntax:
netconf edit {
{state {disable | enable}}+
Parameters:
state Enable or disable the NETCONF agent.
Description:
Used to display the NETCONF agent configuration.
Syntax:
netconf show
Description:
Add an NTP (Network Time Protocol) to synchronize the clock with the remote server.
Syntax:
ntp add {<server-address>}
Parameters:
<server-address> <ip-addr> | <ipv6-addr> | <dns-name>
The name or the IP address of the NTP server to add.
Description:
Remove an NTP (Network Time Protocol) server from the list of servers.
Syntax:
ntp delete {<server-address>}
Parameters:
<server-address> <ip-addr> | <ipv6-addr> | <dns-name>
Description:
Stop using the NTP service
Syntax:
ntp disable
Description:
Stop the NTP server
Syntax:
ntp disable-server
Description:
Change time or NTP related settings
Syntax:
ntp edit {{tai-offset <decimal>}
{sync-mode <normal | highres>}
{dscp <0-63>}
{dst <enable | disable>}
{vlan-priority <0-7>}
{time-interval <10-300>}
{nbr-messages <5-60>}
{utc-hour <(-12)-(+14)>}
{utc-min <0-59>}
{dst-hour <0-23>}
{dst-min <0-59>}
{dst-start-month <month>}
{dst-start-week <1-5>}
{dst-start-day <day>}
{dst-start-hour <0-23>}
{dst-start-min <0-59>}
{dst-end-month <month>}
{dst-end-week <1-5>}
{dst-end-day <day>}
{dst-end-hour <0-23>}
{dst-end-min <0-59>}}+
Parameters:
tai-offset Offset in seconds to convert UTC time to TAI (Temps Atomique
International).
sync-mode Synchronization mode. In normal mode, the time is retrieved from
the NTP server and the local clock adjusted accordingly, without
further processing. In high resolution mode, hardware-assisted
synchronization is performed to achieve better accuracy.
dscp When using NTP, the priority can be set in the DiffServ Code
Point.
dst For regions of the world implementing Daylight Saving Time,
(DST), this can be enabled. Be aware that syslog and other
services that timestamp events using the current date and time
will be affected during transitions of DST periods. There will
possibly be an hour gap or duplicate time stamps because the
clock was set back.
vlan-priority When using NTP, the priority of the packets can be set in the
VLAN priority bits if the link is through a VLAN.
time-interval The time interval between requests to the NTP server (in
seconds).
Description:
Choose the NTP (Network Time Protocol) server you want to use for the clock
synchronization. You can enable up to two servers, but only one will be active at a time. This
command also starts the NTP service.
Syntax:
ntp enable { {<server-address>} |
{<server-address>} }
Parameters:
<server-address> <ip-addr> | <ipv6-addr> | <dns-name>
Description:
Start the NTP server service.
Syntax:
ntp enable-server
Description:
Show the current configuration and status for the NTP (Network Time Protocol) service.
Syntax:
ntp show [inbound]
Parameters:
inbound Specifies threshold criterion to reach before declaring
synchronized state. When the keyword "inbound" is specified,
the command will only show the setting of the inbound criterion.
Description:
Add a new OAM instance or edit attributes of an existing OAM instance.
Syntax:
oam {add|edit} <instance-name>
(not optional for add) {{port <port-name>} |
{name <oam-name>} |
{state {enable|disable}} |
{mode {active|passive}} |
{max-pdu-size <decimal>} |
{event-re-transmit <decimal>} |
{efe-threshold <decimal>} |
{efe-window <decimal>} |
{efpe-threshold <decimal>} |
{efpe-window <decimal>} |
{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
Description:
Clear the statistics of an OAM instance. If <instance-name> is not specified, all OAM instances
statistics will be cleared.
Syntax:
oam clear statistics [<instance-name>]
Parameters:
<instance-name> <string>
Description:
Remove the OAM instance.
Syntax:
oam delete {<instance-name>}
Parameters:
<instance-name> <string>
Description:
Show the configuration of the OAM instance.
Syntax:
oam show configuration [<instance-name>]
Parameters:
<instance-name> <string>
Description:
OAM show events is a summary of all the events exchanged on an OAM connection. You can
see all details of received and transmit events.
Syntax:
oam show events [<instance-name>]
Parameters:
<instance-name> <string>
Description:
Show the statistics of the OAM instance.
Syntax:
oam show statistics [<instance-name>]
Parameters:
<instance-name> <string>
Description:
OAM show status is a summary of the status of each OAM instance.
Syntax:
oam show status [<instance-name>]
Parameters:
<instance-name> <string>
Description:
Create or modify a PAA probe. Configure the probe operation mode, its addressing
parameters and various measurement parameters.
Syntax:
paa {add|edit} l2 <probe-name> {
{state {disable | enable}} |
{tw-adv-threshold <decimal> }
{fault-propagation <enable | disable> }
{fp-port <port-name> } }+
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 100.
peer-index Specifies the remote peer identifier for the probe. If peer-
index is omitted or set to 0 when the instance is added,
the remote peer identifier will be discovered dynamically
based on the probe name during the PAA association
phase.
port Outgoing port name.
dst-mac-addr The peer MAC address. When set to FF:FF:FF:FF:FF:FF,
layer-2 peer address discovery will be done
automatically, i.e. it will find the peer MAC address.
vlan1-id First VLAN ID. When enabled, layer-2 PAA frames are
encapsulated into the specified VLAN.
vlan2-id Second VLAN ID. When enabled, layer-2 PAA frames are
encapsulated into a second VLAN. Applies only when
vlan1-id is enabled.
vlan1-type First VLAN type. When vlan1-id is enabled, specifies the
VLAN type of the first VLAN tag.
vlan2-type Second VLAN type. When vlan2-id is enabled, specifies
the VLAN type of the second VLAN tag.
vlan1-priority First VLAN priority bits. Applies only when vlan1-id is
enabled.
vlan2-priority Second VLAN priority bits. Applies only when vlan2-id is
enabled.
validate-vlan1-id Enable or disable VLAN 1 id validation.
couple-tx-rx-vlan1-id Couple Tx and Rx VLAN 1 id values for VLAN 1 id
validation.
rx-vlan1-id Expected VLAN 1 id value received by the remote.
validate-vlan1-priority Enable or disable VLAN 1 priority validation.
Description:
Create or modify a PAA probe. Configure the probe operation mode, its addressing
parameters and various measurement parameters.
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 100.
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).
Description:
Create or modify a PAA probe. Configure the probe operation mode, its addressing
parameters and various measurement parameters.
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 1000.
peer-index Specifies the remote peer identifier.
Description:
Remove a PAA probe.
Syntax:
paa delete {<probe-name>}
Parameters:
<probe-name> <string>
Description:
Display a summary of the configured PAA instances. When an instance name is specified, a
detailed configuration report is displayed.
Syntax:
paa show configuration [<probe-name>]
Parameters:
<probe-name> <string>
Description:
Display PAA probe measurements and status.
Syntax:
paa show result [<probe-name>] {
{ type {historic}} |
{ buckets <0-16>} |
{ period <period-id>}}+
Parameters:
<probe-name> <string>
<period-id> <decimal>
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 4 buckets will be
displayed.
buckets: Number of PAA buckets to display.
period Reference period for the PAA history buckets. Zero for the most
recent period available.
Description:
Display PAA probe status.
Syntax:
paa show status [<probe-name>]
Parameters:
<probe-name> <string>
Description:
Add a permission group.
Syntax:
permission-group {add} <group-name> {
{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},+ }
Parameters:
<group-name> <string>
Description:
Delete an existing permission-group
Syntax:
permission-group delete <group-name>
Parameters:
<group-name> <string>
Description:
Configure a permission group.
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.
Description:
Specifying a permission-group name provides detailed configuration about this group.
Otherwise, the command provides a summary configuration for all permission-groups in a
table format. Sub-permissions display sub-permissions for a specific user group and
permission group.
Syntax:
permission-group show [<group-name>] {{sub-permission <permission group>}}
Parameters:
<group-name> <string>
sub-permission Sub-permission of the permission group.
<permission group> Permission group which has sub-permission
4.275 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.276 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
Description:
Change the agent's configuration parameters.
Syntax:
pmcollect edit configuration {<parameter> <value>}*
Description:
Display the agent's configuration parameters.
Syntax:
pmcollect show configuration
Description:
Display the agent's JSON descriptors.
Syntax:
pmcollect show descriptors
Description:
Clear policy statistics. If <traffic-name> and <policy-id> are not specified, all policies statistics
for all traffic-names will be cleared. If, <traffic-name> is specified, the policies statistics for this
<traffic-name> will be cleared.
Syntax:
policy clear statistics [<Traffic-name>] [<policy_id>]
Parameters:
<Traffic-name> <string>
<policy-id> <decimal>
Description:
This command defines the traffic filter and the action associated with an access policy.
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>} |
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.
filter Specify an associated filter type and name.
action Drop or Permit the traffic matching the filter.
NOTE: None, MGMT-OAM, MGMT-OAM & Drop and MGMT-OAM & Forward actions are
not supported when the filter type is VID set.
Description:
Display policy configuration. If a policy-id is specified, detailed policy configuration is
displayed, otherwise a configuration summary is displayed in a table format.
Syntax:
policy show configuration {Traffic-x} [<policy-id>]
Parameters:
<policy-id> <decimal>
Description:
Display policy packet and byte counters.
Syntax:
policy show statistics {Traffic-x} [<policy-id>] {
{ type {clearable | persistent | historic}} |
{ buckets <0-16>} |
{ period <period-id>}}+
Parameters:
<policy-id> <decimal>
<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 policy buckets to display.
period Reference period for the policy history buckets. Zero for the most
recent period available.
Description:
Clear port statistics. If <port-name> is not specified, all ports statistics will be cleared.
Syntax:
port clear statistics [<port-name>]
Description
Edit port attributes. A port can be identified by its name or by the connector name. The port
speed and duplex mode are not relevant when auto-negotiation is enabled. Forcing the port
speed to 1G is not allowed because auto-negotiation is mandatory for Gigabit Ethernet.
Syntax
port edit <port-identifier> {{name <port-name>} |
{alias <port-alias>} |
{state {enable | disable}} |
{mtu <64-10240>} |
{lp-threshold <64-10240>} |
{llr {enable|disable}} |
{llr-period <decimal>} |
{internal-loopback {enable|disable}} |
{internal-loopback-timeout <0-60>} |
{auto-nego {enable|disable}} |
{speed {10M|100M|1G|10G}} |
{duplex {half|full}} |
{mdi {auto|mdi|mdix}} |
{advertisement {<advertisement-value>}+} |
{pause-mode {local|transparent|disable}} |
{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> {10M-HD|10M-FD|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 transfer 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.
Description:
Without arguments or with the modifier summary, this command displays the port
configuration summary in a table format. When specifying a port name or a connector name,
this command displays detailed configuration for that port.
Syntax:
port show configuration [<port-name>]
Description:
Display port statistics.
Syntax:
port show statistics [<port-name>] {
{ type {clearable | persistent | historic}} |
{ buckets <0-16>} |
{ period <period-id>}}+
Parameters:
<port-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 port buckets to display.
period: Reference period for the port history buckets.
Zero for the most recent period available.
Description:
Display port status.
Valid link state values are:
Up: The port is up and running.
Dormant: Indicates that a signal is detected.
Protection-mode for the parent LAG port is 'Link-status'.
Port is the standby connector.
Down: The physical link is down and no signal is detected.
Syntax:
port show status
Output:
Description:
Shows the summary of PTP configuration of the particular PTP port.
Syntax:
ptp show configuration <ptp-port-name>
Output:
Configuration settings:
-----------------------
State : Enabled
PTP Clock Id : 0x0015adfffe57c8f0
PTP Port Id : 1
PTP Domain Id : 0
PTP Clock Class : 255
PTP Clock Accuracy : 39
PTP OffsetScaledLogVariance : 65535
PTP Time Source : 160
Priority1 : N/A
Priority2 : N/A
PTP port name : PTP_PORT_1
Interface name : N/A
Protocol : IPv4
Mode : Unicast
Sync Interval : 0 (1pkt/s)
Sync Receipt Timeout : 3
Announce Interval : 1 (1pkt/2s)
Announce Receipt Timeout : 3
Delay Request Offset : 0
Delay Response Receipt Timeout : 3
Multicast address : N/A
Description:
Shows the current configuration and status for the PTP (Precision Time Protocol) service.
Syntax:
ptp show
Description:
Shows the summary of the PTP configuration.
Syntax:
ptp show configuration
Output:
Description:
Shows the PTP status of a particular port.
Syntax:
ptp show status <ptp-port-name>
Output:
Description:
Shows the PTP general status.
Syntax:
ptp show status
Output:
Description:
Shows the summarized PTP statistics.
Syntax:
ptp show statistics
Output:
Description:
Shows the PTP statistics of a particular PTP port.
Syntax:
ptp show statistics <ptp-port-name>
Output:
Counters
--------
RxAnnounce : 0
RxSync : 0
RxSyncFollowUp : 0
TxDelayReq : 0
RxDelayResp : 0
TxRequestUnicastAnnounce : 0
TxRequestUnicastSync : 0
TxRequestUnicastDelayResp : 0
RxGrantUnicastAnnounce : 0
RxGrantUnicastSync : 0
RxGrantUnicastDelayResp : 0
TxCancelUnicastAnnounceCount : 0
TxCancelUnicastSyncCount : 0
TxCancelUnicastDelayRespCount : 0
RxAckCancelUnicastAnnounceCount : 0
RxAckCancelUnicastSyncCount : 0
RxAckCancelUnicastDelayRespCount : 0
TxAnnounce : 0
TxSync : 0
TxSyncFollowUp : 0
RxDelayReq : 0
TxDelayResp : 0
RxRequestUnicastAnnounce : 0
RxRequestUnicastSync : 0
RxRequestUnicastDelayResp : 0
TxGrantUnicastAnnounce : 0
TxGrantUnicastSync : 0
TxGrantUnicastDelayResp : 0
RxCancelUnicastAnnounceCount : 0
RxCancelUnicastSyncCount : 0
RxCancelUnicastDelayRespCount : 0
TxAckCancelUnicastAnnounceCount : 0
TxAckCancelUnicastSyncCount : 0
TxAckCancelUnicastDelayRespCount : 0
Number Of Synchronisation : 0
Number Of Correction : 0
Note: PTB BC functionality is only present in the LX-SY platform.
Description:
Resets the PTP statistics of the particular PTP port.
Syntax:
ptp show statistics <ptp-port-name> -r
Description:
Adds PTP port.
Syntax:
ptp add port <parameter> <value>
{01:1b:19:00:00:00 | 01:80:c2:00:00:0e}
<-3 - 3>
<2 - 10>
<0 - 5>
<0 - 255>
<interface-name>
{Multicast}
<string>
<0 - 7>
{force-slave}
<-4 - 1>
Parameters:
address Specifies layer-2 multicast destination address.
Telecom-ITU8265.1 Profile
Description:
Adds PTP port.
Syntax:
ptp add port <parameter> <value>
<-3 - 3>
<2 - 10>
<2 - 10>
<0 - 255>
<0 - 63>
<interface-name>
{Unicast}
<string>
<0 - 7>
{force-slave}
<-4 - 3>
<-2 - 10>
<-1 - 255>
<-60 - 1000>
Telecom-ITU8275.1 Profile
Description:
Adds PTP port.
Syntax:
ptp add port <parameter> <value>
{01:1b:19:00:00:00 | 01:80:c2:00:00:0e}
<2 - 10>
<0 - 5>
<0 - 255>
<interface-name>
{Multicast}
<string>
<0 - 7>
{auto|force-master|force-slave}
<-1 - 255>
Description:
Adds PTP grantor.
Syntax:
ptp add grantor <ptp-port-name><parameter> <value>
{<ip-addr> | <ipv6-addr> | <dns-name>}
<0 - 255>
<string>
<string>
<0 - 2>
Parameters:
address Master address (time server for the PTP client)
domain Specifies the domain number of the PTP master.
interface Specifies the interface used to communicate with the PTP
master
Description:
Edits the PTP port.
Syntax:
ptp edit port <parameter> <value>
{01:1b:19:00:00:00 | 01:80:c2:00:00:0e}
<-3 - 3>
<2 - 10>
<0 - 5>
<0 - 255>
<interface-name>
{Multicast}
<string>
<0 - 7>
{force-slave}
<-4 - 3>
Parameters:
address Specifies layer-2 multicast destination address.
announce Specifies the interval between Announce messages.
announce-receipt-timeout Specifies the number of Announce messages that can be lost
before timeout occurs.
delay-request-offset Specifies delay request offset based on the sync interval.
domain Specifies the domain number of the PTP master.
interface Specifies the Interface used to communicate.
mode Specifies communication method.
Telecom-ITU8265.1 Profile
Description:
Edits the PTP port.
Syntax:
ptp edit port <parameter> <value>
<-3 - 3>
<2 - 10>
<2 - 10>
<0 - 255>
<0 - 63>
<interface-name>
{Unicast}
<string>
<0 - 7>
{force-slave}
<-4 - 3>
<-2 - 10>
<-1 - 255>
<-60 - 1000>
Telecom-ITU8275.1 Profile
Description:
Edits the PTP port.
Syntax:
{01:1b:19:00:00:00 | 01:80:c2:00:00:0e}
<2 - 10>
<0 - 5>
<0 - 255>
<interface-name>
{Multicast}
<string>
<0 - 7>
{auto|force-master|force-slave}
<-1 - 255>
pcp When using PTP, the priority of the packets can be set in the
Priority code point bits if the link is through a VLAN.
port-mode Specifies PTP port mode.
Local-priority Specifies the value of local Priority to the PTP port.
Description:
Edits the PTP stack.
Syntax:
ptp edit stack <parameter> <value>
<0 - 254>
{class-b | 1-usec}
<0 - 255>
<0 - 255>
{default | telecom-ITU8265.1| telecom-ITU8275.1}
{enable | disable}
Parameters:
class Specifies class value of the PTP clock.
inbound Specifies inbound criterion
Prio1 Specifies priority1 value of the PTP clock
Prio2 Specifies priority2 value of the PTP clock
profile Specifies Telecom Profile
state Specifies clock state
Description:
Edits the PTP grantor.
Syntax:
ptp edit grantor <ptp-grantor-name> <parameter> <value>
{<ip-addr> | <ipv6-addr> | <dns-name>}
<0 - 255>
<string>
<string>
<0 - 2>
Parameters:
address Specifies Master address (time server for the PTP client)
domain Specifies the domain number of the PTP master.
interface Specifies the interface used to communicate with the PTP
master
name Specifies a name for the PTP grantor
priority For the Telecom-Profile only (ITU-T G.8265.1), specifies the
priority for the PTP master. Acceptable values: 0 (means
disabled), 1 (means best) and 2 (means worst).
Description:
Used to delete a PTP port.
Syntax:
ptp delete port <ptp-port-name>
Description:
Used to delete the PTP grantor.
Syntax:
ptp delete grantor <ptp-grantor-name>
Description:
Used to reset the PTP.
Syntax:
ptp reset
Description:
Change PTP related settings.
Syntax:
ptp edit { {state <enable|disable>} |
{pma <master-address>} |
{sma <master-address>} |
{utc <enable|disable>} |
{announce <-3,-2,-1,0,1,2 or 3>} |
{sync <-4,-3,-2,-1,0 or 1>} |
{pdn <0-255>} |
{sdn <0-255>} |
{dscp <0-63>} |
{vlan-priority <0-7>} }
Parameters:
state Enable or disable the PTP feature.
pma Primary master address (time server for the PTP client).
sma Secondary master address (time server for the PTP client).
<master-address> <ip-addr> | <ipv6-addr> | <dns-name>
utc Enable or disable the use of UTC offset from the master.
announce Specifies the interval of Announce message from the master.
Possible values:
-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.
Description:
radius edit allows you to change RADIUS parameters required to authenticate authorize
management access to the unit.
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.
auth-server1-port RADIUS server UDP port to connect to.
auth-server1-secret Shared secret for server1.
Description:
Show the RADIUS configuration.
Syntax:
radius show
Description:
Configure the working rate used by different modules in the unit.
Syntax:
rate {edit} { { generator <layer-1 | layer-2> } |
{ regulator <layer-1 | layer-2> } |
{ shaper <layer-1 | layer-2> } }
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.
Description:
Display the working rate used by different modules in the unit.
Syntax:
rate show
4.309 Reboot
Reboots the unit
Regulator-Set Add/Edit DSCP
Description:
With these commands, you can create a new regulator set or change the parameters of an
existing regulator set.
Syntax:
regulator-set {add|edit} dscp <regulator-set-name> {
{name <regulator-set-name>} |
{input-list {<0-63> [,|- <0-63>]}+ } |
{regulator {disable | enable} [<regulator-name>]} |
{default-regulator {enable | disable}
[<regulator-name>]} }+
Parameters:
<regulator-set-name> <string>
<regulator-name> <string>
input-list A comma-separated list of DSCP values and DSCP range (x-y)
values.
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.
Description:
With these commands, you can create a new regulator set or change the parameters of an
existing regulator set.
Syntax:
regulator-set {add|edit} pcp <regulator-set-name> {
{name <regulator-set-name>} |
{input-list {<0-7> [,|- <0-7>]}+ } |
{regulator {disable | enable} [<regulator-name>]} |
{default-regulator {enable | disable}
[<regulator-name>]} }+
Parameters:
<regulator-set-name> <string>
<regulator-name> <string>
input-list A comma-separated list of PCP values and PCP range (x-y)
values.
regulator Bandwidth regulator to be used for all packets that have a PCP in
input-list.
default-regulator Bandwidth regulator to be used for all packets that do NOT have
a PCP in input-list.
Description:
With these commands, you can create a new IP precedence regulator set or change the
parameters of an existing IP precedence regulator set.
Syntax:
regulator-set {add|edit} precedence <regulator-set-name> {
{name <regulator-set-name>} |
{input-list {<0-7> [,|- <0-7>]}+ } |
{regulator {enable | disable} [<regulator-name>]} |
{default-regulator {enable | disable}
[<regulator-name>]} }+
Parameters:
<regulator-set-name> <string>
<regulator-name> <string>
input-list A comma-separated list of IP precedence values and IP
precedence range (x-y) values.
regulator Bandwidth regulator to be used for all packets that have an IP
precedence in input-list.
default-regulator Bandwidth regulator to be used for all packets that do NOT have
an IP precedence in input-list.
Description:
Delete the specified regulator set.
Syntax:
regulator-set delete <regulator-set-name>
Parameters:
<regulator-set-name> <string>
Description:
Displays regulator set configuration. Specifying a regulator set name displays the detailed
configuration for this regulator set. Otherwise, the command displays a configuration
summary for all regulator sets.
Syntax:
regulator-set show configuration [<regulator-set-name>]
Parameters:
<regulator-set-name> <string>
Description:
rfc2544 generator edit controls the traffic generator output.
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).
<packet-params Generator packet header 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.
NOTE: ip-multicast packet-type is only used to generate traffic frames, not to analyze
received frames.
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.
Flow syntax:
rfc2544 generator edit <flow-name> {
{description <description-text>} |
{traffic-type {constant {rate <0 to max-port-speed>}} |
burst {{packets <1 to max-packets>} |
{burst-gap <1 to 60000>}}} |
{packet-size {fixed <64-10240>} |
random {{min-size <64-10240>} |
{max-size <64-10240>}}} |
{payload-pattern {fixed-data <hexadecimal>} |
incremental {bytes | words} |
random {2e11-random | 2e11inv-random |
2e15-random | 2e15inv-random |}} |
{duration {continuous} |
{seconds <1-86400>} |
{bytes <64-4000000000>} |
{packets <1-4000000000>}} |
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.
Description:
This command displays the RFC-2544 generator configuration. Specifying a packet or flow
name will display a detailed configuration for this packet or flow descriptor. Otherwise, the
command will display the generator summary configuration.
Syntax:
rfc2544 generator show configuration [<packet-name>] [<flow-name>]
Parameters:
<packet-name> packet[n] where "n" is included in <1-2>.
<flow-name> flow[n] where "n" is included in <1-2>.
Description:
This command displays the RFC-2544 generator results. Specifying a flow name will display
detailed results for this flow. Otherwise, the command will display a summary of the
generator results.
Syntax:
rfc2544 generator show results [<flow-name>]
Parameters:
<flow-name> flow[n] where "n" is included in <1-2>.
Description:
Start RFC-2544 generator.
Syntax:
rfc2544 generator start
Description:
Stop RFC-2544 generator.
Syntax:
rfc2544 generator stop
Description:
Clear RFC-2544 monitor statistics.
Syntax:
rfc2544 monitor clear statistics <monitor-name>
Parameters:
<monitor-name> <string> Name of the monitor to clear. When no monitor name is
specified, the function will clear all RFC-2544 monitors.
Description:
rfc2544 monitor edit controls the traffic monitor behavior.
Syntax:
rfc2544 monitor edit <monitor-name> { {name <monitor-name>}
{description <monitor-desc>}
{port <port-name>} |
{packet <packet-params>} |
{mode {bypass | terminal} |
{state {enable | disable}}
}+
Parameters:
name <string> Unique name for this monitor.
description <string> Description identifying the monitor and its
characteristics.
port Name of the input port from which to monitor traffic.
packet Monitor packet header configuration (see below).
mode Operational mode of the monitor.
terminal: The RFC-2544 test will terminate at this unit.
bypass: The RFC-2544 test measurements will be taken
but the traffic will follow the rules configured in
the policies for this specific traffic type.
state Operational state of the monitor, enabled or disabled.
Packet syntax:
rfc2544 monitor edit <monitor-name> packet
{ {packet-type {layer-2 | layer-3 | l2-accedian |
l2-generic | l3-generic}} |
{ethertype <0-65535>} |
{dst-mac-addr <mac-addr>} |
{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>} |
{destination-port <0-65535>} |
{src-ipv4-addr <ip-addr>} |
{source-port <0-65535>} |
{y1731-level <0-7>}}+
Packet parameters:
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 0x8100 for 802.1Q network,
0x9100 for 802.1Q tunneling network, or 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 0x8100 for 802.1Q network,
0x9100 for 802.1Q tunneling network, or 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.
destination-port This is the destination port for UDP protocol (0 - 65535).
src-ipv4-addr The IPv4 source address.
source-port This is the source port for UDP or (0 - 65535).
y1731-level Y.1731 Maintenance Entity Group level (0-7).
* Ethertype values 0x9100 and 0x88A8 are considered an S-VLAN. The S-VLAN
Ethertype used here is the value configured in the global setting.
Description:
This command displays the RFC-2544 monitor configuration. Specifying a monitor name
provides detailed configuration about this monitor descriptor. Otherwise, the command
provides the monitor configuration summary.
Syntax:
rfc2544 monitor show configuration [<monitor-name>]
Parameters:
<monitor-name> <string>
Description:
This command displays the RFC-2544 monitor results. Specifying a monitor name provides
detailed results from this monitor. Otherwise, the command provides the monitor results
summary.
Syntax:
rfc2544 monitor show results [<monitor-name>]
Parameters:
<monitor-name> <string>
Description:
rfc2544 testsuite add creates a new RFC-2544 testsuite instance.
Syntax:
rfc2544 testsuite add <testsuite-name>
{ {name <testsuite-name>}
{description <testsuite-desc>}
{port <port-name>} |
{jumbo <0-10240>} |
{binary-duration <decimal>} |
{strict-failure {enable | disable}} |
{verbose {enable | disable}} |
{exclude-vlan-size {yes | no}} |
{peer <packet-params> } |
{back2back {{duration <decimal>} |
{repeat <decimal>} |
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.
Packet syntax:
rfc2544 testsuite add <testsuite-name> peer
{ {packet-type {layer-2 | l2-accedian | l2-generic |
layer-3 | l3-generic}} |
{dst-mac-addr <mac-addr>} |
{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-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 0x8100 for 802.1Q network,
0x9100 for 802.1Q tunneling network, or 0x88A8 for 802.1AD
network.
vlan1-cfi First VLAN CFI may be 0 or 1. It is usually set to 0.
Description:
This command deletes an existing RFC-2544 testsuite instance or an existing RFC-2544
testsuite report.
Syntax:
rfc2544 testsuite delete { {<testsuite-name>} |
reports {<report-name>}}+
Parameters:
testsuite-name <string> Unique name for this testsuite.
report-name <string> Unique name for this report.
Description:
rfc2544 testsuite edit changes the configuration of an existing RFC-2544 testsuite instance.
Syntax:
rfc2544 testsuite edit <testsuite-name>
{ {name <testsuite-name>}
{description <testsuite-desc>}
{port <port-name>} |
{jumbo <0-10240>} |
{binary-duration <decimal>} |
{strict-failure {enable | disable}} |
{verbose {enable | disable}} |
{exclude-vlan-size {yes | no}} |
{peer <packet-params> } |
{back2back {{duration <decimal>} |
{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
haracteristics.
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.
Packet syntax:
rfc2544 testsuite edit <testsuite-name> peer
{ {packet-type {layer-2 | l2-accedian | l2-generic |
layer-3 | l3-generic}} |
{dst-mac-addr <mac-addr>} |
{ethertype <0-65535>} |
{vlan1-header {enable | disable}} |
{vlan1-ethertype <0-65535>} |
{vlan1-priority <0-7>} |
{vlan1-id <0-4095>} |
{vlan1-cfi <0-1>} |
{vlan2-header {enable | disable}} |
{vlan2-ethertype <0-65535>} |
{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 0x8100 for 802.1Q network,
0x9100 for 802.1Q tunneling network, or 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 0x8100 for 802.1Q network,
0x9100 for 802.1Q tunneling network, or 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).
* Ethertype values 0x9100 and 0x88A8 are considered an S-VLAN. The S-VLAN
Ethertype used here is the value configured in the global setting.
Description:
This command displays the RFC-2544 testsuite configuration. Specifying a testsuite name
displays the detailed configuration for this testsuite. Otherwise, the command provides a
summary of the configured testsuites.
Syntax:
rfc2544 testsuite show configuration [<testsuite-name>]
Parameters:
<testsuite-name> <string> Name of the specific testsuite for which to display the
configuration.
Description:
This command displays the RFC-2544 testsuite reports. Specifying a report name displays the
complete report on the screen. Otherwise, the command provides a summary of the
configured reports.
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.
Description:
This command starts the specified and creates a new report.
Syntax:
rfc2544 testsuite start filename <filename> suite <testsuite-name>
{ {description <report-desc>} |
{technician <report-tech>} |
{note <report-note>} }+
Parameters:
filename <string> Unique filename for the report.
suite <string> Name for the testsuite to run.
description <string> Description for this report.
technician <string> Name of the technician running this testsuite.
note <string> Note associated to this testsuite. This note will be
included in the report.
Description:
This command stops the execution of a running RFC-2544 testsuite.
Syntax:
rfc2544 testsuite stop <filename>
Parameters:
filename <string> Unique filename associated with the testsuite.
Description:
This command is used to upload an RFC-2544 report file to a remote location.
Syntax:
rfc2544 testsuite upload <filename> <url>
Parameters:
filename <string> Unique filename associated with the testsuite.
url URL to reach the server and directory, e.g.:
ftp://username:password@mypc.com
ftps://username:password@192.168.10.10
sftp://username:password@192.168.10.10
tftp://192.168.1.5
scp://username:password@192.168.10.10:/target_directory
The filename of the report will be automatically appended to the specified
URL.
Description:
The route add/edit or ipv6_add/ipv6_edit command lets you add or modify the IPv4 or IPv6
system routing table.
Syntax:
route {add|edit} <route-name> { {type {host | net}} |
{destination <ip-addr>} |
{netmask <ip-addr>} |
{gateway <ip-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.
Description:
The route delete or ipv6_delete commands let you delete configured IPv4 or IPv6 routes in
the system.
Syntax:
route {delete|ipv6_delete} <route-name>
Parameters:
<route-name> <string>
Description:
The route show or route ipv6_show commands let you show active and configured IPv4 or
IPv6 routes in the system.
Syntax:
route {show|ipv6_show} active
route {show|ipv6_show} [configuration [<route-name>]]
Parameters:
<route-name> <string>
Description:
Add a performance metric to Service Availability instance.
Syntax:
sa add metric <sa-name> <metric-name> {
{paa-plr <paa-id>} |
{paa-ow-delay <paa-id>} |
{paa-ow-dv <paa-id>} |
{paa-tw-delay <paa-id>} |
{paa-tw-dv <paa-id>} |
{cfm-plr <pl-id>} |
{dmm-ow-delay <dmm-id>} |
{dmm-ow-dv <dmm-id>} |
{dmm-tw-delay <dmm-id>} |
{dmm-tw-dv <dmm-id>} |
{slm-near-end-plr <slm-id>} |
{slm-far-end-plr <slm-id>} |
{threshold <decimal>} }+
<dmm-id> = <decimal> | <string>
<paa-id> = <decimal> | <string>
<pl-id> = <decimal> | <string>
<slm-id> = <decimal> | <string>
<metric-name> = <string>
<sa-name> = <string>
Parameters:
<sa-name> The name of a service availability instance.
<metric-name> A unique name to identify a metric instance inside a service
availability instance.
Description:
Creates a Service Availability instance.
Syntax:
sa add service <sa-name> {
{window-size <decimal>} |
{reporting-period <decimal>} |
{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.
Description:
Clear service availability counters.
Syntax:
sa clear service counters [name <sa-name>] [type {periodic|monotonic|all}]
<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.
Description:
Remove a performance metric from a Service Availability instance.
Syntax:
sa delete metric <sa-name> <metric-name>
<sa-name> = <string>
<metric-name> = <string>
Parameters:
<sa-name> The name of a service availability instance.
<metric-name> The name of the metric to remove.
Description:
Delete a Service Availability instance.
Syntax:
sa delete service <sa-name>
<sa-name> = <string>
Parameters:
<sa-name> A unique name identifying a service availability instance.
Description:
Modify a performance metric on a Service Availability instance.
Syntax:
sa edit metric <sa-name> <metric-name> {
name <metric-name> threshold {<plr-thld> | <delay-thld>}}
<sa-name> = <string>
<metric-name> = <string>
<delay-thrld> = <decimal>
<plr-thld> = <decimal>
Parameters:
<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
Description
Use this command to edit an existing Service Availability (SA) instance. SA is used to calculate
the number of seconds for which a specific service is unavailable. Each SA instance is
configured with one or more SA metrics such as CFM frame loss that are used to determine
the unavailable seconds.
Syntax
sa edit service <sa-name> {{name <string>} |
{window-size <decimal>} |
{time-interval <decimal>} |
{hli-window-size <decimal>} |
{reporting-period <decimal>} |
{state <is | oos>} |
{client-port-cutoff-state <enable | disable>} |
{client-port <port-name>} |
{client-port-cutoff-delay <decimal>} |
{client-port-restore-delay <decimal>}}+
<sa-name> = <string>
<port-name> = <string>
Parameters
<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.
Description:
Display detailed performance metric configuration.
Syntax:
sa show metric configuration <sa-name> <metric-name>
<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.
Description:
Display metric counters for a service availability instance. When a metric instance name is
specified, detailed availability counters are displayed for the specified instance. Otherwise, a
summary of all metric counters for the service instance are displayed.
Syntax:
sa show metric counters <sa-name> [<metric-name>] [type historic
{buckets | period } value]
Parameters:
<metric-name> An optional metric instance name to display.
type historic The type of history statistics to retrieve.
Options are buckets or periods.
Description:
Display service availability configuration. When an instance name specified, a detailed
configuration report is displayed for the specified instance. Otherwise, a configuration
summary for all instances is displayed.
Syntax:
sa show service configuration [<sa-name>]
<sa-name> = <string>
Parameters:
<sa-name> Optional service instance name to display.
Description:
Display service availability counters. When an instance name is specified, detailed availability
counters are displayed for the specified instance. Otherwise, a summary of all availability
counters for all instances are displayed. Additionally, if the history feature is enabled, history
information may be displayed by specifying the type.
Syntax:
sa show service counters [<sa-name>] [type historic {buckets | period }
value]
<sa-name> = <string>
Parameters:
<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.
Description:
This command is used to clear all the SAT protocol server statistics.
Syntax:
sat-protocol clear statistics
Description:
This command is used to modify the SAT protocol configuration parameters.
Syntax:
sat-protocol edit {
{state {enable | disable}} |
{sat-udp-port <1025-32767>} |
{ow-udp-port <1025-32767>}}+
Parameters:
state Enable the SAT protocol on this unit.
sat-udp-port This is the UDP port used for this protocol (1025-32767).
ow-udp-port This is the One-way traffic UDP port (1025-32767).
Description:
This command displays the protocol configuration.
Syntax:
sat-protocol show configuration
Description:
This command displays the protocol current server sessions.
Syntax:
sat-protocol show sessions
Description:
This command displays the SAT protocol server statistics.
Syntax:
sat-protocol show statistics
Description:
This command allows to change the parameters of the SAT reporting feature.
Syntax:
sat-reporting edit {
{rfc2544-reporting {disable | enable}} |
{rfc2544-txt-transfer {disable | enable}} |
{rfc2544-xml-transfer {disable | enable}} |
{y1564-reporting {disable | enable}} |
{y1564-txt-transfer {disable | enable}} |
{y1564-xml-transfer {disable | enable}} |
{url <url>} |
{scp-password <password>}}+
Parameters:
rfc2544-reporting Enable transfer of RFC-2544 report.
rfc2544-txt-transfer Send RFC-2544 text file to the server.
Description:
The command displays the SAT reporting configuration.
Syntax:
sat-reporting show configuration
Description
session edit allows you to change the maximum number of sessions allowed at one time as
well as the timeout values for idle sessions.
Syntax
session edit {
{auth-order {local | radius | local-radius |
radius-local | strict-radius-local |
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.
Description:
session show configuration will show the maximum number of sessions allowed at a time as
well as the timeout values for idle sessions.
Syntax:
session show configuration
Description:
session show status will show the status and information about all logged in users.
Syntax:
session show status
Description:
session terminate will terminate the specified GUI or CLI session. The session identifier is listed
in session show status.
Syntax:
session terminate {<session-id>}
Parameters:
<session-id> <decimal>
Description:
sfp dump prints SFP memory contents.
Syntax:
sfp dump {<connector-name> | <port-name>}
Description
Used to edit the SFP identified by connector-name or port-name and change its configuration
according to the parameters provided.
Syntax
sfp edit {<port-name>|<connector-name>} {speed {Auto|100M|1G|10G}}+
Description
Used to display the SFP configuration. When the port or connector name identifier is omitted,
a summary table for all ports is printed. When a port or connector name is specified then the
detailed SFP configuration is displayed.
Syntax
sfp show configuration [<port-name> | <connector-name>]
Description
Used to display the SFP status. When the port or connector name identifier is omitted, a
summary table for all ports is printed. When a port or connector name is specified then the
detailed SFP status is displayed.
Syntax
sfp show status [<connector-name> | <port-name>]
NOTE: A speed marked with a * in the output identifies the overridden speed as oppose
to the detected speed.
Description:
Create a new queuing profile.
Syntax:
shaping add queuing-profile <queuing-profile-name> {
{port <port-name>} |
{cos-mapping {queue-name,queue-name,...}}}+
Parameters:
port Port assigned to the envelope.
cos-mapping Queuing Profile internal CoS mapping. All 8 internal CoS must be
specified. (ex: PORT-1-1,PORT-1-3,PORT-1-3,.PORT-1-1 is for CoS
0 PORT-1-3 is for CoS 1 PORT-1-3 is for CoS 2, ...)
Description:
Clear the queue statistics. If no parameters are passed, all queue statistics will be cleared. If
port is specified, only the queue statistics associated to this port will be cleared.
Syntax:
shaping clear queue statistics {
{name <queue name>} |
{port <port-name>}}+
Parameters:
name Queue name for which statistics will be cleared
port Port name for which all queues statistics will be cleared.
Description:
Delete a Queuing Profile from the Queuing Profile list.
Syntax:
shaping delete queuing-profile <queuing-profile name>
Parameters:
N/A
Description:
Allow a user to edit the configuration of the Default Queuing Profile
Syntax:
shaping edit default-queuing-profile <port name> {
{cos-mapping <queue name list>} |
Parameters:
cos-mapping Queuing Profile internal COS mapping. All 8 internal COS must be
specified. (ex: PORT-1-1,PORT-1-3,PORT-1-3,...PORT-1-1 is for
COS 0 PORT-1-3 is for COS 1 PORT-1-3 is for COS 2, ...)
Description
Allow a user to modify the configuration of a Port Shaper.
Syntax
shaping edit port-shaper <port name> {
{cbs <1- 8000 >} |
{cir <0-1000000>} |
{cpu-cir-state <enable | disable>} |
{state <enable | disable>}}+
Parameters
cbs Commited Burst Size, in steps of 1KiB (1024 bytes)
cir Commited Information Rate. (in steps of 125Kbps)
Description:
Allow a user to modify the Queue configuration parameters.
Syntax:
shaping edit queue <queue name> {
{blue-state <enable | disable>} |
{blue-decrement <0-25>} |
{blue-freeze-time <0-655350>} |
{blue-increment <0-25>} |
{blue-max-level <5-98>} |
{blue-min-level <5-98>} |
{color <green | yellow>} |
{max-queue-size <16-8000>} |
{name <new name>} |
{priority <0-7>} |
{yellow-threshold <16-Maximum Queue Size >}}+
Parameters:
blue-state Enable the Blue algorithm for this queue.
blue-decrement Blue drop probability decrement (steps of 1%)
blue-freeze-time Blue minimum interval time, in us, between two successive
updates of the marking probability. (steps of 10us)
blue-increment Blue drop probability increment (steps of 1%)
blue-max-level Blue level for which drop probability increase (% of queue length)
blue-min-level Blue level for which drop probability decrease (% of queue
length)
color Frame color when shaping is disabled.
max-queue-size Threshold from which tail drop begin on green frame (steps of
1KiB (1024 bytes)). Dedicated queue range: 16-8000
name Queue name
priority Queue priority, used for round-robin purpose.
yellow-threshold Threshold from which tail drop begin on yellow frame (steps of
1KiB) queue range: 16-1800.
Description:
Allow a user to modify the parameters of a Queuing Profile.
Syntax:
shaping edit queuing-profile <queuing profile name> {
{cos-mapping <queue name list>} |
{name <new name>}}+
Parameters:
cos-mapping Queuing Profile internal COS mapping. All 8 internal COS must be
specified. (ex: PORT-1-1,PORT-1-3,PORT-1-3,... PORT-1-1 is for
COS 0 PORT-1-3 is for COS 1 PORT-1-3 is for COS 2, ...)
name Queuing Profile name
Description:
This command displays detailed configuration for the default queuing profile.
Syntax:
shaping show default-queuing-profile configuration <port name>
Parameters:
N/A
Description:
Without arguments, this command displays the port shaper summary in a table format. When
specifying a port shaper name, this command displays detailed configuration for that port
shaper. The paging option allow to display result in page style.
Syntax:
shaping show port-shaper configuration {
{paging} |
{port <port-name>}}+
Parameters:
paging enable the paging option
port name of the port
Description:
Without arguments or with the port argument, this command displays the queue
configuration summary in a table format. When specifying a queue name, this command
displays detailed configuration for that queue. The paging option allow to display result in
page style.
Syntax:
shaping show queue configuration {
{name <queue name>} |
{paging} |
{port <port-name>}}+
Parameters:
name name of the queue
paging enable the paging option
port name of the port
Description:
Without arguments or with the port argument, this command displays the queue statistics
summary in a table format. When specifying a queue name, this command displays detailed
statistics for that queue. The paging option allow to display result in page style.
Syntax:
shaping show queue statistics {
{name <queue name>} |
{paging} |
{port <port-name>}}+
Parameters:
name name of the queue
paging enable the paging option
port name of the port
Description:
Without arguments or with the port argument, this command displays the queuing-profile
configuration summary in a table format. When specifying a queuing profile name, this
command displays detailed configuration for that queuing profile. The paging option allow to
display result in page style.
Syntax:
shaping show queuing-profile configuration {
{name <queuing profile name>} |
{paging} |
{port <port-name>}}+
Parameters:
name name of the queuing profile
paging enable the paging option
port name of the port
Description:
snmp edit allows you to change the SNMP agent configuration.
Syntax:
snmp edit {
{state {disable | enable}} |
{use-host-name {enable | disable} |
{agent-port <1-65535>} |
{contact-info <string>} |
{ro-community <string>} |
{rw-community <string> } |
{system-location <string>} |
{system-name <string>} |
{authentication-trap {enable | disable}} |
{link-trap {enable | disable}}+
Parameters:
state Enable or disable the SNMP agent.
use-host-name Use the configured host name as system-name.
agent-port Makes the agent listen on the specified UDP port on all
interfaces.
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).
Description:
snmp show displays the SNMP configuration
Syntax:
snmp show
Description:
This command allows you to change the automatic SNMP trap handler configuration.
Syntax:
snmp-trap edit auto {
{host-state {enable | disable}} |
{host-community <string>} |
{host-port <1-65535>}
{trap-version {v1 | v2c}}
{host-name-refresh}
}+
Parameters:
host-state Enable/Disable the sending of SNMP traps to the configured
host.
host-community Community string used to send SNMP traps to configured host.
host-port This command defines the UDP port to use when sending SNMP
traps (the well-known SNMP trap port 162 is used by default).
trap-version Set the version (v1 or v2c) of the configured host SNMP traps.
host-name-refresh Refresh of the configured host name for SNMP traps.
Description:
This command allows you to change the SNMP v1 trap handler configuration.
Syntax:
snmp-trap edit v1 <host-id> {
{host-state {enable | disable}} |
{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).
Description:
This command allows you to change the SNMP v2c trap handler configuration.
Syntax:
snmp-trap edit v2c <host-id> {
{host-state {enable | disable}} |
{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).
Description:
snmp-trap show displays the SNMP trap handler configuration.
Syntax:
snmp-trap show
Description:
After issuing this command, the following statistics will be cleared:
All ports statistics
All policies statistics
All bandwidth regulators statistics
All OAM instances statistics
Syntax:
statistics clear
4.379 Syntax
syntax - Display CLI syntax
Description:
Display CLI syntax explanations.
Syntax:
syntax
Description:
syslog edit controls the system logger. All messages are reported into the system logger and
they are kept or trashed depending on the system logger level. The system logger also
supports remote logging. You can send messages to an external computer. The different
levels for the syslog are:
1. Emergency: system is unusable
2. Alert: action must be taken immediately
3. Critical: critical conditions
4. Error: error conditions
5. Warning: warning conditions
6. Notice: normal, but significant, condition
7. Info: informational message
8. Debug: debug-level message
The syslog level you choose enables all messages from the specified level and all messages
from lower levels. When dev-facility is enabled, all messages are logged using the user-
defined facility instead of the default ones.
Syntax:
syslog edit {{dev-facility {enable | disable} <facility>}
{remote {disable | enable}} |
{host {<host-name>}} |
{remote-priority {<level>}} |
{priority {<level>}} }+
Parameters:
<host-name> <ip-addr> | <FQHN>
<FQHN> <string>
<level> <Emergency|Alert|Critical|Error|Warnin
g|Notice|Info|Debug>
<facility> <LOCAL0|LOCAL1|LOCAL2|LOCAL3|LOCAL4|LO
CAL5|LOCAL6|LOCAL7>
dev-facility Enable or disable device facility to log all messages using
a user-defined facility instead of the default ones.
host The remote address to log messages to.
remote-priority The remote priority level, as listed above.
Description:
syslog show prints the syslog configuration.
Syntax:
syslog show configuration
Description:
syslog show log display the system log.
Syntax:
syslog show log
Description:
syslog show log continuous displays the system log without page breaks. Press CTRL-C to
interrupt.
Syntax:
syslog show log continuous
Description:
Use the system-monitor edit command to modify the system monitor parameters.
Syntax:
system-monitor edit {{configuration <config-params>} |
{system-probe <system-probe-params>} |
{disk-space-probe <disk-space-probe-params>} |
{network-probe <network-probe-params>}}+
Parameters
<config-params> The general configuration (see below).
<system-probe-params> The system-probe configuration (see below).
<disk-space-probe-params> The disk-space-probe configuration (see below).
<network-probe-params> The network-probe configuration (see below).
Description:
system-monitor show displays the current system monitor configuration.
Syntax:
system-monitor show
Description:
This command displays system status (operational readiness)
Syntax:
system show status
Description:
This command is used to add a new HTTP Origin to the authorized origins list.
Syntax:
system add os-service http-server http-origin list <http-origin>
Parameters:
<http-origin> Authorized/white-listed URL
Description:
Use the command system edit os-service http-server to modify http-server configuration.
Syntax:
system edit os-service http-server {
{http-redirect <enable | disable>} |
{CSRF Protection: <enable | disable>} |
{http-service <enable | disable>} |
{https-port 443 | <1024-65535>} |
{http-port 80 | <1024-65535>} |
{http-origin <enable | disable>} }+
Parameters:
<http-redirect> HTTP Redirect option, enable this option to allow redirect from
HTTP to HTTPS.
While disable this option to prevent redirection from HTTP to
HTTPS and turn off HTTP support.
<http-service> HTTP Service, enable or disable HTTP Service is equivalent to
turn on/off the HTTP Server
<https-port> HTTPS Port, set HTTPS Port which is 443 or in range 1024-65535
<http-origin> HTTP Origin, enable or disable HTTP Origin validation.
Description:
Show all available OS services. If an OS service is specified, the detail configuration of that
service will be displayed.
Syntax:
system show os-service {
{http-server}}
Description:
Use the tacacs-plus edit command to modify the TACACS+ parameters required to
authenticate, then authorize management access to the unit.
Note: The new parameters take effect upon the next login attempt.
Syntax:
tacacs-plus edit <parameter> <value>
Parameters:
auth-method Authentication method to use.
auth-server1-host TACACS+ host server to authenticate to.
Enter '0.0.0.0' or '::' to disable this server.
auth-server1-port TACACS+ server TCP port to connect to.
auth-server1-secret Shared secret for server1.
auth-server1-source Optional bind address to access server1.
auth-server2-host Only used if the first host server does not respond.
Enter '0.0.0.0' or '::' to disable this server.
auth-server2-port TACACS+ server TCP port to connect to.
auth-server2-secret Shared secret for server2.
auth-server2-source Optional bind address to access server2.
timeout The time to wait for the TACACS+ server to respond before
retrying the connection, in seconds. After the number of retries
has been exhausted, a connection to the next configured server
will be attempted, in which the same timeout and retry scheme
will apply.
retries Number of times to retry the server before trying with the next
configured server.
Note: The new parameters take effect upon the next login attempt.
Syntax:
tacacs-plus edit {
Parameters:
auth-method Authentication method to use.
auth-server1-host TACACS+ host server to authenticate to.
Enter '0.0.0.0' or '::' to disable this server.
auth-server1-port TACACS+ server TCP port to connect to.
auth-server1-secret Shared secret for server1.
auth-server1-source Optional bind address to access server1.
auth-server2-host Only used if the first host server does not respond.
Enter '0.0.0.0' or '::' to disable this server.
auth-server2-port TACACS+ server TCP port to connect to.
auth-server2-secret Shared secret for server2.
auth-server2-source Optional bind address to access server2.
timeout The time to wait for the TACACS+ server to respond before
retrying the connection, in seconds. After the number of retries
has been exhausted, a connection to the next configured server
will be attempted, in which the same timeout and retry scheme
will apply.
retries Number of times to retry the server before trying with the next
configured server.
Description:
Used to show the summary of TACACS+ configurations.
Syntax:
tacacs-plus show
Syntax:
tacacs-plus show
Description:
Test is similar to a ping but at a higher level in the protocol stack. The test attempts to
connect to a TCP port to verify if a service is reachable.
Syntax:
tcp-connect host {host | net} |
{port <tcp-port>} |
{timeout <time-in-seconds>} }
Parameters:
host The remote address or domain name to test.
port TCP port (service) to test.
timeout Time in seconds before giving up.
Description:
The tech-support export command allows you to export the existing report.
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
Description:
The tech-support generate command allows you to generate a report from current system
health state.
Syntax:
tech-support {generate} |
Description:
The tech-support show command allows you to display the latest report available.
Syntax:
tech-support {show} |
Description:
The tech-support show report transmission command allows you to display the latest report
transmission available.
Syntax:
{show report-transmission} |
Description:
The tech-support edit report transmission command allows you to edit the report
transmission configuration.
Syntax:
{edit report-transmission <config-params>}
4.400 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)
-s IP address to use as the source address
-t Type-of-service in probe packets (default 0)
-w Time in seconds to wait for a response (default 3)
-g Loose source route gateway (8 max)
4.401 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]
Options:
-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 is 33434)
-q Number of probes per TTL (default 3)
-s IP address to use as the source address
-t Type-of-service in probe packets (default 0)
-w Time in seconds to wait for a response (default 3)
Description:
traffic edit allows you to configure options related to traffic policy lists.
Syntax:
traffic edit mode [policy_list] {
{vid-set {inner | outer}} }+
Parameters:
vid-set When using traffic policies with VLAN sets, this option is used to
inspect the inner or the outer VLAN for each policy list. The
default is outer VLAN. When using the option as inner VLAN, the
outer VLAN will be ignored.
Description:
Displays which VLAN (inner or outer) is inspected by policy lists.
Syntax:
traffic show
Description:
Clear TWAMP flows statistics.
Syntax:
twamp clear statistics [<identifier>]
<identifier> = <decimal>
Parameters:
<identifier> An optional unique index identifying the instance.
Description:
Edit TWAMP configuration.
Syntax:
twamp edit {
{udp-port <decimal>} |
{state <enable | disable>}}+
Parameters:
state The state of the instance (disabled by default).
udp-port The UDP port used (default 862, valid ports: 1025-65535).
Description:
Create a TWAMP session.
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.
Description:
Delete a TWAMP session.
Syntax:
twamp-gen delete <index>
<index> = <decimal>
Parameters:
index Specifies the TWAMP instance.
Description:
Edit a TWAMP session.
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.
Description:
Display a summary of the configured TWAMP instances. When an instance index is specified,
a detailed configuration report is displayed.
Syntax:
twamp-gen show configuration [<index>]
<index> - <decimal>
Parameters:
index Specifies the TWAMP instance.
Description:
Display TWAMP session measurements and status.
Syntax:
twamp-gen show results [<index>] {
{ type {historic}} |
{ buckets <0-16>} |
{ period <period-id>}}+
<index> - <decimal>
<period-id> - <decimal>
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.
Description:
Display TWAMP sessions's status.
Syntax:
twamp-gen show status [<index>]
<index> - <decimal>
Parameters:
index Specifies the TWAMP instance.
Description:
Display TWAMP configuration.
Syntax:
twamp show configuration
Description:
Display TWAMP statistics.
Syntax:
twamp show statistics
Description:
The user add command allows you to add users who can access the unit.
You can use user edit when you need to modify a user configuration.
If you use the <password> keyword in one of these commands, you will be prompted to enter
your password after the command. You will need to confirm your password as well. If you do
not use the password keyword with <user add>, the password will be set the same as the
user name.
Syntax:
user {add | edit} <user-name> {{first <string>} |
{last <string>} |
{email <string>} |
{phone <string>} |
{clearpass <string>} |
{password}}+
Parameters:
<user-name> <string>
first First name of the user.
last Last name of the user.
email The email address of the user.
phone The telephone number of the user.
password Allows to set a password for the user.
clearpass Enter password in cleartext without confirmation.
Description:
user delete allows you to delete an existing user profile.
Syntax:
user delete {<user-name>}
Parameters:
<user-name> <string>
Description:
user permissions edit allows you to modify the permissions that are associated with a
specified user.
Syntax:
user permissions edit {<user-name>} {add-group | delete-group} {<group-
name>}
Parameters:
<user-name> <string>
<group-name> <string>
Description:
This command displays the permission of the group to which the specified user belongs.
Syntax:
user permissions show [<user-name>]
Parameters:
<user-name> <string>
Description:
user show displays the contact information for a given user.
Syntax:
user show [<user-name>]
Parameters:
<user-name> <string>
Description:
Change vcagent related collection setting.
Syntax:
vcagent edit collection
Description:
Change vcagent related configuration setting.
Syntax:
vcagent edit configuration
Description:
vcagent show configuration displays the agent configuration parameters.
Syntax:
vcagent show configuration
Description:
vcagent show descriptors displays the agent JSON descriptors.
Syntax:
vcagent show descriptors
4.423 Version
version - Display CLI version
Description:
Display CLI version.
Syntax:
version
Description:
The vid-set command is used to add a new VID set.
Syntax:
vid-set add <vset-name> {
{policy-list <policy list>} |
{vlan-type {c-vlan | s-vlan}} |
{vid-list <vlist>}}+
Parameters:
<vset-name> <string>
policy-list Name of the policy list to which the VID set will be associated.
vlan-type VLAN type associated with the VID set.
vid-list List of VIDs to include in this VID set. Specify a list of VIDs in the
following format: [- ], [- ]…(e.g. 1,2,100-200 will include VIDs 1, 2,
and 100 to 200).
Description:
vid-set delete allows you to delete an existing VID set.
Syntax:
vid-set delete <vset-name>
Parameters:
<vset-name> <string>
Description:
vid-set edit allows you to change the parameters in existing VID sets.
Syntax:
vid-set edit <vset-name> {
{name <vset-name>} |
{vid-list <vlist>}}+
Parameters:
<vset-name> <string>
name New name given to this VID set.
vid-list List of VIDs to include in this VID set. Specify a list of VIDs in the
following format: [- ], [- ]... (e.g. 1,2,100-200 will include VIDs 1, 2,
and 100 to 200).
Description:
Specifying an attribute provides detailed configuration about the matching VID set. A
combination of policy list and VLAN type is also allowed.
Otherwise, the command provides a summary configuration for all VID sets in a table format.
Syntax:
vid-set show set {
{name <vset-name>} |
Parameters:
<vset-name> <string>
<policy list> <string>
name VID set name is given to show configuration.
paging Enable/Disable the paging option
policy-list Name of the policy list to which the VID set will be associated.
vlan-type VLAN type associated with the VID set.
Description:
Specifying an attribute provides detailed configuration about the matching VID set. A
combination of policy list, VLAN type and state is also allowed. Otherwise, the command
provides a summary configuration for all VID sets in a table format.
Syntax:
vid-set show vid {
{paging {enable | disable}} |
Parameters:
<policy list> <string>
pging Enable/Disable the paging option
policy-list Name of the policy list to which the VID set will be associated.
vlan-type VLAN type associated with the VID set.
state The state of the VID set.
Description:
Used to add a new virtual connection association by specifying a list of one or more VCEs.
Syntax:
virtual-connection add vca <vca-name> {{vce-list <vce-name>+} }+
Parameters:
<vca-name> <string>.
vce-list A comma separated list of VCE instances referenced by name.
Description:
Used to add a new Virtual Connection Element.
Syntax:
virtual-connection add vce <vce-name> <type> {Customer | Operator | Tunnel}
{
{tpid {0x8100 | 0x88a8 | 0X9100} |
{from-tp {internal | external} |
{from-tp-port {PORT-n, LAG-n} |
{from-tp-vid <1-4095>} |
{from-tp-port-vid <1-4094>} |
{onto-tp {internal | external} |
{onto-tp-port {PORT-n, LAG-n} |
{onto-tp-vid <1-4095>} |
{frame-type {all-to-one | untagged | vlan-tagged | any}} |
{vid-relay-action {preserve | untag | translate | tag}} }+
Parameters:
<vce-name> <string>.
type Choose the type of VCE component: Customer, Operator or
Tunnel.
tpid The VLAN TPID attributed to this VCE (0x8100, 0x88a8 or
0x9100).
component-id The ID of the Component into which the VCE will be attached.
Specifying 0 indicates that the system shall automatically assign
a component ID.
tp-a Defines the type of interface tp-a is connected to. The TP can be
connected to another VCE (internal) or an external port
(external).
tp-a-port Specifies the physical port when tp-a is configured as external.
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
Description:
Used to delete a VCA object.
Syntax:
virtual-connection delete vca <vca-name>
Parameters:
<vca-name> <string>
Description:
Used to delete an existing VCE object.
Syntax:
virtual-connection delete vce <vce-name>
Parameters:
<vce-name> <string>
Description:
Used to edit an existing VCA object. An implicit VCA cannot be modified.
Syntax:
virtual-connection edit vca <vca-name> {
{name <vca-name>} |
{vc-list <vc-name>+} }+
Parameters:
<vca-name> <string>.
name Unique name associated to the VCA instance.
vc-list A comma separated list of VCE or implicit VCA containing a VCE
tunnel instances referenced by name.
Description:
Used to edit an existing VCE object.
Syntax:
virtual-connection edit vce <vce-name> {
{name <vce-name>} |
Parameters:
<vce-name> <string>.
name Unique name associated to the VCE instance.
from-tp Defines the type of interface form-tp is connected to.
from-tp-vid For VID values 1-4095, all combinations are allowed. Ex:
<1-10, 15, 20-25>.
from-tp-port-vid Used when vce type is set to 'Customer'.
Used to assign a VID to frames when frame-type is configured as
'untagged'. A single VLAN-ID chosen from the range 1..4094 is
assigned to this parameter.
onto-tp Defines the type of interface onto-tp is connected to.
onto-tp-vid It is applicable when 'vid-relay-action' is set to 'translate' or 'tag'.
Only a single value for the VID may be specified.
vid-relay-action Usage is dependent on VCE type. Used to translate from-tp-vid
to onto-tp-vid when a single VLANID is used. If a set of VIDs is
provided for 'from-tp-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.
Default value depends on vce 'type'.
Description:
Without arguments, this command displays the VCA configuration summary in a table format.
When specifying a VCA name, this command displays the detailed configuration for that VCA.
Syntax:
virtual-connection shows vca configuration [<vca-name>]
Parameters:
<vca-name> <string>
Description:
Used to display a summary of vce configurations.
Syntax:
virtual-connection shows vce configuration {<layer-2> | <vce-name>}
Parameters:
<vce-name> <string>
Description:
With y1564 add test, you can create a new Y.1564 test and set its parameters.
Syntax:
y1564 add test <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>}}+
{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:
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).
Description:
Delete an instance of Y.1564 test report.
Syntax:
y1564 delete report <report-name>
<report-name> = <string>
Parameters:
<report-name> A unique name to identify an instance of Y.1564 test report.
Description:
Delete an instance of Y.1564 test.
Syntax:
y1564 delete test <test-name>
<test-name> = <string>
Parameters:
<test-name> A unique name to identify an instance of Y.1564 test.
Description:
After a Y.1564 test has completed, the report can be edited to modify or add information such
as: name, description, note, technician's name.
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.
Description:
With y1564 edit service, you change the configuration of a service under a specific test.
Syntax:
y1564 edit service <test-name> <service-id> {
{name <service-name>} |
{state {enable | disable}} |
{policing {enable | disable}} |
{step {enable | disable}} |
{availability {enable | disable}} |
{cir <0 to max-port-speed>} |
{cbs <0 to 10000>} |
{eir <0 to max-port-speed>} |
{ebs <8>}|
{size-type {fixed}} |
{packet-size <64 to 10240>} |
{ftd <decimal>} |
{ftd-type {max|avg}} |
{fdv <decimal>} |
{fdv-type {max|avg}} |
{flr <exponent>} |
{m-factor <decimal>} |
{dst-ipv4-overwrite {enable|disable}} |
{dst-ipv4-addr <ip-addr>} |
{dscp-overwrite {enable|disable}} |
{dscp <0-63>} |
{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}} |
Parameters:
name The name of a service.
disable | enable To enable or disable the field in the check.
state Enable this service for this specific test.
policing nable policing testing.
step Enable step testing.
availability Enable Availability measurement.
cir committed information rate in kbps.
cbs Committed burst size in KiB (1024 bytes)
eir excess information rate in kbps.
ebs Excess burst size in KiB (1024 bytes).
size-type Packet sizes is limited to fixed only, no support for EMIX available
in this product.
packet-size For a fixed packet, specify the packet size.
Maximum packet size is 10240.
ftd Maximum/average two-way Frame Transfer Delay (FTD) allowed
(in micro-seconds).
ftd-type Determines whether if the Frame Transfer Delay (FTD)
parameter is a maximum or average value.
fdv Maximum/average two-way Frame Delay Variation (FDV)
allowed (in micro-seconds).
fdv-type Determines whether if the Frame Delay Variation (FDV)
parameter is a maximum or average value.
flr Maximum Frame Loss Ratio (FLR) allowed.
m-factor The M factor is added to the Service Acceptance Criteria in the
policing test to take into account the effect of the CBS and EBS
on the total rate.
Description:
With y1564 edit test, you can change the parameters of an existing test.
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).
Description:
This command allows to generate a Y.1564 test report.
Syntax:
y1564 generate report <filename> [report-type {report-type-txt |
report-type-xml}]
Parameters:
filename <string> Unique filename associated with the report.
report-type Report type (XML, TXT) to generate.
Description:
This command displays the Y.1564 test activation. i.e. its name, status and description. If a
specific test name is specified, a full test activation will be displayed (name, status, service
name, and progression of each test step).
Syntax:
y1564 show activation <filename>
Parameters:
<filename> <string> Unique filename associated with the activation.
Description:
The command displays the configuration for a specific service.
Syntax:
y1564 show service configuration <test-name> <service-id>
Parameters:
<test-name> A unique name used to identify a Y.1564 in the system.
<service-id> A unique id used to identify a service in this test.
Description:
This command displays the Y.1564 test configuration. Specifying a test name provides detailed
configuration about this test. Otherwise, the command provides a summary of the configured
test.
Syntax:
y1564 show test configuration <test-name>
Parameters:
<test-name> <string> Name of the specific test to display the configuration.
Description:
This command starts the specified Y.1564 test and creates a new report.
Syntax:
y1564 start activation filename <filename> test <report-test>
{ {description <report-desc>} |
{technician <report-tech>} |
{note <report-note>} }+
Parameters:
filename <string> Unique filename for the report.
test <string> Name for the Y.1564 test to run.
description <string> Description for this report.
technician <string> Name of the technician running this test.
note <string> Note associated to this test. This note will be included in
the report.
Description:
This command stops the execution of the specified test.
Syntax:
y1564 stop activation filename <filename>
Parameters:
filename <string> Unique filename where the report will be stored.
Description:
This command allows to upload a Y.1564 test report to a remote location.
Syntax:
y1564 upload report <filename> <url> [report-type {report-type-txt |
report-type-xml}]
Parameters:
filename <string> Unique filename associated with the report.
url URL to reach the server and directory, e.g.
ftp://username:password@mypc.com
ftps://username:password@192.168.10.10
sftp://username:password@192.168.10.10
tftp://192.168.1.5
scp://username:password@192.168.10.10:/target_
directory
The filename of the report will be automatically appended to the
specified URL.
report-type Report type (XML, TXT) to upload to server.