Scribd
Upload
41 views11 pages

Nokia, ZTE, Huawei DWDM & MPLS APIs

Uploaded by

Yudy Utama
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
41 views11 pages

Nokia, ZTE, Huawei DWDM & MPLS APIs

Uploaded by

Yudy Utama
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd

1.

Nokia DWDM
1.1. GetAllService
GET [Link]

This endpoint will retrieve all services


example : [Link]

Response Body
{
"reqCompletionStatus": 0,
"requestId": 0,
"clientName": null,
"clientLocation": null,
"clientUser": null,
"sessionId": "",
"mdcId": null,
"sequenceNum": 0,
"moreToCome": false,
"messages": [],
"errcde": null,
"errorParams": null,
"nextTasks": null,
"items": [
{
"className": "path",
"id": "1910",
"key": "path/1910",
"guiLabel": "Service_ODU2e_REST_API_Unprotected",
"vsClientState": "VSCS_NOT_APPLICABLE",
"vsClientId": -1,
"connectionType": "path",
"receivedDate": "2020-02-04T[Link]Z",
"orderId": "7838",
"groupOrderId": "1909",
"groupOrderType": "GOT_CLNT_AND_SERVERS_PROV",
"groupOrderName": "g-Service_ODU2e_REST_API_Unprotected",
"connectionAlias": "Service_ODU2e_REST_API_Unprotected",
"orderStep": "CST_IN_EFFECT",
"stepState": "SSTATE_COMPLETED",
"orderType": "OT_ADD",
"layerRate": "DSR",
"effectiveRate": "10GbE",
"displayProtectionType": "DPT_UN_PROTECTED",
"protectionRole": "PR_NA",
"state": "CST_IN_EFFECT",
"operationalState": "Down",
"category": "CC_MANAGED_PLANE",
"alarmEnabling": "Not Set",
"alarmState": "Major",
"alarmSeverity": "Major",
"serverAlmState": "Cleared",
"TCMEnabled": "TCM_STATUS_NONE",
"TCMASAPEnabled": "TCM_STATUS_NONE",
"nmlASAPName": "default ASAP",
"frequency": "N/A",
"orderNumber": "A2978",
"customerName": "",
"serviceState": "ServiceState_Ains",
"provisionableWavekey": "N/A",
"a1NeName": "NKDWDCW0008x001",
"a1PortName": "20AX200-1-13-11",
"z1NeName": "NKDWDRW0008x001",
"z1PortName": "20AX200-1-13-11",
"a2NeName": "",
"z2NeName": "",
"a1NodeName": "NKDWDCW0008x001",
"z1NodeName": "NKDWDRW0008x001",
"aNodeId": 270,
"zNodeId": 281,
"a2NodeId": 0,
"z2NodeId": 0,
"aPortId": 430842,
"zPortId": 450185,
"a2PortId": 0,
"z2PortId": 0,
"aPortLabel": "NKDWDCW0008x001/20AX200-1-13-11",
"zPortLabel": "NKDWDRW0008x001/20AX200-1-13-11",
"a1NodeAndPort": "NKDWDCW0008x001/20AX200-1-13-11",
"z1NodeAndPort": "NKDWDRW0008x001/20AX200-1-13-11",
"pm24hour": "NotEnabled",
"pm15min": "NotEnabled",
"nimEnabled": "N/A",
"linkUtilRatio": 0.0,
"isPMSupported": "Required",
"connectionDirection": "CD_BID",
"is3rdPartyLink": "false",
"thirdPartyName": "",
"thirdPartyDesc": "",
"nprTlId": "0",
"sdhConnectionId": "-1",
"sdhClientId": "-1",
"isUsedInSdh": "false",
"fdn": "1/1910",
"mismatchType": "NA",
"clientRouteState": "NA",
"createdBy": "CB_USER",
"endpoints": 2,
"inconsistentMismatchType": "",
"inconsistentAcknowledgedBy": "",
"inconsistentEventDate": "",
"inconsistentAckDate": "",
"isL0CRRD": "false",
"isCurrentRouteRD": "false",
"serverConnId": 1911,
"serverConnectionCategory": "CC_MANAGED_PLANE",
"serverProtectionType": "",
"serverConnectionRate": "ODU2E",
"isSlteSupported": "false",
"isOtdrSupported": "false",
"allowAsonResources": "No",
"switchCapability": "0",
"scId": "N/A",
"associatednprtlid": 0,
"encoding": "N/A",
"autoInService": "Yes",
"autoInServiceTimer": "N/A",
"lineGranularity": 0,
"containerType": "odu2e",
"singleFiberChannelPlan": "N/A",
"olcState": "OlcState_InService",
"npaUserLabel": "SPTEL",
"spectrumWidth": "",
"dmValue": "188.25",
"dmValueProtection": "0",
"dmTimestamp": "2020-02-04T[Link]Z",
"dmStatus": "SUCCESS",
"revertiveMode": "RevertiveMode_NA",
"isEline": "No",
"lineModeProfileDescription": "",
"tcmenabled": "TCM_STATUS_NONE",
"tcmasapenabled": "TCM_STATUS_NONE",
"npauserLabel": "SPTEL",
"aportLabel": "NKDWDCW0008x001/20AX200-1-13-11",
"zportLabel": "NKDWDRW0008x001/20AX200-1-13-11"
}
],
"data": null,
"failedCompletion": false,
"successfulCompletion": false,
"timeout": 0,
"nadString": ""
}

