Ciena MCP Adapters

Available Languages

Updated:September 30, 2024

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Ciena Manage, Control and Plan (MCP) Adapter

General Information

The Ciena MCP adapter is an optical adapter that supports Layer 0, Layer 1, Layer 2 network discovery, service provisioning (Circuit E-Line, Packet E-Line, SDH-Line, OTN-Line, OCH Link), and statistics collection (ETH, Power) managed by the Ciena MCP, TAPI 2.1.3 interface.

 

Table 1. Network Discovery Details of the Ciena MCP Adapter

Discovery and Visualization

Provisioning

Inventory

Topology

Services

PMs

 

Optical Devices (ROADM, ILAs, Transponders, OTN and Packet Devices)

Shelves, Cards, Physical Ports, Power Supplies, Fans

OTS, OMS, OCH, NMC, OTU, ODU, ETH, R Logical (IP), LAG,

E-Line, PW, LSP (MPLS-TP),

 

RON Use Case:

ZRP Channel Port, ZRP Media Port

OTN-Line,

Circuit E-Line, Packet E-Line,

SDH-Line, OCH Link (Wavelength),

ZRP Channel Link,

ZRP Media Link

 

RON Use Case:

Wavelength Service as Underlay for ZR/ZR+

ETH and Power

OTN-Line,

Circuit E-Line, Packet E-Line,

SDH-Line, OCH Link (Wavelength),

OCH-NC/NMC Link as part of IP Link (RON Solution), MPLS-Tunnel

 

 

APIs (TAPI 2.1.3) Used

The following list comprises APIs utilized by the Ciena MCP adapter.

Table 2. APIs Used by the Ciena MCP Adapter

Discovery Type

Item

HTTP Requests

HTTP Method

Authentication

Token

/tron/api/v1/tokens

POST

Inventory 

ONE, Shelf, Card, Port, Power Supply, Fan

/tapi/data/tapi-common:context/tapi-equipment:physical-context/device/

GET

/tapi/data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node/

GET

/tapi/data/tapi-common:context/tapi-equipment:physical-context/equipment/

GET

/tapi/data/tapi-common:context/tapi-equipment:physical-context/equipmentholder/

GET

Topology

Links (OTS, OMS)

/tapi/data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link/

GET

Links (NMC, OCH, OTU, ODU, ETH, RLogical, E Line, PW, LSP, LAG)

/tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connection/

GET

Ports (OTS, OMS, NMC, OCH, OTU, ODU, ETH, RLogical, RPhysical, MPLS-TP, UNI, VUNI)

/tapi/data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node-edge-point/

GET

/tapi/data/context/topology-context/topology={uuid}/connection-end-point/

GET

Service

Circuit-E-Line, Packet-E-Line, Wavelength, OTN-Line, SDH-Line

/tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service/ 

GET

Provisioning Endpoint (SIP)

/tapi/data/tapi-common:context/service-interface-point/

GET

Notifications

Get supported streams

/tapi/data/context/stream-context/supported-stream-type/

GET

Get available streams

/tapi/data/context/stream-context/available-stream/ 

GET

Establish WebSocket (per stream)

/tapi/data/context/stream-context/available-stream={uuid}

WSS

Stats

Get PMs

/pm/api/v2/query/metrics

POST

Provisioning

Service

/tapi/data/context/connectivity-ontext/provisioning/connectivity-service/

POST

 

/tapi/data/context/connectivity-context/provisioning/connectivity-service/{uuid}

DELETE

 

Version Support

The following table lists the tested devices supported on the Ciena MCP adapter.

Table 3. Versions Supported by the Ciena MCP Adapter

MCP – TAPI 2.1.3

Tested Devices

v6.1, v6.2, v7.1, v7.2, v8.0

6500, 51XX, 54XX, 81XX, 87XX

 

Discovery

Inventory

Table 4. Inventory Parameter Details for the Ciena MCP Adapter

Parameter

Optical Network Element

Card

Port

Shelf

FAN

Power Supply

access_identifier

No

Yes

Yes

Yes

Yes

Yes

card_type

No

Yes

No

No

No

No

desc

Yes

Yes

Yes

Yes

Yes

Yes

device

No

Yes

Yes

Yes

Yes

Yes

device_family

Yes

No

No

No

No

No

device_type

Yes

No

No

No

No

No

extra

Yes

Yes

Yes

Yes

Yes

Yes

equip_state

No

No

Yes

No

No

No

management_ip

Yes

No

No

No

No

No

