Huawei Abstraction and Control of Traffic Engineered Network (ACTN) Optical Adapter

 

General Information

The Huawei ACTN adapter is an optical adapter for the Huawei iMaster Network Cloud Engine-Transport (NCE-T) controller.

It supports the discovery of network inventory, topology, OTN Line, E-Line services, and notifications as shown in the table below. 

Table 1.Network Discovery Details for the Huawei ACTN Optical Adapter

Discovery and Visualization

Provisioning

Inventory

Topology

Services

Performance Management

Optical devices (ROADM, non-ROADM)

Shelf, Cards, Physical Ports, and Optical Ports

OTS, OMS Links

OCH, OTU,OTUCn, ODU,ODUCn,  Optical Tunnel Connections

OTN Line (Client) Services and E-Line Services

Ethernet Ports – Rx/Tx Octets and Rx/TX Packets and Rx/TX Packet Drops

Optical Ports – Rx/Tx Power Min, Max and Current Value

 

OTN Line Service, SDH Line Service, Circuit E-Line Service

 

Prerequisites

Ensure that the date and time format is in the following format: 2024-09-09 09:15:00,226

The following fields must exist in the stats.csv file generated by the controller:

HCOPM,HCOPM,2024-09-09 09:15:00,226      

DeviceID,DeviceName,ResourceID,ResourceName,CollectionTime,GranularityPeriod,WDM ClientPort-RXOCTETS,WDM ClientPort-TXOCTETS,OTS Port-SUMOOPCUR,OTS Port-SUMOOPMIN,OTS Port-SUMOOPMAX,OTS Port-SUMIOPCUR,OTS Port-SUMIOPMIN,OTS Port-SUMIOPMAX,OTS Port-MCSOOPMAX,OTS Port-MCSOOPMIN,OTS Port-MCSOOPCUR,OMS Port-SUMOOPCUR,OMS Port-SUMOOPMIN,OMS Port-SUMOOPMAX,OMS Port-SUMIOPCUR,OMS Port-SUMIOPMIN,OMS Port-SUMIOPMAX,OCH Port-SUMOOPCUR,OCH Port-SUMOOPMIN,OCH Port-SUMOOPMAX,OCH Port-SUMIOPCUR,OCH Port-SUMIOPMIN,OCH Port-SUMIOPMAX,OCH Port-LSIOPCUR,OCH Port-LSIOPMAX,OCH Port-LSIOPMIN,OCH Port-LSOOPCUR,OCH Port-LSOOPMAX,OCH Port-LSOOPMIN,Eth Port-RXOCTETS,Eth Port-RX_DROP_PKTS,Eth Port-TX_DROP_PKTS,Eth Port-TXOCTETS,Eth Port-TXPKTS,Eth Port-RXPKTS

APIs Used

The table below details the APIs used.

Table 2.APIs used by the Huawei ACTN Optical Adapter

Discovery Type

Discovery Item

HTTP Requests

Interface/Request Method

Comments

Authentication

X-Auth-Token

 

/rest/plat/smapp/v1/sessions

PUT

Request body example:

{

    "grantType": "password",

    "userName": "<<<username>>>",

    "value": "<<<password>>>"

}

Inventory  

ONE

/restconf/v2/data/huawei-nce-resource-inventory:network-elements

Huawei Proprietary NCE API /GET

 

Shelf

/restconf/v2/data/huawei-nce-resource-inventory:frames

Huawei Proprietary NCE API /GET

 

Card/Fan

/restconf/v2/data/huawei-nce-resource-inventory:cards

Huawei Proprietary NCE API /GET

 

Port

/restconf/v2/data/huawei-nce-resource-inventory:ltps?limit=5000

Huawei Proprietary NCE API /GET

 

Topology

Tunnels (ODU, OTU, OCH)

/restconf/data/ietf-te:te

IETF ACTN /GET

 

Links (OMS, OTS)

/restconf/operations/ietf-network-topology:get-wson-links

IETF ACTN /POST

Request body should contain OMS and OTS links IDs for OMS and OTS commands. OMS link IDs should be collected from OCH tunnel data (tag = underlay-links) and OTS link IDs should be collected from OMS Link data (tag = supporting-link)

Example:

{

"ietf-network-topology:input" : {

"request" : [

{

"link-id" : "a8830896-1273-11ea-ac5b-286ed4893e71"

}

]

}

}

