Operation

post /data/npr/controlPlaneDomains/{ctrPlaneId}
REST to perform operations on Control Plane (commandCtrPlane : /data/npr/controlPlaneDomains/{ctrPlaneId})
Below operation are performed on Control Plane based on below TAG values is REST Request Payload.
1. F_POP_AutoRestActivate - Enable Auto Restoration on Control Plane
2. F_POP_AutoRestDeactivate - Disable Auto Restoration on Control Plane
3. F_POP_fastPhotonicRestorationEnable - Enable Fast Photonic Restoration on Control Plane
4. F_POP_fastPhotonicRestorationDisable - Disable Fast Photonic Restoration on Control Plane
5. F_POP_ActiveNetworkVersion - Set Active Network Version of GMRE to be same as GMRE Installed Version

Path parameters

Name

IsRequired

Description

Enum

ctrPlaneId required Can retrieve the 'ctrPlaneId' from /data/npr/controlPlaneDomains/{'controlPlaneDomainId'} ---
Request body

Name

IsRequired

Description

Data Type

Enum

body optional request ServletWebRequest ---
body2 optional session HttpSession ---
body3 optional form String ---

Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    • text/xml
    Example Request Data

    Request url: 1) Activate Auto-Restoration on ControlPlane Node --> /data/npr/controlPlaneDomains/1 Request Payload: {"Tag":"F_POP_AutoRestActivate","id":"1","userLabel":"GMRE10.255.2.155","priority":"1"} 2) De-activate Auto-Restoration on ControlPlane Node --> /data/npr/controlPlaneDomains/1 Request Payload: {"Tag":"F_POP_AutoRestDeactivate","userLabel":"GMRE10.255.2.155"}

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json
    Example Response Data
    Response: 1) Activate Auto-Restoration Response: { "ok": true, "id": "70071594424901", "responseMessage": "GmreNodePerformMaintenanceOperation Validations Successful.", "responseList": [], "HTTPResponse": 200, "asonResponseList": [], "requestStatus": "Success", "eventableObjects": {}, "httpresponse": 200 } 2) De-activate Auto-Restoration Response: { "ok": true, "id": "69676311505317", "responseMessage": "GmreNodePerformMaintenanceOperation Validations Successful.", "responseList": [], "HTTPResponse": 200, "asonResponseList": [], "requestStatus": "Success", "eventableObjects": {}, "httpresponse": 200 }

    External Docs
    See Also :
  • get : /data/npr/npas

  • Operation

    post /data/npr/controlPlaneDomains/migration
    gmreMigration (gmreMigration : /data/npr/controlPlaneDomains/migration)
    gmreMigration

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional form String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • text/xml
    • application/json

    External Docs
    See Also :

    NprResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean The Npr response is created successfully ---
    id String string The Response id ---
    responseMessage String string Response message for the request ---
    responseList array[Object] object The List of response ---