model_number

Yes

No

No

No

No

No

name

Yes

Yes

Yes

Yes

Yes

Yes

parent

No

Yes

No

Yes

Yes

Yes

part_number

No

Yes

Yes

No

Yes

Yes

pluggability

No

No

Yes

No

No

No

provider

Yes

Yes

Yes

Yes

Yes

Yes

reachability_status

Yes

No

No

No

No

No

serial_number

Yes

Yes

Yes

Yes

Yes

Yes

software_version

Yes

No

No

No

No

No

vendor

Yes

Yes

Yes

Yes

Yes

Yes

 

Ports

Table 5. Port Item Attributes for the Ciena MCP Adapter

Attribute

OTS

OMS

NMC

OCH

OTU

ODU

Optical Client

Router Aggregate

Router Logical

Router Physical

STM

STS

MPLS

ETH

UNI

Virtual UNI

admin_status

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

containing_service

No

No

Yes

No

No

No

Yes

No

No

No

No

No

No

No

No

No

desc

Yes

No

Yes

No

No

Yes

No

No

No

No

No

No

No

No

No

No

device

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

eth_port_type

No

No

No

No

No

No

No

No

No

Yes

No

No

No

Yes

No

No

expected_transmit_power_range

No

No

Yes

No

No

No

No

No

No

No

No

No

No

No

No

No

has_service_end_point_capability

No

No

No

No

No

No

Yes

No

No

No

No

No

No

No

No

No

ingress_bandwidth_profile

No

No

No

No

No

No

No

No

No

No

No

No

No

No

Yes

Yes

Is_loopback

No

No

No

No

No

No

No

No

Yes

No

No

No

No

No

No

No

is_management

No

No

No

No

No

No

No

No

Yes

No

No

No

No

No

No

No

lower_ports

No

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

name

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

No

Yes

Yes

Yes

Yes

Yes

Yes

Yes

non_primary_ips

No

No

No

No

No

No

No

No

Yes

No

No

No

No

No

No

No

oper_status

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Odu_type

No

No

No

No

No

Yes

No

No

No

No

No

No

No

No

No

No

Otu_type

No

No

No

No

Yes

No

No

No

No

No

No

No

No

No

No

No

parent

No

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

primary_ip

No

No

No

No

No

No

No

No

Yes

No

No

No

No

No

No

No

physical_address

No

No

No

No

No

No

No

Yes

No

No

No

No

No

No

No

No

provider

Yes

Yes

Yes

Yes

Yes

No

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

selected_spectrum

No

No

Yes

No

No

No

No

No

No

No

No

No

No

No

No

No

sts_type

No

No

No

No

No

No

No

No

No

No

No

Yes

No

No

No

No

upper_ports

No

No

No

No

No

No

No

No

No

No

No

No

No

Yes

Yes

Yes

vlan

No

No

No

No

No

No

No

No

Yes

No

No

No

No

No

No

No

 

Links

 

Table 6. Link Item Attributes for the Ciena MCP Adapter

Attribute

OTS

OMS

NMC

OCH

ODU

OTU

Pseudo Wire

Router Aggregate

Router Logical

Router Physical

STM

STS

ETH

LSP

E-Line

desc

Yes

Yes

Yes

No

No

No

No

No

No

No

No

No

No

No

No

is_bidi

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

name

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

 

oper_status

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

path_group_type

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

port_a

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

port_b

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

protection_status

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

 

Yes

provider

Yes

No

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

No

No

Yes

Yes

role

Yes

Yes

Yes

No

No

No

No

No

No

No

No

No

No

No

No

speed_bps

No

No

No

No

No

No

No

No

No

No

No

No

Yes

No

No

 

Provisioning

Table 7. Provisioning Details for the Ciena MCP Adapter

Type

Is Supported

Additional Information

Circuit E-Line

Yes

 

OTN Line

Yes

Supported with ODUFlex flag and protection options

OCH

Yes

 

Packet E-Line

Yes

Assign service to specific MPLS-TP tunnel

OCH-NC (RON)

Yes

Only as part of IP Link (not separate provisioning)

SDH Line

Yes

 

Tunnel (MPLS-TP)

Yes

 

 

Statistics

Table 8. Optical Statistical Data Collected for the Ciena MCP Adapter

Type 

Is Collected

Additional Information

PACKET_IN 

Yes

 

PACKET_OUT 

Yes

 

OCTET_IN 

Yes

 

OCTET_OUT 

Yes

 

JITTER_USEC 

No

 