1.2. Suspend
POST [Link]
service?
orderNumber=<<ORDERNUMBER>>&orderId=<<ORDERID>>&type=DisableServiceState

This endpoint to suspend service by its serviceId, orderNumber and orderId. for
example : [Link]
orderNumber=A2978&orderId=7838&type=DisableServiceState
Response Body

"message": "Modify Order Parameters action for order A2978 and connection
Service_ODU2e_REST_API_Unprotected completed successfully.",
"messageId": "OH1015I",
"messageSeverity": "I",
"status": "SUCCESS",
"connectionName": "Service_ODU2e_REST_API_Unprotected ",
"connectionId": -1,
"orderNumber": "",
"orderId": "",
"orderStep": 0,
"errorField": "",
"errorValue": ""
}

1.3. Resume
POST [Link]
service?
orderNumber=<<ORDERNUMBER>>&orderId=<<ORDERID>>&type=EnableServiceState

This endpoint to resume service by its serviceId, orderNumber and orderId. for
example : [Link]
orderNumber=A2978&orderId=7838&type=EnableServiceState

Response Body

"message": "Modify Order Parameters action for order A2978 and connection
Service_ODU2e_REST_API_Unprotected completed successfully.",
"messageId": "OH1016I",
"messageSeverity": "I",
"status": "SUCCESS",
"connectionName": "Service_ODU2e_REST_API_Unprotected ",
"connectionId": -1,
"orderNumber": "",
"orderId": "",
"orderStep": 0,
"errorField": "",
"errorValue": ""
}

2. ZTE DWDM
1.1. GetAllService

[Link]

1.2. Suspend

[Link]

1.3. Resume

[Link]

3. Huawei DWDM
1.4. GetAllService
1.5. Suspend

1.6. Resume

4. Huawei MPLS

1.7. GetAllService (VPLS)

/restconf/v1/data/huawei-nce-vpls-svc:vpls-svcs

1.8. GetAllService (VLL)

/restconf/v1/data/huawei-nce-vll-svc:service/l2vpn-instances

1.9. Suspend (VPLS)

/restconf/v1/data/huawei-nce-vpls-svc:vpls-svcs/vpls-svc/{vpls-svc-vpn-id}/endpoints/
endpoint/{endpoint-endpoint-id}/network-accesses/network-access/{network-access-id}

{
"network-access" : {
"id" : "67b6eecc-1c36-11e7-8000-000c2917c39a",
"admin-status" : "admin-up",
}
}
1.10. Suspend (VLL)

/restconf/v1/operations/huawei-nce-vll-svc:enable-l2vpn-instance HTTP/1.1
{
"input" : {
"eline-id" : "25b6aacc-2d36-11f7-3714-706c2917c63b",
"admin-status" : "admin-down"
}
}

1.11. Resume (VPLS)

/restconf/v1/data/huawei-nce-vpls-svc:vpls-svcs/vpls-svc/{vpls-svc-vpn-id}/endpoints/
endpoint/{endpoint-endpoint-id}/network-accesses/network-access/{network-access-id}

{
"network-access" : {
"id" : "67b6eecc-1c36-11e7-8000-000c2917c39a",
"admin-status" : "admin-down"
}
}

1.12. Resume (VLL)

/restconf/v1/operations/huawei-nce-vll-svc:enable-l2vpn-instance
{
"input" : {
"eline-id" : "25b6aacc-2d36-11f7-3714-706c2917c63b",
"admin-status" : "admin-up"
}
}

5. Nokia MPLS

1.13. GetAllService

i. Create a file name [Link] then save it under


directory /root/script/dump (example), then the result of information
will be store in .XML format under directory
/opt/nsp/nfmp/server/xml_output/ at NFMP/SAM server:
curl -d @/root/script/dump/[Link] <url>/xmlapi/invoke -k

<url> : [Link] or [Link]


<SOAP:Envelope xmlns:SOAP="[Link]
<SOAP:Header>
<header xmlns="xmlapi_1.0">
<security>
<user>oss</user>
<password>c36b885125105c462d34774140eec076</password>
</security>
<requestID>clientName@requestId</requestID>
</header>
</SOAP:Header>
<SOAP:Body>
<findToFile xmlns="xmlapi_1.0">
<fullClassName>[Link]</fullClassName>
<filter>
</filter>
<resultFilter>
<children></children>
</resultFilter>
<fileName>[Link]</fileName>
</findToFile>
</SOAP:Body>
</SOAP:Envelope

ii. Response if OK:


<SOAP:Envelope xmlns:SOAP="[Link]
<SOAP:Header>
<header xmlns="xmlapi_1.0">
<requestID>clientName@requestId</requestID>
<requestTime>Aug 13, 2020 [Link] PM</requestTime>
<responseTime>Aug 13, 2020 [Link] PM</responseTime>
</header>
</SOAP:Header>
<SOAP:Body>
<findToFileResponse xmlns="xmlapi_1.0"/>
</SOAP:Body>
</SOAP:Envelope>

iii. Create a file name [Link] then save it under directory


/root/script/dump (example). Then the result of information will be
store in XML format under directory /opt/nsp/nfmp/server/xml_output/
at NFMP/SAM server:
curl -d @/root/script/dump/[Link] <url>/xmlapi/invoke -k
<url> : [Link] or [Link]
<SOAP:Envelope xmlns:SOAP="[Link]
<SOAP:Header>
<header xmlns="xmlapi_1.0">
<security>
<user>oss</user>
<password>c36b885125105c462d34774140eec076</password>
</security>
<requestID>clientName@requestId</requestID>
</header>
</SOAP:Header>
<SOAP:Body>
<findToFile xmlns="xmlapi_1.0">
<fullClassName>[Link]</fullClassName>
<filter>
</filter>
<resultFilter>
<children></children>
</resultFilter>
<fileName>[Link]</fileName>
</findToFile>
</SOAP:Body>
</SOAP:Envelope>

iv. Response if OK:


<SOAP:Envelope xmlns:SOAP="[Link]
<SOAP:Header>
<header xmlns="xmlapi_1.0">
<requestID>clientName@requestId</requestID>
<requestTime>Aug 13, 2020 [Link] PM</requestTime>
<responseTime>Aug 13, 2020 [Link] PM</responseTime>
</header>
</SOAP:Header>
<SOAP:Body>
<findToFileResponse xmlns="xmlapi_1.0"/>
</SOAP:Body>
</SOAP:Envelope>

1.14. Suspend

<[Link] xmlns="xmlapi_1.0">
<deployer>immediate</deployer>
<synchronousDeploy>true</synchronousDeploy>
<deployRetries>0</deployRetries>
<deployRetryInterval>0</deployRetryInterval>
<distinguishedName>svc-mgr:service-alcatelServiceID:siteId
</distinguishedName>
<childConfigInfo>
<vll.L2AccessInterface>
<actionMask>
<bit>modify</bit>
</actionMask>
<!--For VLAN subinterface (parent Ethernet port) -->:
<objectFullName>svc-mgr:service-alcatelServiceID:siteId:interface-cardSlot/
daughterCardSlot/port-inner-tag-cvlan-outer-tag-svlan</objectFullName>
<!--For VLAN subinterface (parent Link aggregation interface)-->:
<objectFullName>svc-mgr:service-alcatelServiceID:siteId:interface-lag_lagId-
inner-tag-cvlan-outer-tag-svlan</objectFullName>
<!--Link aggregation interface-->:
<objectFullName>svc-mgr:service-alcatelServiceID:siteId:interface-lag_lagId-
inner-tag-0-outer-tag-0</objectFullName>
<!--For Ethernet port -->:
<objectFullName>svc-mgr:service-alcatelServiceID:siteId:interface-cardSlot/
daughterCardSlot/port-inner-tag-0-outer-tag-0</objectFullName>
<administrativeState>serviceDown</administrativeState>
</vll.L2AccessInterface>
</childConfigInfo>
</[Link]>

1.15. Resume

<[Link] xmlns="xmlapi_1.0">
<deployer>immediate</deployer>
<synchronousDeploy>true</synchronousDeploy>
<deployRetries>0</deployRetries>
<deployRetryInterval>0</deployRetryInterval>
<distinguishedName>svc-mgr:service-alcatelServiceID:siteId
</distinguishedName>
<childConfigInfo>
<vll.L2AccessInterface>
<actionMask>
<bit>modify</bit>
</actionMask>
<!--For VLAN subinterface (parent Ethernet port) -->:
<objectFullName>svc-mgr:service-alcatelServiceID:siteId:interface-cardSlot/
daughterCardSlot/port-inner-tag-cvlan-outer-tag-svlan</objectFullName>
<!--For VLAN subinterface (parent Link aggregation interface)-->:
<objectFullName>svc-mgr:service-alcatelServiceID:siteId:interface-lag_lagId-
inner-tag-cvlan-outer-tag-svlan</objectFullName>
<!--Link aggregation interface-->:
<objectFullName>svc-mgr:service-alcatelServiceID:siteId:interface-lag_lagId-
inner-tag-0-outer-tag-0</objectFullName>
<!--For Ethernet port -->:
<objectFullName>svc-mgr:service-alcatelServiceID:siteId:interface-cardSlot/
daughterCardSlot/port-inner-tag-0-outer-tag-0</objectFullName>
<administrativeState>serviceUp</administrativeState>
</vll.L2AccessInterface>
</childConfigInfo>
</[Link]>

You might also like