services

E-line Service

/restconf/data/ietf-eth-tran-service:etht-svc

 

IETF ACTN /POST

 

OTN-Line Service

/restconf/data/ietf-trans-client-service:client-svc 

IETF ACTN /POST

 

Notification IETF

Establishing a Subscription Relationship

/restconf/operations/ietf-subscribed-notifications:establish-subscription

IETF ACTN /POST

 

Inventory Notification

 

Establishing a Subscription Relationship

/restconf/v1/operations/huawei-nce-notification-action:establish-subscription=

Huawei Proprietary NCE API /POST

 

Versions Supported

The following table lists the tested devices supported on Huawei ACTN optical adapter.

Table 3.Versions Supported by Huawei ACTN Optical Adapter

Huawei ACTN

Tested Devices

V100R021C10

OptiX OSN 9800 M24-ASON

OptiX OSN 1800 II TP

OptiX OSN 1800 I E

OptiX OSN 1800 V Pro

OptiX OSN 1800 II E

OptiX OSN 9800 M05

OptiX OSN 9800

OptiX OSN 1800 V

OptiX OSN 9800 M12

OptiX OSN 8800 T32-ASON

V100R022C10

OptiX OSN 9800 M24-ASON

OptiX OSN 1800 II TP

OptiX OSN 1800 I E

OptiX OSN 1800 V Pro

OptiX OSN 1800 II E

OptiX OSN 9800 M05

OptiX OSN 9800

OptiX OSN 1800 V

OptiX OSN 9800 M12

OptiX OSN 8800 T32-ASON

 

Discovery

Table 4.Network Discovery Details of Huawei ACTN Optical Adapter

Category

Information Type

Inventory 

  

ONE 

Optical Network Element

Shelf

  

Fan Tray 

  

Card 

  

Topology  

  

Ports  

OTS Port

OMS Port

OCH Port

OTU Port

OTUCn Port

ODU Port

ODUCn Port

Ethernet Port

Optical Client Port

L3 Physical Port

UNI Port

VUNI Port 

Links  

OTS Link

OMS Link  

Connections  

OCH

OTU

OTUCn

ODU

ODUCn

E-Line

L3 Physical

Services 

E-Line

OTN Line

 

Inventory

Table 5.Inventory Item Attributes and Accessibility Details for the Huawei ACTN Optical Adapter

Inventory Item

One (Optical Network Element)

Card

Port

Shelf

access_identifier

No

Yes

Yes

Yes

card_status

No

Yes

No

No

card_type

No

Yes

No

No

children

Yes

Yes

No

Yes

desc

No

Yes

Yes

Yes

device

No

Yes

Yes

Yes

device_family

Yes

No

No

No

device_type

Yes

No

No

No

equip_state

No

No

Yes

No

extra

Yes

Yes

Yes

Yes

has_roadm

Yes

No

No

No

management_ip

Yes

No

No

No

name

Yes

Yes

Yes

Yes

parent

No

Yes

Yes

Yes

pluggability

No

No

Yes

No

provider

Yes

Yes

Yes

Yes

reachability_status

Yes

No

No

No

serial_number

No

Yes

No

Yes

software_version

Yes

No

No

No

topology_id

Yes

No

No

No

vendor

Yes

Yes

Yes

Yes

 

Ports

Table 6.Port Item Attributes and Accessibility Details for the Huawei ACTN Optical Adapter

Attribute

OTS

OMS/OCH/OTU/OTUCn/ODU/ODUCn

Optical Client

L3 Physical/UNI

admin_status

Yes

Yes

Yes

Yes

device

Yes

Yes

Yes

Yes

extra

Yes

Yes

Yes

Yes

lower_ports

No

Yes

Yes

No

name

Yes

Yes

Yes

Yes

oper_status

Yes

Yes

Yes

Yes

parent

Yes

Yes

Yes

Yes

provider

Yes

Yes

Yes

Yes

upper_ports

Yes

Yes

No

No

 

Links

Table 7.Item Attributes and Accessibility Details for the Huawei ACTN Optical Adapter

Attribute

OTS/OMS/OCH/OTU/OTUCn/ODU/ODUCn/E-line/R Physical

extra

Yes

is_bidi

Yes

name

Yes

oper_status

Yes

path_group_type

Yes

port_a

Yes

port_b

Yes

provider

Yes

role

Yes

 

Services

