Acx6160-Roadm Yang Model
Acx6160-Roadm Yang Model
Guide
Published
2020-10-19
ii
Juniper Networks, the Juniper Networks logo, Juniper, and Junos are registered trademarks of Juniper Networks, Inc. in
the United States and other countries. All other trademarks, service marks, registered marks, or registered service marks
are the property of their respective owners.
Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right
to change, modify, transfer, or otherwise revise this publication without notice.
The information in this document is current as of the date on the title page.
Juniper Networks hardware and software products are Year 2000 compliant. Junos OS has no known time-related
limitations through the year 2038. However, the NTP application is known to have some difficulty in the year 2036.
The Juniper Networks product that is the subject of this technical documentation consists of (or is intended for use with)
Juniper Networks software. Use of such software is subject to the terms and conditions of the End User License Agreement
(“EULA”) posted at https://support.juniper.net/support/eula/. By downloading, installing or using such software, you
agree to the terms and conditions of that EULA.
iii
Table of Contents
About the Documentation | viii
Merging a Snippet | ix
Documentation Conventions | x
1 Introduction
ACX6160 Overview | 16
ACX6160 Overview | 16
Features | 17
Performance Monitoring | 18
One-Touch Provisioning | 18
Management Ports | 19
NETCONF API | 20
Introduction | 23
Equipment Provisioning | 29
ACX6160 Ports | 31
Interfaces | 45
Connectivity | 56
Transponder Information | 59
v
Maintenance Testing | 61
PRBS | 62
Alarm Monitoring | 64
Performance Monitoring | 71
Performance Monitoring | 72
NETCONF Notifications | 83
Notifications | 83
Interleave | 84
Replay | 84
3 System Administration
User Administration | 87
SFTP Client | 90
Software Upgrades | 93
Manifest Files | 94
Firmware Upgrades | 99
Firmware Upgrade | 99
Open ROADM Create Tech Info Notification YANG Model Support | 109
Open ROADM Set Current Date and Time YANG Model Support | 109
4 Maintenance Signaling
Maintenance Signaling | 112
IN THIS SECTION
Documentation Conventions | x
Use this guide to understand and configure the features of the ACX6160.
®
To obtain the most current version of all Juniper Networks technical documentation, see the product
documentation page on the Juniper Networks website at https://www.juniper.net/documentation/.
If the information in the latest release notes differs from the information in the documentation, follow the
product Release Notes.
Juniper Networks Books publishes books by Juniper Networks engineers and subject matter experts.
These books go beyond the technical documentation to explore the nuances of network architecture,
deployment, and administration. The current list can be viewed at https://www.juniper.net/books.
If you want to use the examples in this manual, you can use the load merge or the load merge relative
command. These commands cause the software to merge the incoming configuration into the current
candidate configuration. The example does not become active until you commit the candidate configuration.
If the example configuration contains the top level of the hierarchy (or multiple hierarchies), the example
is a full example. In this case, use the load merge command.
If the example configuration does not start at the top level of the hierarchy, the example is a snippet. In
this case, use the load merge relative command. These procedures are described in the following sections.
ix
1. From the HTML or PDF version of the manual, copy a configuration example into a text file, save the
file with a name, and copy the file to a directory on your routing platform.
For example, copy the following configuration to a file and name the file ex-script.conf. Copy the
ex-script.conf file to the /var/tmp directory on your routing platform.
system {
scripts {
commit {
file ex-script.xsl;
}
}
}
interfaces {
fxp0 {
disable;
unit 0 {
family inet {
address 10.0.0.1/24;
}
}
}
}
2. Merge the contents of the file into your routing platform configuration by issuing the load merge
configuration mode command:
[edit]
user@host# load merge /var/tmp/ex-script.conf
load complete
Merging a Snippet
1. From the HTML or PDF version of the manual, copy a configuration snippet into a text file, save the
file with a name, and copy the file to a directory on your routing platform.
For example, copy the following snippet to a file and name the file ex-script-snippet.conf. Copy the
ex-script-snippet.conf file to the /var/tmp directory on your routing platform.
x
commit {
file ex-script-snippet.xsl; }
2. Move to the hierarchy level that is relevant for this snippet by issuing the following configuration mode
command:
[edit]
user@host# edit system scripts
[edit system scripts]
3. Merge the contents of the file into your routing platform configuration by issuing the load merge
relative configuration mode command:
For more information about the load command, see CLI Explorer.
Documentation Conventions
Laser warning Alerts you to the risk of personal injury from a laser.
Table 2 on page xi defines the text and syntax conventions used in this guide.
Bold text like this Represents text that you type. To enter configuration mode, type
the configure command:
user@host> configure
Fixed-width text like this Represents output that appears on user@host> show chassis alarms
the terminal screen.
No alarms currently active
Italic text like this • Introduces or emphasizes important • A policy term is a named structure
new terms. that defines match conditions and
• Identifies guide names. actions.
Italic text like this Represents variables (options for Configure the machine’s domain
which you substitute a value) in name:
commands or configuration
[edit]
statements.
root@# set system domain-name
domain-name
Text like this Represents names of configuration • To configure a stub area, include
statements, commands, files, and the stub statement at the [edit
directories; configuration hierarchy protocols ospf area area-id]
levels; or labels on routing platform hierarchy level.
components. • The console port is labeled
CONSOLE.
< > (angle brackets) Encloses optional keywords or stub <default-metric metric>;
variables.
# (pound sign) Indicates a comment specified on the rsvp { # Required for dynamic MPLS
same line as the configuration only
statement to which it applies.
[ ] (square brackets) Encloses a variable for which you can community name members [
substitute one or more values. community-ids ]
GUI Conventions
xiii
Bold text like this Represents graphical user interface • In the Logical Interfaces box, select
(GUI) items you click or select. All Interfaces.
• To cancel the configuration, click
Cancel.
> (bold right angle bracket) Separates levels in a hierarchy of In the configuration editor hierarchy,
menu selections. select Protocols>Ospf.
Documentation Feedback
We encourage you to provide feedback so that we can improve our documentation. You can use either
of the following methods:
• Online feedback system—Click TechLibrary Feedback, on the lower right of any page on the Juniper
Networks TechLibrary site, and do one of the following:
• Click the thumbs-up icon if the information on the page was helpful to you.
• Click the thumbs-down icon if the information on the page was not helpful to you or if you have
suggestions for improvement, and use the pop-up form to provide feedback.
Technical product support is available through the Juniper Networks Technical Assistance Center (JTAC).
If you are a customer with an active Juniper Care or Partner Support Services support contract, or are
xiv
covered under warranty, and need post-sales technical support, you can access our tools and resources
online or open a case with JTAC.
• JTAC policies—For a complete understanding of our JTAC procedures and policies, review the JTAC User
Guide located at https://www.juniper.net/us/en/local/pdf/resource-guides/7100059-en.pdf.
• JTAC hours of operation—The JTAC centers have resources available 24 hours a day, 7 days a week,
365 days a year.
For quick and easy problem resolution, Juniper Networks has designed an online self-service portal called
the Customer Support Center (CSC) that provides you with the following features:
• Find solutions and answer questions using our Knowledge Base: https://kb.juniper.net/
To verify service entitlement by product serial number, use our Serial Number Entitlement (SNE) Tool:
https://entitlementsearch.juniper.net/entitlementsearch/
You can create a service request with JTAC on the Web or by telephone.
• Visit https://myjuniper.juniper.net.
Introduction
ACX6160 Overview | 16
ACX6160 Overview
IN THIS SECTION
ACX6160 Overview | 16
Features | 17
This topic provides an overview of the ACX6160 transponder and its features.
ACX6160 Overview
The ACX6160 is an Open ROADM compliant disaggregated, multiport transponder solution that supports
the Client and Line ports described in Table 3 on page 16:
TIP: It’s important to understand, in Open ROADM, Ports and Interfaces are two distinct entities.
• Ports are the physical ports on the device, in this case, the Client and Line ports on the ACX6160
front panel.
• Interfaces are configured on a supporting physical port (Client and Line). or another supporting
interface.
17
ACX6160 Ports
The ACX6160 has eight Client ports (labeled 0/0 through 0/7 on the front panel) that support QSFP28
transceivers. These transceivers provide a speed of up to 100 Gbps, through four 25 Gbps channels. By
default, Client ports are configured as 100 Gigabit Ethernet ports.
The ACX6160 has four Line CFP2 ports (labeled 1/0 through 1/3 on the front panel) that support C
form-factor pluggable type 2 transceivers.
ACX6160 Interfaces
The Client and Line ports on the ACX6160 use pluggable optics, enabling you to run various interface
types on the ports. All Client ports use pluggable QSFP28 transceivers that are 100 Gbps. All Line ports
use pluggable CFP2-DCO transceivers that are 100 Gbps and support HGFEC.
Table 4 on page 17 describes the various interfaces available for the ACX6160 Client and Line ports and
the Management port, which is (1000BASE-T).
100 Gigabit Ethernet interface Optical Channel interface (OCH) Ethernet interface
OTN OTU4 (100 Gbps) interface OTN OTU4 (100 Gbps) interface
Features
IN THIS SECTION
Performance Monitoring | 18
One-Touch Provisioning | 18
The ACX6160 is an Open ROADM Multi-Source Agreement (MSA) compliant device. This means it complies
with the specifications described in the agreement for transponder devices. It is compatible with other
devices that comply to this agreement and with Open ROADM controllers.
The Open ROADM MSA device model is a management model defined by the Open ROADM organization.
Its goal is to provide a common management model to simplify the management of multi-vendor optical
network architectures. It defines optical interoperability requirements for the device hardware
Reconfigurable Optical Add/Drop Multiplexers (ROADM), transponders and pluggable optics) and a
NETCONF API that uses Yet Another Next Generation (YANG)-based data models that abstract the
management, control and provisioning of multi-vendor optical devices.
The ACX6160 uses pluggable optics for both the Client and Line ports. The eight Client ports use QSFP28
(100 Gbps) pluggable transceivers and the Line ports use CFP2-DCO (100 Gbps) Coherent DWDM pluggable
transceivers with HGFEC support.
NOTE: Only Juniper Networks branded transceivers are supported on the ports of the ACX6160.
The Juniper Part Number (JPN-SKU).
Performance Monitoring
The ACX6160 includes a rich set of performance monitors that monitor the health of the device and notify
you of any problems. It includes both current and historical performance monitoring and supports the
Open ROADM YANG models for both currentPmlist and historyPmlist.
The ACX6160 supports the performance monitoring capability per the Open ROADM MSA specification
version 2.00, release 2 Device white paper v0.3.
One-Touch Provisioning
The ACX6160 supports one-touch provisioning. All that’s needed to deploy it, is to bring it to the site,
cable the device Ethernet (1000BASE-T) management port to the LAN on which your Open ROADM
controller resides, cable the device power and power it up. The ACX6160 automatically receives a temporary
IP address from your DHCP server, which must also be on same LAN. After the controller recognizes the
ACX6160 as an Open ROADM device, you can assign a permanent IP address and configure the device
using your Open ROADM controller and the Open ROADM YANG data models described in this guide.
19
NOTE: Configuring the FEC mode is mandatory. You must configure the ACX6160 interface for
the HGFEC (QPSK-100G) FEC mode in order to activate the interface. If you do not configure
it, the corresponding CFP2-DCO module is not activated
You can manage the ACX6160 through its NETCONF API using an Open ROADM compliant controller
and the Open ROADM YANG data models described in this guide.
As an Open ROADM-compliant device, the configuration and management of the ACX6160 is controlled
through the Open ROADM controller and stored in the controller server infrastructure and not on the
ACX6160 itself.
Management Ports
You manage the ACX6160 through the Ethernet MGMT port on the front panel. Connect this port to the
same LAN that your Open ROADM controller is on.
RELATED DOCUMENTATION
NETCONF API
Per the Open ROADM requirement, the ACX6160 supports a NETCONF API that allows you to control
and manage the ACX6160 using the NETCONF protocol [RFC 6241] on TCP port 830 through your Open
ROADM controller. To control and manage the ACX6160, your Open ROADM controller uses the NETCONF
API and the Open ROADM YANG data models described in this guide.
Per the Open ROADM requirement, the ACX6160 default username and password are:
openroadm/openroadm.
RELATED DOCUMENTATION
ACX6160 Overview | 16
Open ROADM Compliance Overview | 23
System Commissioning | 28
Table 5 on page 20 lists the Open ROADM YANG data model support on the ACX6160.
Module Description
Module Description
See, “Device Operations” on page 106 Root and main structure of the device tree, defines major lists and
containers for entities such as shelves, circuit-packs, slots, ports,
interfaces, users, xponder, and so forth.
“Interfaces” on page 45
org-openroadm-network-types Node and link type definitions, supported interfaces capability list.
org-openroadm-otn-common-types OTU and ODU rate and type identities and payload type def
22
Module Description
org-openroadm-pm Current and historical PM lists, clear PMs and collect historical file
actions.
See, “Performance Monitoring” on page 71
Module Description
RELATED DOCUMENTATION
Introduction
Starting with Junos OS 19.2R2-evo, an Open ROADM Multi-Source Agreement (MSA) device model is
added to Junos to support the ACX6160. This capability allows you to control and manage the ACX6160
using an Open ROADM compliant controller.
NOTE: There is no Junos CLI support for the ACX6160 in the Junos OS 19.2R2-evo release. All
control and management of the ACX6160 is through an Open ROADM controller.
24
The Open ROADM MSA device model is a management model defined by the Open ROADM organization.
Its goal is to provide a common management model to simplify the management of multi-vender optical
network architectures. It defines optical interoperability requirements for the device hardware
(Reconfigurable Optical Add/Drop Multiplexers (ROADM), transponders and pluggable optics) and a
NETCONF API that uses Yet Another Next Generation (YANG)-based data models that abstract the
management, control and provisioning of multi-vendor optical devices.
The interoperability requirements defined by the Open ROADM organization call for the control and
management of the devices in the optical network be extracted from the device hardware and completely
controlled by the Open ROADM controller. A one-touch provisioning process enables you simply cable
and power-up the ACX6160, which then receives a temporary IP address from your DHCP server. After
your controller discovers the ACX6160, you can define a permanent IP address to it and configure it using
the ACX6160 YANG data models are described this guide.
The Open ROADM MSA defines a transponder device capable of mapping a single 100 Gbps Ethernet or
OTU4 client signal into a 100 Gbps OTU4 DWDM signal for transport across an Open ROADM
infrastructure. Table 6 on page 24 describes each requirement and how the ACX6160 meets that
requirement.
API using a NETCONF interface with a YANG-based data The ACX6160 supports a NETCONF API interface that
model that abstracts the control management and enables you to use an Open ROADM controller to
provisioning of multi-vendor transponder devices control and manage the ACX6160. We describe the
YANG models for the ACX6160 in this guide.
Single-wave (W) interface which defines the optical The four Line ports on the ACX6160 are 100 Gbps/200
specifications for the full C-band tunable DWDM optical line Gbps CFP2-DCO coherent DWDM pluggable
interface of the transponder that connects to a Wr add/drop transceivers using LC connectors
port on the ROADM device. Line-side pluggable type must
NOTE: This release supports only 100 Gbps Line ports.
be CFP-DCO, CFP2-ACO or CFP2-DCO with LC connectors
Client ports must be pluggable QSFP28 with LC connectors The eight 100 Gbps Ethernet Client ports use pluggable
and support 100GBASE-R mapped into OPU4 using PCS QSFP28 transceivers
codeword transparent Ethernet mapping
NOTE: This release supports only four Client ports
For complete details, see the Open ROADM MSA transponder specification at Open ROADM.org.
25
The ACX6160 supports YANG model v1 defined in RFC 6020. Table 7 on page 25 describes the Open
ROADM YANG data model.
What Example
Database Nodes defined by configuration and operational data and, Shelf commissioning data, wavelength
which you can query using your controller. Some nodes are read/write connections, and so forth.
(configuration node), while others are read-only (operational data).
Notifications for the purposes of reporting autonomous events to Alarms, inventory changes, restarts, and so
the controller. forth.
Remote Procedure Calls (RPC) that do not effect a change in the Get operations, file transfers, database backup,
device configuration data and so forth.
The Open ROADM device YANG model defines the YANG nodes, described in Table 8 on page 25, to
abstract the implementation of the ROADM and transponder device.
Information Provides general node information including node name, IP address, and so forth
Shelves Provide shelf information. A node can consist of one or more shelves
Circuit Packs Represents a physical piece of equipment which contains a group of hardware
functional blocks such as common equipment, cards, plug-in-units and/or pluggable
optics.
Ports The Ports container defines the ports associated with a circuit pack or pluggable optics
and the associated port attributes
Internal Links Reflect the connectivity within each circuit pack. These YANG nodes are read only
and report attributes of the circuit pack themselves
Physical Links Reflect the connectivity between ports across different circuit packs. The controller
pushes this data to the device and reflects the actual inter-card fibering/cabling
26
External Links External link YANG nodes are placeholders for data about the far end device. Data
for these YANG nodes is pushed from the controller
Degrees Define the grouping of circuit packs that form a line degree
Shared Risk Groups Define the grouping of circuit packs that form a colorless/ directionless add/drop bank
Wavelength Map Defines the wavelength channel number and wavelength map
Connection Map Wavelength agnostic and reflects any connectivity restrictions / blocking in the device
(not wavelength contention)
Interfaces Defines supported interface types and are associated with Port YANG nodes
RELATED DOCUMENTATION
ACX6160 Overview | 16
Open ROADM YANG Model Support Summary | 20
System Commissioning | 28
2 CHAPTER
System Commissioning | 28
Equipment Provisioning | 29
Interfaces | 45
Connectivity | 56
Transponder Information | 59
Maintenance Testing | 61
Alarm Monitoring | 64
Performance Monitoring | 71
NETCONF Notifications | 83
28
System Commissioning
According to the Open ROADM organization, when a ROADM or transponder is powered up, it runs IPv4
and IPv6 DHCP clients and receives an IP address from the DHCP server sitting on the same LAN. The IP
address may be either IPv4 or IPv6 depending on the operator’s DCN configuration. This IP address is
called temporary IP address. When a DHCP server allocates temporary IP address for a device, the controller
is notified about this new IP address allocation. Now, the controller can log in to the device using a temporary
address and define the permanent IP address for the device. The device also allows you to provision the
default gateway, and that the IP address, prefix length and default gateway should be specified in the same
edit configuration operation.
1. The controller is loaded with the pre-planned device template for the device (node) that is to be
commissioned. The template contains the information to provision the node beyond the auto-provisioning
behavior, including: the final node-id, permanent IP address, shelf/circuit-pack/port attributes, and so
forth. The device planning template is loaded into the Open ROADM controller. The planning template
is not standardized by Open ROADM but provides data to the controller on how to commission the
node using the Open ROADM device model. The planning template is a JSON file containing a subset
of the device model, which you need to configure the Open ROADM device (ACX6160).
4. The Open ROADM device initializes, auto-provisions and requests an IP address from your DHCP
server. The DHCP server responds with a temporary IP address.
5. The controller discovers the new IP address assignment by the DHCP server and attempts to connect
and log into the device as an Open ROADM network element (NE). If the device is an Open ROADM
device, then the controller discovers the Open ROADM NE as a temporary NE.
6. The field technician provides the correlation between the controller discovered temporary NE and the
pre-loaded planning template [One Touch] by identifying the node based on its node-id being installed.
7. The controller then pushes device planning template configuration to the node and rediscovers the
node (permanent node). Once the correlation is made, the controller begins to provision the node.
The planning template information is pushed to the node using the NETCONF edit-config RPC with
the merge operation. There may be processing involved in the controller, which takes both the template
and the current state of the device as input and determines the set of operations that need to be
performed on the device. The use of the merge operation allows the provisioning to succeed even if
the entity (for example, shelf, circuit-pack, port) was auto-provisioned due to the idempotent behavior.
• A reset button on the ACX6160, when pressed, reverts the device back to its default state as described
above. This enables you to easily re-commission an ACX6160 after it has been used.
• The ACX6160 supports a NETCONF edit-config RPC function with the merge operation
• The ACX6160 exhibits idempotent behavior when it processes the edit-config merge RPC
RELATED DOCUMENTATION
Equipment Provisioning
Open ROADM organizes device components in a hierarchical structure starting with the top level info
container:
• Info
• Shelves — Each shelf has one or more slots that contain hardware components called circuit-packs.
• circuit-packs — Provide slots for other circuit-packs to plug into, creating a hierarchy of components.
• ports
• port containers
It’s important to understand this hierarchical structure because you’ll need to follow this hierarchical
structure when you configure the your transponding circuits on the ACX6160.
30
The info container provides top level device information representing the ACX6160 node itself. This
information includes the node name, ip-address, default-gateway that identifies and describes a specific
ACX6160 chassis.
The ACX6160 is a simple 1 RU platform, so there is only a single shelf for the ACX6160: shelf-0 as described
in. Table 9 on page 30.
The ACX6160 consists of a single shelf (shelf-0). The shelf is populated with the hardwired components
that, collectively make up the ACX6160 circuit-packs.
The ACX6160 supports one shelf with seven slots and several circuit-packs. The circuit-packs are made
up of Flexible PIC Concentrator (FPC), Physical Interface Card (PIC)s, transceivers, power supply units
(PSU), and fan tray units (FTU) components. Many of the circuit-pack components are hardwired in the
ACX6160 chassis and are not assigned Model and Serial numbers. In the ACX6160 Open ROADM device
model these circuit-packs simply inherit the Model and Serial number from the ACX6160 chassis.
(Hardwired)
(Hardwired)
31
ACX6160 Ports
The info container provides top level device information representing the ACX6160 node itself. This
information includes the node name, ip-address, default-gateway that identifies and describes a specific
ACX6160 chassis.
Table 12 on page 32 describes YANG nodes in the info container. The columns in Table 12 on page 32
are defined as:
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• w — write-only
• x — RPC function
• n — notification
Table 12 on page 32 describes ACX6160 compliance with the content of the Open ROADM info YANG
model. The location within the Open ROADM YANG model of the nodes listed in the table is
/org-openroadm-device/info.
Table 12: Open ROADM Device Info YANG Model Support (continued)
The Open ROADM model describes a device as having one or more shelves. To satisfy the Open ROADM
model, the ACX6160 creates an abstraction of a single shelf called: shelf-0. The shelf slots are populated
with top level entities such as FPC, PIC, XCVR, PSU, FTU that make up the ACX6160. All of the top level
entities are hardwired into the chassis and are assigned a fixed slot position within the shelf. In the Open
ROADM model, these entities are called circuit-packs.
34
Table 13 on page 34 describes ACX6160 compliance with the content of the Open ROADM shelves YANG
model. The location within the Open ROADM YANG model of the nodes listed in the table is
/org-openroadm-device/info/shelves.
• inService
• outOfService
• maintenance
product-code ro yes
clei ro yes
Table 13: Open ROADM Device Shelves YANG Model Support (continued)
• installed-not-prov
• installed-prov-match
• installed-prov-mismatch
The Open ROADM models FRUs and hard-wired components of a chassis as circuit-packs. A circuit-pack
can have an arbitrary number of slots called cp-slots. Circuit-packs provide a hierarchical organization of
hardware components. Each circuit-pack is either contained within a shelf slot or within a circuit-pack slot.
When a circuit-pack’s type is an XCVR it has a port and in this case the port container should be included
in the configuration. Circuit packs are analogous to the OpenConfig components list.
36
Table 14 on page 36 describes ACX6160 compliance with the content of the Open ROADM circuit-pack
YANG model. The location within the Open ROADM YANG model of the nodes listed in the table is
/org-openroadm-device/circuit-pack.
• inService
• outOfService
• maintenance
product-code ro yes
clei ro yes
Table 14: Open ROADM Device Circuit-Pack YANG Model Support (continued)
- extension ro yes
circuit-pack-mode rw yes
• empty-not-prov
• empty-prov-match
• empty-prov-mismatch
• installed-not-prov
• installed-prov-match
• installed-prov-mismatch
38
Table 14: Open ROADM Device Circuit-Pack YANG Model Support (continued)
• pluggable-optics-holder
• other
Table 15 on page 39 describes ACX6160 compliance with the content of the Open ROADM circuit-pack
type YANG model. The location within the Open ROADM YANG model of the nodes listed in the table is:
org-openroadm-device/circuit-packs[circuit-pack-name]/slots/
pluggable-optics-holder-capability/supported-circuit-pack-types[supported-circuit-pack-type].
• CLIENT: , ,
• if-100GE
• if-OTU4-ODU4
• LINE:
• if-OCH-OTU4-ODU4
Table 15: Open ROADM Device Circuit-Pack-Type YANG Model Support (continued)
Table 16 on page 41 describes ACX6160 compliance with the content of the Open ROADM circuit-pack
port name. The location within the Open ROADM YANG model of the nodes listed in the table is:
org-openroadm-device/circuit-packs[circuit-pack-name]/ports[port-name].
41
Table 16: Open ROADM Device Circuit-Pack Port YANG Model Support
• 0/0
• 0/2
• 0/4
• 0/6
Clients ports 0/1, 0/3, 0/5, and 0/7 are
not used in this release.
• tx
• rx
• bidirectional
• notApplicable
Return hard coded value "bidirectional".
42
Table 16: Open ROADM Device Circuit-Pack Port YANG Model Support (continued)
• inService
• outOfService
• maintenance
Line port:
XPDR<n>-NETWORK<m>
Client port:
XPDR<n>N-xpdrETWORK<m>
Where:
Table 16: Open ROADM Device Circuit-Pack Port YANG Model Support (continued)
- interface-name ro yes
Table 16: Open ROADM Device Circuit-Pack Port YANG Model Support (continued)
LINE: if-OCH-OTU4-ODU4
Table 16: Open ROADM Device Circuit-Pack Port YANG Model Support (continued)
Not supported
RELATED DOCUMENTATION
Interfaces
IN THIS SECTION
This section describes how to configure Client and Line port interfaces on the ACX6160 through your
Open ROADM controller. It also describes the Open ROADM YANG model support for each interface
type available on the ACX6160 Client and Line ports.
46
TIP: It’s important to understand, in Open ROADM, Ports and Interfaces are two distinct entities,
which have a hierarchical relationship to each other.
• Ports are the physical ports on the device, the Client and Line ports on the ACX6160 front
panel. Client ports are labeled 0/0 through 0/7. Line ports (labeled 1/0 through 1/3.
• Interfaces are configured on a supporting physical port (or another supporting interface).
When configuring a transponding circuit, the required interfaces need to be configured in the hierarchical
order, beginning with the interface directly supported by the port, then working upwards in the interface
stack. For each interface configured, the supporting circuit pack, supporting port and supporting interface
must be provisioned appropriately to reflect the hierarchical relationships. Additional details are provided
in Table 17 on page 46 below.
Client and Line ports on the ACX6160 use pluggable optics. All Client ports use pluggable QSFP28
transceivers that are 100 Gbps. All Line ports use pluggable CFP2-DCO transceivers that are 100 Gbps
and support HGFEC.
Table 17 on page 46 describes the various interfaces available for the ACX6160 Client and Line ports and
the Management port, which is (1000BASE-T). The ACX6160 supports the Open ROADM model for
interface configuration and status data. You can provision and monitor the all of these interface types on
the ACX6160.
Interfaces Available On
Transponder Client Port On Transporter Line Port On Management Port
The ACX6160 has eight Client ports (labeled 0/0 through 0/7 on the front panel) that support QSFP28
transceivers. These transceivers provide a speed of up to 100 Gbps, through four 25-Gbps channels. By
default, Client ports are configured as 100-Gigabit Ethernet ports.
On Client ports, the interfaces that are provisioned depend on the transponding application required. To
configure a 100 Gigabit Ethernet transponding circuit, an ethernet interface is provisioned on the Client
port. To configure a OTU4 transponding circuit, both an OTU interface and an ODU interface are configured
on the Client port. In the case of a 100 Gigabit Ethernet Client, the Ethernet interface is provisioned to
be directly supported by the Client port. For an OTU4 Client, the OTU interface is supported by the port
and the ODU interface is supported by the OTU interface.
As an example, let’s look at what it would take to configure a 100 Gigabit Ethernet transponding circuit
on the Client port of the ACX6160, again, looking at Table 17 on page 46:
You must perform these steps in the order shown using your Open ROADM controller.
Again, referring to Table 17 on page 46, let’s look at what steps you need to take to configure an OTU4
Client:
The ACX6160 has four Line CFP2 ports (labeled 1/0 through 1/3 on the front panel) that support C
form-factor pluggable type 2 transceivers.
These Line interfaces have a hierarchical relationship, with the optical channel interface (OCH) directly
supported by the Line port, the OTU interface supported by the optical channel interface, and the ODU
interface supported by the OTU interface.
These three interfaces are configured together on the Line side. It is the only arrangement of interfaces
that is configured on the Line side.
Table 18 on page 49 describes ACX6160 compliance with the content of the Open ROADM device interface
YANG model that is common to all interface types. The location within the Open ROADM YANG model
of the nodes listed in the table is /org-openroadm-device/interface.
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
49
• x — RPC function
• n — notification
Table 18 on page 49 describes ACX6160 compliance with the content of the Open ROADM interface
YANG model that is common to all interface types. The location within the Open ROADM YANG model
of the nodes listed in the table is /org-openroadm-device/interface.
Table 18: Open ROADM Device Interface YANG Model Support (continued)
Table 19 on page 51 describes ACX6160 compliance with the content of the augmentation for ethernet
interfaces to the Open ROADM interface YANG model. The location within the Open ROADM YANG
model of the nodes listed in the table is /org-openroadm-device/interface/ethernet.
51
NOTE: In the column on supported values, the information that applies to 100 Gigabit Ethernet
client interfaces is prefixed by “100GE” and the information that applies to the management
port interface is prefixed by “Mgmt IF”.
Table 19: Open ROADM Device Ethernet Interface YANG Model Support
ethernet rw yes
Table 20 on page 52 describes ACX6160 compliance with the content of the augmentation for
optical-channel interfaces to the Open ROADM interface YANG model. The location within the Open
ROADM YANG model of the nodes listed in the table is /org-openroadm-device/interface/och.
Table 20: Open ROADM Device Optical-Channel Interface YANG Model Support
Och rw yes
(power in dBm)
Table 21 on page 53 describes ACX6160 compliance with the content of the augmentation for OTN ODU
interfaces to the Open ROADM interface YANG model. The location within the Open ROADM YANG
model of the nodes listed in the table is /org-openroadm-device/interface/odu.
Where the level of support differs between line-port and client-port ODU4 interfaces, the port-specific
support is identified by “ODU4 line interface” and “ODU4 client interface” respectively.
NOTE: Descriptions for the maint-testsignal container within the odu container are excluded
from this section and discussed in a later section of this document.
53
Table 21: Open ROADM Device OTN ODU Interface YANG Model Support
- rw yes False.
proactive-delay-measurement-enabled
Table 21: Open ROADM Device OTN ODU Interface YANG Model Support (continued)
Table 22 on page 55 describes ACX6160 compliance with the content of the augmentation for OTN OTU
interfaces to the Open ROADM interface YANG model. The location within the Open ROADM YANG
model of the nodes listed in the table is /org-openroadm-device/interface/otu.
Where the level of support differs between Line-port and Client-port OTU4 interfaces, the port-specific
support is identified by “OTU4 Line interface” and “OTU4 Client interface” respectively.
NOTE: Descriptions for the maint-loopback container within the otu container are excluded
from this section and discussed in a later section of this document.
55
Table 22: Open ROADM Device OTN OTU4 Interface YANG Model Support
RELATED DOCUMENTATION
Maintenance Testing | 61
Connectivity | 56
Alarm Monitoring | 64
56
Connectivity
The Open ROADM device YANG model contains a number of lists and an RPC for configuring and retrieving
connectivity information. This section describes the extent of support for this connectivity modeling on
ACX6160.
internal-link – This list is not supported. All internal connectivity information is provided by the
connection-map.
physical-link – This list is not supported. There are no links required to be setup between circuit packs on
the ACX6160, thus there is nothing to configure for this list.
external-link – This list is supported. You can provision any data you wish to record on links between the
ACX6160 and external devices.
connection-map – This list is supported. The connection-map list reports the traffic path connections
between ACX6160 transponder Client and Line ports, identifying which Client and Line ports are paired
together to provide 100 gigabit transponder units.
get-connection-port-trail – This RPC is not supported, because there are no internal or physical links required
on ACX6160, the connection port trail is trivial and thus there is no need for this RPC. You can reference
all internal connectivity information from the connection-map.
Consistent with the Open ROADM connectivity model, there is a fixed linkage between Client and Line
ports that is reported by the read-only connection-map list from the Open ROADM YANG model.. The
ACX6160 supports the fixed port mapping described in Table 23 on page 57.
NOTE: Although there are eight QSFP28 Client ports, only four of these ports, along with four
Line ports are reported in the connection-map. These are the only ports that are available for
use as Open ROADM transponder configurations.
57
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
58
Table 24 on page 58 describes ACX6160 compliance with the connectivity-related lists of the Open
ROADM YANG model. The location within the Open ROADM YANG model of the YANG nodes listed in
the table is /org-openroadm-device.
- external-link-name
• - node-id
• - circuit-pack-name
• - port-name
• - node-id
• - circuit-pack-name
• - port-name
- connection-map-number ro yes Unsigned integer key into this table. This key
is generated by the ACX6160.
Table 24: Open ROADM Device Connectivity YANG Model Support (continued)
RELATED DOCUMENTATION
Transponder Information
This section describes the ACX6160 compliance with the transponder list in the Open ROADM device
YANG model.
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
Table 25 on page 60 describes ACX6160 compliance with the device transponder in the Open ROADM
YANG model.
60
xponder rw yes
xpdr-port rw yes
RELATED DOCUMENTATION
Maintenance Testing
This section describes the maintenance testing support on ACX6160. The ACX6160 provides support for
activation of traffic loopbacks on OTU interfaces, and supports the execution of Pseudo Random Binary
Sequence (PRBS) tests on ODU interfaces.
The ACX6160 supports facility and terminal loopbacks on OTU interfaces. You can activate loopbacks on
both Client and Line OTU interfaces. For facility loopbacks, the loopback occurs post FEC termination.
NOTE: Note that for a Client port and Line port that are paired in a transponder circuit, you can
only activate one loopback at a time on the interfaces in this transponder.
Table 26 on page 61 describes the loopbacks supported by the ACX6160 and the interfaces they can be
used on to diagnose problems.
Line OTU fac Loops back OTU traffic received from network on line side after
FEC termination back towards traffic path transmitted to
network direction.
Line OTU term Loops back traffic from host system back towards host and
forwards as transmitted traffic on connected client interface.
Client OTU fac Loops back OTU traffic received from network on client side
after FEC termination back towards traffic path transmitted to
network direction.
Client OTU term Loops back traffic from host system back towards host and
forwards as transmitted traffic on connected line client interface.
62
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
Table 27 on page 62 describes ACX6160 compliance with the content of the maint-loopback augmentation
for OTU interfaces to the Open ROADM interface YANG model. The location within the Open ROADM
YANG model of the nodes listed in the table is /org-openroadm-device/interface/otu.
PRBS
The ACX6160 supports the conducting of PRBS tests on ODU interfaces. PRBS test signals and monitoring
can be activated on both client and line ODU interfaces when a transponder circuit is configured for an
OTU4 client. Note that due to a hardware limitation, PRBS tests are not supported for either the client or
line side interfaces when the transponder client interface is configured as 100GE. Note that for a client
63
port and line port that are paired in a transponder circuit, only one PRBS test at a time can be activated
on the interfaces in this transponder.
PRBS Test
Interface Type Type Description
Line ODU Fac Transmits a generated PRBS test signal towards the network direction on the
line side and monitors for a matching PRBS test signal on the traffic received
from the network direction.
Line ODU Term Transmits a generated PRBS test signal towards the host direction which is
forwarded as transmitted traffic on the connected client interface, and monitors
for a matching PRBS test signal on the traffic received from the host direction.
Client ODU Fac Transmits a generated PRBS test signal towards the network direction on the
client side and monitors for a matching PRBS test signal on the traffic received
from the network direction.
Client ODU Term Transmits a generated PRBS test signal towards the host direction which is
forwarded as transmitted traffic on the connected line interface, and monitors
for a matching PRBS test signal on the traffic received from the host direction.
Table 29 on page 63 describes ACX6160 compliance with the content of the maint-testsignal augmentation
for ODU interfaces to the Open ROADM interface YANG model. The location within the Open ROADM
YANG model of the nodes listed in the table is /org-openroadm-device/interface/odu.
RELATED DOCUMENTATION
Interfaces | 45
Alarm Monitoring | 64
Performance Monitoring | 71
Alarm Monitoring
IN THIS SECTION
This section describes the alarm reporting functionality on the ACX6160. Alarm monitoring is conducted
for the ACX6160’s provisioned circuit-packs, port and interfaces. The ACX6160 supports Open ROADM
notifications for alarm raise and clear events, as well as the Open ROADM active-alarm-list, so that you
can poll the list of currently active alarms.
An alarm notification is sent with the same information as stored in an alarm list entry. The notification
sends the entire alarm structure. Alarm notifications contain all the same YANG nodes described in the
tables below.
65
The tables in this section list the alarms and conditions modeled by Open ROADM specifications for circuit
packs that are replaceable on the ACX6160, for circuit-pack ports, and for each ACX6160 interface type.
For each alarm there is an indication of whether or not it is supported on the ACX6160.
All supported alarms and conditions are listed in the Open ROADM active-alarm-list container when the
alarm or condition is active for a configured Open ROADM resource instance.
Active alarms/conditions are listed only if the resource instance they are active on is administratively
In-Service, otherwise they are suppressed. An active alarm or condition may also be suppressed if a
higher-severity alarm is also active.
Notifications are generated when each alarm or condition is raised and cleared. If an alarm/condition
becomes suppressed due to the resource instance changing administrative status to Out-of-Service or a
higher-severity alarm being raised, a notification is generated indicating that the alarm is cleared. Conversely,
if a suppressed alarm/condition transitions to no longer being suppressed, a notification for the raising of
that alarm is generated.
• Table 30 on page 66
• Table 31 on page 66
• Table 32 on page 67
• Table 33 on page 67
• Table 34 on page 68
• Table 35 on page 69
Table 30 on page 66 lists the OpenRoadm probableCause values that are supported for alarms that are
raised against provisioned circuit-packs. Circuit-pack alarms are raised only against removable circuit-packs,
which, on the ACX6160 system, include CFP2-DCO transceivers, QSFP28 transceivers, fan modules and
power modules. The table explicitly indicates which alarms are supported for each removable circuit-pack
type.
66
Fan Power
CFP2-DCO QSFP-28 Mod. Mod.
Table 31 on page 66 lists the OpenRoadm probableCause values that are supported for alarms that are
raised against port objects.
Supported on Supported on
Probable Cause Client Port Line Port Severity Notes
Table 32 on page 67 lists the OpenRoadm probableCause values that are supported for alarms that are
raised against opticalChannel type interfaces, which can be configured only on the Line side ports of the
ACX6160.
67
Supported on Supported on
Probable Cause Client Port Line Port Severity Notes
Table 33 on page 67 lists the OpenRoadm probableCause values that are supported for alarms that are
raised against otnOtu type interfaces.
Supported on Supported on
Probable Cause Client Port Line Port Severity Notes
serverSignalFail No No N/A
68
Supported on Supported on
Probable Cause Client Port Line Port Severity Notes
Table 34 on page 68 lists the OpenRoadm probableCause values that are supported for alarms that are
raised against otnOdu type interfaces.
Supported on Supported on
Probable Cause Client Port Line Port Severity Notes
Table 35 on page 69 lists the OpenRoadm probableCause values that are supported for alarms that are
raised against ethernetCsmacd type interfaces.
69
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
Table 36 on page 70 describes ACX6160 compliance with the content of the active-alarm-list within the
org-openroadm-alarm YANG module. This list will contain a row for each actively reported alarm on the
ACX6160.
When alarms are raised or cleared an instance of the alarm-notification notification, defined in
org-openroadm-alarm YANG module, is generated with same content as is provided in the corresponding
active-alarm-list listing, but with severity reported as “clear” for alarm clearing notifications.
id ro Yes Unique id for this alarm. This is a string set by the device.
circuit-id ro Yes Circuit-id for alarm correlation. Reported only for alarms
raised against interfaces, if a circuit-id value is configured
for the interface.
corrective-action ro No
RELATED DOCUMENTATION
Interfaces | 45
Maintenance Testing | 61
Performance Monitoring | 71
Performance Monitoring
IN THIS SECTION
Performance Monitoring | 72
The ACX6160 supports the Open ROADM performance monitoring YANG data model for reporting current
PM data. It also provides support for retrieving historical PM data by way of file transfer, and support for
clearing PM data.
• Gauge PMs
72
Counter type PMs are collected for current 15-minute and 1-day granularities. You can also retrieve
historical counter bins by way of file transfer. You can retrieve up to the last ninety-six 15-minute bins,
as well as the previous 1-day bin.
Gauge type PMs report the current instantaneous value, as well as the minimum, maximum, and average
value over the duration of the reported interval (15-minute or 1-day). For gauge type PMs, only the
minimum, maximum and average values are reported for historical bins.
NOTE: For current instantaneous gauge-type PM values, use the bin granularity type of
“notApplicable”.
Performance Monitoring
This section provides the list of supported performance metrics (PMs) for each type of entity on the
ACX6160 that supports performance monitoring.
• Table 37 on page 72
• Table 38 on page 73
• Table 39 on page 73
• Table 40 on page 75
• Table 41 on page 77
Table 37 on page 72 lists the OpenRoadm performance monitoring parameters that are supported for
transponder ports on the ACX6160.
Support
Table 37: Open ROADM Port Performance Monitor Support on ACX6160 (continued)
Support
Table 38 on page 73 lists the OpenRoadm performance monitoring parameters that are supported for
optical channel interfaces on the ACX6160.
Table 39 on page 73 lists the OpenRoadm performance monitoring parameters that are supported for
OTU interfaces on the ACX6160.
Table 39: Open ROADM OTU Interface Performance Monitor Support on ACX6160
Support
Table 39: Open ROADM OTU Interface Performance Monitor Support on ACX6160 (continued)
Support
Table 39: Open ROADM OTU Interface Performance Monitor Support on ACX6160 (continued)
Support
Table 40 on page 75 lists the OpenRoadm performance monitoring parameters that are supported for
ODU interfaces on the ACX6160.
Supported
Table 40: Open ROADM ODU Interface Performance Monitors on ACX6160 (continued)
Supported
Table 41 on page 77 lists the OpenRoadm performance monitoring parameters that are supported for
100GE Client interfaces on the ACX6160.
77
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — rpc function
• n — notification
Table 42 on page 78 describes ACX6160 compliance with the content of the current-pm-list list definition
within the org-openroadm-pm YANG module. The location within the Open ROADM YANG model of the
nodes listed in the table is /org-openroadm-pm/current-pm-list/current-pm-entry.
Table 42: Open ROADM Current Performance Monitoring YANG Model Support
Table 42: Open ROADM Current Performance Monitoring YANG Model Support (continued)
The ACX6160 provides support for retrieval of historical PM data through the collect-historical-pm-file
RPC, defined in the org-openroadm-pm.yang module. Open ROADM users can invoke this RPC to generate
an output file containing the historical PM data that is queried, then download this file using the Open
ROADM file transfer RPC.
NOTE: The ACX6160 does not provide support for retrieving historical PM data by Netconf get
requests that target the historical-pm-list container.
Table 43 on page 80 describes ACX6160 compliance with the collect-historical-pm-file RPC definition
within the org-openroadm-pm YANG module.
Table 43: Open ROADM Historical Performance Monitoring RPC YANG Model Support
collect-historical-pm-file x Yes
Input
Output
The output of the collect-historical-pm-file RPC is saved to a file in XML format based on the
historical-pm-list definition, and the file is gzip compressed, as per the definition of the
collect-historical-pm-file RPC.
Table 44 on page 80 describes ACX6160 compliance with the defined output data content as defined
within the org-openroadm-pm YANG module.
historical-pm-list ro Yes
- historical-pm-entry ro Yes
81
Table 44: Open ROADM Defined Output Data Content Support (continued)
-- pm-resource-type-extension ro Yes
-- historical-pm ro Yes
The ACX6160 provides support for clearing current and historical PM data through the clear-pm RPC
defined in the org-openroadm-pm.yang module.
82
Table 45 on page 82 describes ACX6160 compliance with the clear-pm RPC definition within the
org-openroadm-pm YANG module.
Table 45: Open ROADM Clearing Performance Monitoring Data RPC YANG Model Support
clear-pm x Yes
Input
- resource/interface-name w Yes If targeting an interface, this field must match the name
of the interface as configured in the interface list
- resource-type w Yes
Output
RELATED DOCUMENTATION
83
Alarm Monitoring | 64
Connectivity | 56
Maintenance Testing | 61
NETCONF Notifications
IN THIS SECTION
Notifications | 83
Interleave | 84
Replay | 84
Notifications
The ACX6160 supports NETCONF notifications (RFC5277), an asynchronous event notification service
between a NETCONF server and a NETCONF client. The ACX6160 acts a NETCONF server and sends
device event notifications, asynchronously as the events occur, to all NETCONF clients that subscribe to
the notification service.
To subscribe to the notifications service for events that occur on a specific ACX6160 device, a NETCONF
client sends a <create-subscription> rpc to the ACX6160 indicating the following:
• <stream> - The name of the stream that the client is interested in. If this parameter is missing, the
ACX6160 treats the subscription request as a request for the NETCONF stream, which is the only stream
that the ACX6160 supports. The ACX6160 returns an error if the subscription request is for any other
stream.
• <filter> - A subtree filter that indicates the subtree of interest. If this parameter is present, only those
events passed by the filter are sent. If this parameter is missing, all events are sent. The ACX6160 does
not support XPATH filters.
• <startTime> and <stopTime> - Indicates that the subscription request is for a replay. See “Replay” on
page 84. If the <startTime> parameter is not present, then the subscription request is for new notifications
and not for a replay.
For a subscription that is not a replay, the ACX6160 sends event notifications as they occur. The notifications
continue until the subscription or the session is terminated.
84
Interleave
The ACX6160 supports the interleave capability for NETCONF notifications. The interleave capability
allows the client and the ACX6160 to exchange regular NETCONF commands and responses within the
same NETCONF session used for sending notifications. This reduces the total number of NETCONF
sessions used because a dedicated NETCONF session for notifications is not required.
Replay
The ACX6160 supports the notification replay feature. The replay feature enables a client to request the
ACX6160 to send or resend notifications that have occurred in the past, subject to any <filter> parameters.
• <startTime> - Indicates that the subscription request is for a replay of the event notifications starting
at the specified <startTime>. The <startTime> must not be later than the current time.
• <stopTime> - Indicates the end time of the replay request. The <stopTime> must not be earlier than
the <startTime> but can refer to a time in the future.
If both the <startTime> and <stopTime> parameters are present, the subscription request is for a replay
of the event notifications starting at the specified <startTime> and ending at the specified <stopTime>.
Once the replay is complete (that is, once the replay has reached the indicated <stopTime>), the subscription
terminates but the NETCONF session remains up, reverting to a normal NETCONF command-response
session.
If the <startTime> parameter is present but the <stopTime> parameter is missing, the subscription request
is for a replay followed by new notifications. The replay covers the period from the specified <startTime>
up until the time the subscription request was received by the device. After the replay finishes, the device
sends any event notifications that have occurred since the subscription request was received as well as
all future event notifications as they occur. The notifications continue until the subscription or session is
terminated.
In some situations, the client might want to know prior to creating a replay subscription how far back in
time that the ACX6160 has stored event notifications. To get this information, the client can perform a
<get> request on the <streams> element. Among other information, the ACX6160 responds with a message
containing the following timestamps:
• <replayLogCreationTime> - The timestamp of the creation of the log storing the notifications to be
replayed. This places a bound on the earliest notification stored.
85
• <replayLogAgedTime> - The timestamp of the last notification aged out of the log. If this parameter is
missing, no notifications have been aged out.
3 CHAPTER
System Administration
User Administration | 87
Software Upgrades | 93
Firmware Upgrades | 99
User Administration
ACX6160 user accounts are managed in the users container holding a list of user entries. You can add and
delete user entries from this table. Adding a user to this table creates the user in the underlying Open
ROADM controller’s operating system. Deleting an entry in this table removes a user from the underlying
operating system. The underlying operating system’s user account database should remain in sync with
this table so long as no back-door management takes place.
When you add or update a user entry, the password and group are validated against the data-model
specified in the YANG data model.
Per the Open ROADM requirement, the ACX6160 default username and password are: .
• Username= openroadm
• Password= openroadm
When you add or update a user entry the password and group are validated against the data-model specified
in the YANG model.
Set No-exist Exists User account is updated in the OS with any changes to
password or group. User is added to the configuration.
Set Exists No-exists User is created in the OS and configuration is updated with
any changes to password or group.
Set Exists Exists User account and configuration is updated with any changes
to password or group.
If the action results in an error from the OS, the operation fails and the configuration is unchanged. An
error is returned in the set or delete response.
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
Table 47 on page 88 describes ACX6160 compliance with the content of the Open ROADM user account
YANG model.
RELATED DOCUMENTATION
IN THIS SECTION
This topic describes the device file management YANG model supported by the ACX6160.
The Open ROADM device model specifies a flat file structure on the device with no subdirectories that
support simple file operations with the controller. When an operation generates multiple files, they are
placed in a tarball and zipped in a single file which is stored locally in the flat file structure on the ACX6160.
Examples of files that may reside in this flat file structure include debug, syslogs, database, software images,
and so forth.
For Open ROADM a single directory or file system is created for the purpose of providing this flat directory
structure. The controller accesses the ACX6160 flat directory structure through RPC calls. The ACX6160
supports the following RPC calls:
• transfer — provides file upload and download using an asynchronous SFTP from or to the ACX6160
respectively
SFTP Client
An asynchronous SFTP client is included that allows you to initiate long file transfers while allowing you
to continue management of the device within the same session.
The columns in Table 48 on page 90, Table 49 on page 91, Table 50 on page 92 and Table 51 on page 92
are defined as:
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
Table 48 on page 90 describes ACX6160 compliance with the content of the Open ROADM RPC file
transfer YANG model.
Table 48: Open ROADM RPC File Transfer YANG Model Support
- input w yes
Table 48: Open ROADM RPC File Transfer YANG Model Support (continued)
- output ro yes
Table 49 on page 91 describes ACX6160 compliance with the content of the Open ROADM RPC show-files
YANG model.
- input w yes
- output ro yes
Table 50 on page 92 describes ACX6160 compliance with the content of the Open ROADM RPC delete-file
YANG model.
- input w yes
- output ro yes
Table 51 on page 92 describes ACX6160 compliance with the content of the Open ROADM RPC file
operation notification YANG model.
Table 51: Open ROADM File Operation Notifications YANG Model Support
- progress ro yes
Table 51: Open ROADM File Operation Notifications YANG Model Support (continued)
RELATED DOCUMENTATION
User Administration | 87
Software Upgrades | 93
Database Save and Restore Operations | 100
Software Upgrades
IN THIS SECTION
Manifest Files | 94
The ACX6160 uses the following RPC functions for software upgrades:
• Software stage RPC — stages the specified software package into the in-active software bank. This is
done to prepare for software activation when the in-active bank is activated and for the new software
package to take effect.
• Software activate RPC — activates the software previously staged to the in-active bank by switching the
role of the software banks and reboots the device.
• Software cancel validation timer RPC — cancels the validation timer. The input parameter accept determines
whether the load is committed or if the device reverts back to the previous load (cancel-validation-timer).
94
• Activate — software image has been activated. This is sent upon successful completion of the sw-activate
request.
• Commit — software load has been committed. This is sent after a cancel-validation-timer request has
been sent with accept = true.
• Cancel — software load has been cancelled. This is sent after a cancel-validation-timer request has
been sent with accept = false or expiration of the cancel-validation-timer.
Manifest Files
IN THIS SECTION
Per the Open ROADM MSA, the ACX6160 uses manifest files to describe how the ACX6160 performs a
software download, database backup, and database restore operations. This allows the controller to adapt
to variations in how devices handle these operations. For each operation the manifest file provides a basic
set of attributes and then an instruction set that describes the sequence of RPC requests required to
perform the operation.
This section describes the various manifest files used for the ACX6160.
The columns in Table 52 on page 95, Table 53 on page 96, Table 54 on page 96, Table 55 on page 97,
Table 56 on page 98Table 57 on page 98are defined as:
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
Table 52 on page 95 describes ACX6160 compliance with the content of the Open ROADM RPC pending
software YANG model..
The software stage RPC function stages (installs) the specified software package into the in-active software
bank. This is done to prepare for software activation when the in-active bank is activated and for the new
software package to take effect.
The software package is validated prior to writing to the software bank to avoid installation of corrupted
software into the in-active bank. If this operation fails an error is returned and no change is made to the
contents of the in-active software bank or the device state.
Table 53 on page 96 describes ACX6160 compliance with the content of the Open ROADM RPC software
stage YANG model.
96
Software-stage x yes Stages software package into the in-active software bank
- input w yes
- output ro yes
This RPC activates the software previously staged to the in-active bank by switching the role of the software
banks and reboots the device. The device comes up with the banks switched so that the software from
the previously in-active bank takes effect.
If this operation fails an error is returned and the device is not be rebooted and no change is made to the
ACX6160 device state.
describes ACX6160 compliance with the content of the Open ROADM RPC software activate YANG
model.
- input w yes
-- validationTimer w yes String: specifies time hh-mm-ss the user has to validate
the software and cancel this timer.
- output ro yes
Table 54: Open ROADM Software Activate YANG Model Support (continued)
Table 55 on page 97 describes the software cancel-validation-timer RPC YANG Model. This RPC cancels
the validation timer on the ACX6160. The input parameter: accept, determines if the software load is
committed or if the device reverts back to the previous load.
If this operation fails, you can try again, the ACX6160 software does not prevent subsequent attempts.
Failure to complete this operation results in the cancel-validation-timer expiry at which time the ACX6160
reverts back to the previous software load.
Table 55 on page 97 describes ACX6160 compliance with the content of the Open ROADM RPC software
cancel-validation-timer YANG model.
- input w yes
- output ro yes
Table 56 on page 98 describes ACX6160 compliance with the content of the Open ROADM RPC software
stage notification YANG model. This RPC function returns a success or fail notification (sw-stage
notification).
98
Table 56: Open ROADM Software Stage Notification YANG Model Support
Table 57 on page 98 describes ACX6160 compliance with the content of the Open ROADM RPC software
activate notification YANG model.
Table 57: Open ROADM Software Activate Notification YANG Model Support
RELATED DOCUMENTATION
99
Firmware Upgrades | 99
File System Operations | 89
Database Save and Restore Operations | 100
Firmware Upgrades
Firmware Upgrade
A firmware upgrade upgrades the firmware on the specified ACX6160 circuit pack.
Firmware upgrade will upgrade firmware on the specified circuit pack. This operation is service impacting
and can interrupt traffic.
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
Table 58 on page 100 describes ACX6160 compliance with the content of the Open ROADM RPC software
firmware upgrade for circuit-packs YANG model.
Table 58: Open ROADM Firmware Upgrade for Circuit-Packs YANG Model Support
- input w yes
- output ro yes
RELATED DOCUMENTATION
IN THIS SECTION
The ACX6160 database operations Open ROADM YANG model provides configuration database
management operations for backing up the ACX6160 configuration to a file, to restore the configuration
from a file, and restore to factory default.
101
The ACX6160 database operations Open ROADM YANG data models provide configuration database
management RPC functions for backing up the ACX6160 configuration to a file, restoring the ACX6160
configuration from a file, and restoring the ACX6160 to factory default. Factory default returns the device
configuration back to factory default.
• Database backup RPC — writes the current running configuration to the specified file.
• Database restore RPC — restores the configuration from the specified filename.
• Database activate RPC — activates the new configuration that was read in from a db-restore or from
db-init (factory-default)
• Database init RPC — Sets the candidate configuration to the factory default.
The columns in Table 59 on page 102, Table 60 on page 102Table 61 on page 103, Table 59 on page 102,
Table 62 on page 104, and Table 63 on page 105, are defined as:
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
• x — RPC function
• n — notification
Table 59 on page 102 describes ACX6160 compliance with the content of the Open ROADM RPC database
backup YANG model. This RPC writes the current running configuration to the specified file.
102
Format in XML.
- input w yes
- output ro yes
Table 60 on page 102 describes ACX6160 compliance with the content of the Open ROADM RPC database
restore YANG model. This RPC restores the configuration from the specified filename.
If the nodIDCheck is enabled, it compares the nodeId in the specified file to the current nodeId and the
operation is rejected if they do not match.
- input w yes
Table 60: Open ROADM Database Restore YANG Model Support (continued)
- output ro yes
Table 61 on page 103 describes ACX6160 compliance with the content of the Open ROADM RPC database
activate YANG model. This RPC activates the new configuration, which must previously be read in from
a db-restore or from db-init (factory-default) RPC.
You can use the optional rollback timer (rollBackTimer) to rollback the configuration if not cancelled with
accept=true prior to expiration.
- input w yes
- output ro yes
Table 62 on page 104 describes the cancel rollback timer RPC YANG model.
104
Restoring to factory default returns the ACX6160 configuration back to factory defaults and:
NOTE: Activation of restore to factory default, results in loss of connectivity over the static IP
address. You may want to re-configure the static IP address and disable DHCP on the management
interface prior to activating the restore to factory default.
Table 62 on page 104 describes ACX6160 compliance with the content of the Open ROADM RPC cancel
rollback timer YANG model.
Table 62: Open ROADM Cancel Rollback Timer YANG Model Support
- input w yes
- output ro yes
Table 63 on page 105 describes ACX6160 compliance with the content of the Open ROADM RPC database
init YANG model.
Activation of this RPC, results in loss of connectivity over the static IP address. You
may want to re-configure the static IP address and disable DHCP on the management
interface prior to activating the restore to factory default.
NOTE:
Restoring to factory default returns the ACX6160 configuration back to factory defaults and:
- input w yes
- output ro yes
RELATED DOCUMENTATION
Firmware Upgrades | 99
106
Device Operations
IN THIS SECTION
Open ROADM Create Tech Info Notification YANG Model Support | 109
Open ROADM Set Current Date and Time YANG Model Support | 109
The ACX6160 device operations Open ROADM YANG model includes RPC functions that control the
ACX6160 LEDs, date and time, and restart functions. The following RPCs are available:
• Tech support information RPC function — collects all log data for debugging and places it in a location
accessible via FTP/SFTP.
• Create tech info notification RPC function — notification is sent when the create-tech-info RPC completes.
• Set current datetime RPC function — sets the current date and time on the ACX6160
The columns in Table 64 on page 107, Table 65 on page 108, and Table 66 on page 109, are defined as:
• YANG node — The node from the Open ROADM YANG model.
• rw — read/write
• ro — read-only
107
• x — RPC function
• n — notification
Table 64 on page 107 describes ACX6160 compliance with the content of the Open ROADM LED control
YANG model. This RPC function is used to flash LED on the ACX6160 to help the technician find the
device and entity in the device that needs service.
- output ro yes
Table 64: Open ROADM LED Control YANG Model Support (continued)
Table 65 on page 108 describes the tech support info RPC YANG model. This RPC collects all log data for
debugging and places it in a location accessible via FTP/SFTP. This model assumes ASYNC operation, in
other words, the command is returned after the ACX6160 accepts the command, A
create-tech-info-notification is sent out later for the result of the operation. The log-file is cleared at the
start of every create-tech-info operation in order to ensure the up-to-date logs are collected.
Table 65 on page 108describes ACX6160 compliance with the content of the Open ROADM RPC tech
support info YANG model.
Table 65: Open ROADM Tech Support Info YANG Model Support
- output ro yes
Table 66 on page 109 describes ACX6160 compliance with the content of the Open ROADM RPC create
tech info notification YANG model. This notification is sent when the create-tech-info RPC completes.
Table 66: Open ROADM Create Tech Info Notification YANG Model Support
- output ro yes
Open ROADM Set Current Date and Time YANG Model Support
Table 67 on page 109 describes ACX6160 compliance with the content of the Open ROADM RPC set
current data and time YANG model. This RPC sets the current date and time on the ACX6160.
Table 67: Open ROADM Set Current Date and Time YANG Model Support
set-current-datetime
- output ro yes
RELATED DOCUMENTATION
The Reset button on the ACX6160 Management Panel allows you to easily return the device to the factory
default configuration. This configuration contains just enough configuration needed for commissioning
the ACX6160, and no more.
For the ACX6160, the factory default configuration is set so that the devices receives a temporary IP
address from your DHCP server. Your Open ROADM controller takes over from there and sets a permanent
IP address and configures the ACX6160 using the Open ROADM controller and the ACX6160 YANG data
models.
RELATED DOCUMENTATION
Maintenance Signaling
Maintenance Signaling
IN THIS SECTION
On the ACX6160 Client and Line port interface alarm signaling involves three areas:
When an ACX6160 interface is fully provisioned, cross-connected, and administratively up, if a SignalFail
condition is declared on a Client or Line interface, upstream and downstream alarm signals are generated
to inform the upstream and downstream ACX6160 nodes.
100 Gbps Ethernet clients use GMP mapping to insert/retrieve Ethernet signaling within the Line side
OTN OPU framing.
If SignalFail (Loss Of Signal, Loss Of Sync) is declared on the Client side 100 Gbps Ethernet interface, LFOS
(Local Fault Ordered set) is sent over the Line side OTU4 interface.
If SignalFail (Loss Of Signal, Loss Of Frame) is declared on the Line side OTU4 interface, LF (Local Fault)
is sent over the Client side 100 Gbps Ethernet interface, and BDI (Backward Defect Indication) is sent over
the Line side OTU4 interface.
113
If BDI is received on the Line side OTU4 interface, LF (Local Fault) is sent over the Client side 100 Gbps
Ethernet interface.
If SignalFail (Loss Of Signal, Loss Of Frame) is declared on the Client side OTU4 interface, Alarm Indication
Signal (ODU-AIS) is sent over the Line side of the OTU4 interface, and BDI is sent over the Client side of
the OTU4 interface.
If SignalFail (Loss Of Signal, Loss Of Frame) is declared on the Line side OTU4 interface, ODU-AIS (Alarm
Indication Signal) is sent over the Client side OTU4 interface, and BDI is sent over the Line side OTU4
interface.
If BDI is received on the Line side OTU4 interface, BDI is sent on the Client side OTU4 interface.
If a Client side 100 Gbps Ethernet interface is administratively disabled, RF is sent on the Client side 100
GE interface, and LFOS is sent on the Line side OTU4 interface.
If Client side 100GE interface is then put into a loopback mode, the RF on the Client side 100 GE interface
is removed.
If a Client side OTU4 interface is administratively disabled, ODU-LCK is sent on the Client side OTU4
interface, and ODU-LCK is sent on the Line side OTU4 interface.
If Client side OTU4 interface is then put into a loopback mode, ODU-LCK on the Client side OTU4 interface
is removed, and ODU-LCK on the Line side OTU4 interface is removed
If a Client side OTU4 interface has been fully provisioned, and set administratively up, but NOT
cross-connected (not carrying traffic), ODU-OCI (Open Connection Indication) is sent over the Client side
OTU4 interface. When the cross-connect is provisioned, the ODU-OCI signal will stop being sent.
If a Line side OTU4 interface is administratively disabled, ODU-LCK is sent on the Line side OTU4 interface,
and ODU-LCK is sent on the Client side OTU4 interface.
114
If Line side OTU4 interface is then put into a loopback mode, ODU-LCK on the Line side OTU4 interface
is removed.
If a Line side OTU4 interface has been fully provisioned, and set administratively up, but NOT
cross-connected (not carrying traffic), ODU-OCI is sent over the Line side OTU4 interface. When the
cross-connect is provisioned, the ODU-OCI signal will stop being sent.
Signal Transparency
RELATED DOCUMENTATION
Interfaces | 45
Maintenance Testing | 61
Alarm Monitoring | 64