MIN_RTT_USEC 

No

 

MAX_RTT_USEC 

No

 

AVG_RTT_USEC 

No

 

DELAY_USEC 

No

 

ACTUAL_TX_POWER_DBM_DIVDED_BY_100 

No

 

RX_POWER_DBM_DIVDED_BY_100 

No

 

AVG_RX_POWER_DBM_SCALE_100 

Yes

 Not tested

AVG_TX_POWER_DBM_SCALE_100 

No

 

MIN_TX_POWER_DBM_SCALE_100 

Yes

 Not tested

MIN_RX_POWER_DBM_SCALE_100 

No

 

MAX_TX_POWER_DBM_SCALE_100 

Yes

 Not tested

MAX_RX_POWER_DBM_SCALE_100 

No

 

MAX_POSTFEC_BER_SCALE_10E15 

No

 

MIN_POSTFEC_BER_SCALE_10E15 

No

 

AVG_POSTFEC_BER_SCALE_10E15 

No

 

MAX_PREFEC_BER_SCALE_10E15 

No

 

MIN_PREFEC_BER_SCALE_10E15 

No

 

AVG_PREFEC_BER_SCALE_10E15 

No

 

Q_FACTOR_SCALE_100 

No

 

MAX_Q_FACTOR_SCALE_100 

No

 

MIN_Q_FACTOR_SCALE_100 

No

 

AVG_Q_FACTOR_SCALE_100 

No

 

MIN_THRESHOLD_Q_FACTOR_SCALE_100 

No

 

MAX_THRESHOLD_Q_FACTOR_SCALE_100 

No

 

VALID_Q_FACTOR 

No

 

Q_MARGIN_SCALE_100 

No

 

MAX_Q_MARGIN_SCALE_100 

No

 

MIN_Q_MARGIN_SCALE_100 

No

 

AVG_Q_MARGIN_SCALE_100 

No

 

MIN_THRESHOLD_Q_MARGIN_SCALE_100 

No

 

MAX_THRESHOLD_Q_MARGIN_SCALE_100 

No

 

 

Configuration

Table 9. Configuration Parameters for the Ciena MCP Adapter

Name

Description

Default

Range

Adapter Properties

 

 

 

Enabled

Whether to enable/disable the adapter.

False

DEBUG, INFO, WARNING, ERROR, CRITICAL

Logging Level

The logging level at which the discovery cycle will be reported in the adapter’s log.

INFO

 

Provisioning Timeout [sec]

The provisioning timeout in seconds.

150

 [90: ]

Polling Cycle [sec]

Poll every X seconds.

3600

[90: ]

Connection Timeout [sec]

The connection timeout.

120

 

Max run time for a single discovery cycle[sec]

The maximum time for a discovery cycle. To prevent endless cycles which may put the adapter into a deadlock.

600

[30: ]

Minimal interval time between data updates [sec]

The minimum time between data updates. This is the period, for example 30 seconds, during which notifications are stored in the local adapter cache, after which discovery runs on the cache.  If this is set to 0 seconds (default) the discovery runs immediately.

0

[0: ]

Save persistor request to disk?

Whether to save the persistor request to disk.

false

 

Service Delegation

Allows ownership of existing services for service deletion. When enabled, the adapter discovers controller connectivity-service entries for "brownfield" services (those created outside of Cisco Crosswork Network Controller).

The Service Manager application recognizes these entries created by the adapter and adds them to the Point to Point table (in Service Manager). Users can then delete these "brownfield" services using Service Manager (even though they were created outside of Cisco Crosswork Network Controller).

false

 

Connection Properties

 

 

 

Host (including protocol, port, and URI prefix)

(http|https)://<server>[:<port>]

For example: https://10.133.11.10

 

 

Credentials

Credentials are defined in the “Credentials” tab of the Device Manager.

 

HTTP credentials

MCP API version

The MCP API version.

V5

[V5,V6]

Filter out non Ciena-devices

Whether or not to filter out non-Ciena devices.

false

 

Stats Collection Configuration

 

 

 

Enabled

Whether to enable/disable statistics collection.

true

 

Stats Interval Polling [sec]

Poll for statistics every X seconds.

900

 [300: ]

Concurrent Devices Stats Collection

The number of concurrent devices to collect statistics from.

10

[1:30]

Notifications Configuration

 

 

 

Enabled

Should the notifications listener be initialized or not?

true

 

 

Was this Document Helpful?

FeedbackFeedback

Contact Cisco

This Document Applies to These Products