Table 8.Service Item Attributes and Accessibility Details for the Huawei ACTN Optical Adapter

Service Item

E-Line Service/OTN Line Service

admin_status 

Yes

contained_ports 

Yes

customer_name 

Yes

deployment_state 

Yes

name 

Yes

oper_status 

Yes

provider 

Yes

service_health 

Yes

service_intent_relation 

Yes

 

Notifications

Notifications are supported in Huawei ACTN optical Adapter. Topology and service notifications are supported for create/delete and modify operations.

Provisioning

·       User creates OTN Line, Circuit E-Line and SDH Line from the Crosswork Hierarchical Controller UI.

·       NCE-T Adapter performs the following steps as part of the service provisioning:

   Pre-compute a service

   Preset tunnel

   Create service

Table 9.Supported Client Signal Types by Huawei ACTN Optical Adapter

Services

Client Signals

OTN Line Service

Yes

Circuit E-Line Service

Yes

SDH Line Service

Yes

 

Table 10.Provisioning APIs used by the Huawei ACTN Optical Adapter

Process

Controller API

Prerequisite

Payload

Precompute

POST /restconf/operations/ietf-trans-client-service:client-service-precompute

 

{

  "ietf-trans-client-service:input": {
        "request": [
            {
                "request-id": "fghfghf",
                "calculation-type": "ietf-trans-client-svc-types:routes-calcuation",
                "path-count": 2,
                "access-provider-i
d": 5555,
                "access-client-id": 6666,
                "access-topology-id": "11",
                "src-access-ports": {
                    "access-node-uuid": "56bd1f87-92b7-4cd5-a915-050dc25471b9",
                    "access-ltp-uuid": "bcef83af-bf22-11ed-a9d4-286ed4ade6cd",
                    "client-signal": "ietf-otn-types:client-signal-ODU2e"
                },
                "dst-access-ports": {
                    "access-node-uuid": "21d6aa16-1dba-4373-819f-90ce80491de6",
                    "access-ltp-uuid": "7f6123f0-2c81-11ee-909a-286ed4ade6cd",
                    "client-signal": "ietf-otn-types:client-signal-ODU2e"
                },
                "tunnel-policy": {
                    "protection": {
                        "enable": false,
                        "protection-type": "ietf-te-types:lsp-protection-unprotected",
                        "protection-reversion-disable": true
                    },
                    "restoration": {
                        "enable": false,
                        "restoration-reversion-disable": true
                    }
                },
                "p2p-primary-paths": {
                    "p2p-primary-path": [
                        {
                            "path-scope": "ietf-te-types:path-scope-end-to-end",
                            "explicit-route-objects": {
                                "route-object-include-exclude": [
                                    {
                                        "index": 0,
                                        "explicit-route-usage": "ietf-te-types:route-include-ero
",
                                        "unnumbered-hop": {
                                            "node-uuid": "21d6aa16-1dba-4373-819f-90ce80491de6",
                                            "hop-type": "STRICT"
                                        }
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }

}

Preset

POST /restconf/data/ietf-te:te/tunnels

Nodes/ports/links with the required capabilities should already be modeled in Crosswork Hierarchical Controller.

{

    "ietf-te:tunnel": [

        {

            "name": "21df828d-3b08-4b2b-9b97-024ff9d9a666",

            "encoding": "ietf-te-types:lsp-encoding-oduk",

            "switching-type": "ietf-te-types:switching-otn",

            "provisioning-state": "ietf-te-types:tunnel-admin-state-down",

            "protection": {

                "enable": false,

                "protection-type": "ietf-te-types:lsp-protection-unprotected"

            },

            "restoration": {

                "enable": false,

                "restoration-type": "ietf-te-types:lsp-restoration-restore-any"

            },

            "te-topology-identifier": {

                "topology-id": "11",

                "provider-id": 5555,

                "client-id": 6666

            },

            "te-bandwidth": {

                "ietf-otn-tunnel:connection-bandwidth": "5000000",

                "ietf-otn-tunnel:odu-type": "ietf-otn-types:prot-ODUFlex-gfp"

            },

            "p2p-primary-paths": {

                "p2p-primary-path": [

                    {

                        "name": "primary-path",

                        "path-scope": "ietf-te-types:path-scope-end-to-end",

                        "optimizations": {

                            "optimization-metric": [

                                {

                                    "metric-type": "ietf-te-types:path-metric-hop"

                                }

                            ]

                        }

                    }

                ]

            }

        }

    ]

}

 

Service Creation

POST /restconf/data/ietf-trans-client-service:client-svc

Preconfigure of the tunnel parameters should be successful.

{

    "ietf-trans-client-service:client-svc-instances": [

        {

            "client-svc-name": "76a43bd9-be4c-4484-be9e-190b02dca888",

            "client-svc-title": "10_GBE_with_underlay_tun_as_ODUflex",

            "access-provider-id": 5555,

            "access-client-id": "6666",

            "access-topology-id": 11,

            "src-access-ports": {

                "access-node-uuid": "bc87514d-3491-4376-9f99-61fd01c9f1ab",

                "access-ltp-uuid": "5eb74b07-b42a-11ed-8e3e-286ed4ade6cd",

                "client-signal": "ietf-otn-types:client-signal-10GbE-LAN"

            },

            "dst-access-ports": {

                "access-node-uuid": "7a9819bb-b575-456a-9dfe-fa248de0f6e9",

                "access-ltp-uuid": "7aa3c681-b691-11ed-a9d4-286ed4ade6cd",

                "client-signal": "ietf-otn-types:client-signal-10GbE-LAN"

            },

            "provisioning": {

                "deploy-type": "ietf-trans-client-svc-types:available-anytime"

            },

            "svc-tunnels": [

                {

                    "tunnel-name": "21df828d-3b08-4b2b-9b97-024ff9d9a666"

                }

            ]         

        }

    ]

}

Service Deletion

DELETE /restconf/data/ietf-trans-client-service:client-svc/client-svc-instances={client-svc-name}

Client service exists.

 

 

Statistics

PM statistics collection is supported for the following stats:

1.   Ethernet Port – Rx/Tx Octets and Rx/TX Packets and Rx/Tx Packet Drops

2.   Optical Ports – Rx/Tx Power (Min, Max and Current Value)

Configuration

Table 11.Configuration Parameters Settings Details for the Huawei ACTN Optical Adapter

Name

Description 

Default

Range

Enabled

Enable/disable the adapter.

False

Enable this option once you are ready to run the adapt.

Logging Level

The logging level at which the discovery cycle is reported in the adapter log.

INFO

DEBUG, INFO, WARNING, ERROR, CRITICAL

Adapter Properties 

  

  

  

Polling Cycle [sec] 

Poll every X seconds.

7200

[30: ) 

Provisioning

Whether provisioning is enabled or disabled.

 

 

NCE-T Server Configuration 

  

  

  

Host

http|https://<IP>

 

  

Port

<port>

 

 

Credentials 

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

  

  

Timeout [sec] 

The connection timeout in seconds.

60 

[30: ) 

Request Retries

The connection timeout in seconds.

[30: ) 

Collection Parameters 

  

  

Enable Inventory Collection

Whether the inventory collection is enabled or disabled.

True

 

Enable Topology Collection

Whether the topology collection is enabled or disabled.

True

 

Notifications Configuration 

  

  

Enabled

Should the notifications listener be initialized or not?

True

 

Log_notifications

Whether to log the notifications.

True

 

Log_level

The logging level at which the notifications are logged.

INFO

DEBUG, INFO, WARNING, ERROR, CRITICAL

Congestion_control_period_sec

The congestion control period (CCP) is the maximum gap allowed between two successive notifications before the adapter begins to process the notifications queue. This ensures that all notifications related to a particular network event are handled at the same time. For example, an interface down notification is usually followed by a link down notifications. Once the CCP period has passed with no further notifications, the adapter initiates a collect cycle and consequently processes the notification queue.

This parameter is used in conjunction with the max wait period (MWP).

5

 

Max_notification_wait_period_sec

If notifications are received continuously at a frequency that is <= the congestion control period (CCP), then irrespective of the gap between two notifications, if the time elapsed since the first notification is greater than the MWP, the queue is processed immediately.

60

 

PM Configuration 

  

  

  

Enabled 

Whether or not statistics collection is enabled.

  

PM Data Fetch Interval [sec] 

The interval at which to fetch the statistics. Match the polling to the stats collection granularity.

1800

SFTP_Host 

sftp://<IP>

 

  

SFTP_Port

<port>

  

SFTP_Path

The data file location.

 

Credentials

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

 

 

Limitations

IPV6 is not supported