Modify Endpoint

Modify an endpoint of the L3VPN service using PATCH. Only the changed properties need to be specified. The endpoint UUID can be retreived from the response to the Verify Service procedure.

PATCH https://<NSP Server>:8543/sdn/api/v4/services/l3-vpns/4354-8e80136a-e193-44e9-a1fc-311ff6869d6f/endpoint/4370-6299249d-57d3-4bbf-b2f6-dc27c1a17764

Request:

{
  "data": {
    "adminState": "DOWN",
    "routingStatic": {
      "routes": [
        {
          "destination": {
            "ipv4Prefix": {
              "string": "10.1.1.0/24"
            }
          },
          "routeType": "next_hop",
          "targetIpAddress": {
            "ipv4Address": {
              "string": "200.1.1.11"
            }
          }
        }
      ]
    }
  }
}

Response:

{
  "status": 0,
  "startRow": 0,
  "endRow": 1,
  "totalRows": 1,
  "data": {
    "id": "4354-8e80136a-e193-44e9-a1fc-311ff6869d6f",
    "appId": "101",
    "operationalState": "UP",
    "adminState": "UP",
    "neDeploymentState": "DEPLOYED",
    "externalIds": [
      {
        "context": "NFM_P",
        "location": [
          "135.121.156.100"
        ],
        "id": "svc-mgr:service-3"
      }
    ],
    "name": "L3 VPN Service",
    "serviceType": "L3_VPN",
    "tenantIds": [
      "0"
    ],
    "objective": "HOPS",
    "bidirectional": "ANY_REVERSE_ROUTE",
    "bw": null,
    "reverseBW": null,
    "maxLatency": 0,
    "maxCost": 0,
    "maxHops": 0,
    "lifeCycle": {
      "phase": "Planning",
      "state": "Planned",
      "reason": "Service modify requested"
    },
    "templateId": null,
    "tunnelSelectionId": null,
    "pathProfileId": null,
    "groupId": null,
    "endpoints": [
      {
        "id": "4370-6299249d-57d3-4bbf-b2f6-dc27c1a17764",
        "appId": "221",
        "operationalState": "UP",
        "adminState": "UP",
        "neDeploymentState": "DEPLOYED",
        "externalIds": [
          {
            "context": "NFM_P",
            "location": [
              "135.121.156.100"
            ],
            "id": "svc-mgr:service-3:11.11.11.11:ip-interface-2"
          }
        ],
        "neId": "1526-ff2a9aed-27be-4870-9020-a0c75432ff1f",
        "neName": "A-11.11.11.11",
        "portId": "2182-e4e12d40-47ac-4fee-9a9c-8836152b01b6",
        "portName": "Port 1/1/11",
        "serviceId": "4354-8e80136a-e193-44e9-a1fc-311ff6869d6f",
        "name": "Port1_Name",
        "innerTag": -1,
        "outerTag": 72,
        "siteServiceQosProfile": {
          "qosProfile": 0,
          "ingressOverrideQueues": null,
          "egressOverrideQueues": null,
          "ingressParam": null,
          "egressParam": null
        },
        "isHub": false,
        "aggregateBw": 0,
        "ipAddress": {
          "ipv6Prefix": null,
          "ipv4Prefix": {
            "string": "200.1.1.10/24"
          }
        },
        "secondaryAddresses": [
          {
            "ipv6Prefix": null,
            "ipv4Prefix": {
              "string": "21.1.1.1/24"
            }
          }
        ],
        "peSideAS": 300,
        "routingStatic": {
          "routes": [
            {
              "routeType": "next_hop",
              "destination": {
                "ipv6Prefix": null,
                "ipv4Prefix": {
                  "string": "201.1.1.0/24"
                }
              },
              "targetIpAddress": {
                "ipv6Address": null,
                "ipv4Address": {
                  "string": "200.1.1.11"
                }
              },
              "preference": 5
            }
          ]
        },
        "routingBgp": {
          "routes": [
            {
              "peerIpAddress": {
                "ipv6Address": null,
                "ipv4Address": {
                  "string": "200.1.1.15"
                }
              },
              "peerAS": 7000
            }
          ]
        },
        "@class": "com.alu.wsc.api.generated.v4.L3ServiceEndpoint"
      },
      {
        "id": "4375-4ad63c45-6356-42d7-96db-57ac81382b59",
        "appId": "201",
        "operationalState": "UP",
        "adminState": "UP",
        "neDeploymentState": "DEPLOYED",
        "externalIds": [
          {
            "context": "NFM_P",
            "location": [
              "135.121.156.100"
            ],
            "id": "svc-mgr:service-3:22.22.22.22:ip-interface-2"
          }
        ],
        "neId": "1536-65f5928f-863c-458f-ad90-487f24648993",
        "neName": "B-22.22.22.22",
        "portId": "2685-a7665170-d578-4d92-9880-17d15c788ffa",
        "portName": "Port 1/1/11",
        "serviceId": "4354-8e80136a-e193-44e9-a1fc-311ff6869d6f",
        "name": "Port1_Name",
        "innerTag": -1,
        "outerTag": 71,
        "siteServiceQosProfile": {
          "qosProfile": 0,
          "ingressOverrideQueues": null,
          "egressOverrideQueues": null,
          "ingressParam": null,
          "egressParam": null
        },
        "isHub": false,
        "aggregateBw": 0,
        "ipAddress": {
          "ipv6Prefix": null,
          "ipv4Prefix": {
            "string": "10.1.1.1/24"
          }
        },
        "secondaryAddresses": [
          {
            "ipv6Prefix": null,
            "ipv4Prefix": {
              "string": "3.2.1.1/24"
            }
          }
        ],
        "peSideAS": 6000,
        "routingStatic": {
          "routes": [
            {
              "routeType": "next_hop",
              "destination": {
                "ipv6Prefix": null,
                "ipv4Prefix": {
                  "string": "101.1.1.0/24"
                }
              },
              "targetIpAddress": {
                "ipv6Address": null,
                "ipv4Address": {
                  "string": "10.1.1.11"
                }
              },
              "preference": 5
            }
          ]
        },
        "routingBgp": {
          "routes": [
            {
              "peerIpAddress": {
                "ipv6Address": null,
                "ipv4Address": {
                  "string": "10.1.1.15"
                }
              },
              "peerAS": 6000
            }
          ]
        },
        "@class": "com.alu.wsc.api.generated.v4.L3ServiceEndpoint"
      },
      {
        "id": "4365-6ad41aed-d150-4bd0-a4a0-0221f36b5296",
        "appId": "202",
        "operationalState": "UP",
        "adminState": "UP",
        "neDeploymentState": "DEPLOYED",
        "externalIds": [
          {
            "context": "NFM_P",
            "location": [
              "135.121.156.100"
            ],
            "id": "svc-mgr:service-3:33.33.33.33:ip-interface-2"
          }
        ],
        "neId": "1531-d59d5bd3-01bc-4ee1-afae-76f9697c19cf",
        "neName": "C-33.33.33.33",
        "portId": "3127-8ef7dc06-5064-4aaa-aafc-8d2a46bb7992",
        "portName": "Port 1/1/11",
        "serviceId": "4354-8e80136a-e193-44e9-a1fc-311ff6869d6f",
        "name": "Port1_Name",
        "innerTag": -1,
        "outerTag": 71,
        "siteServiceQosProfile": {
          "qosProfile": 0,
          "ingressOverrideQueues": null,
          "egressOverrideQueues": null,
          "ingressParam": null,
          "egressParam": null
        },
        "isHub": false,
        "aggregateBw": 0,
        "ipAddress": {
          "ipv6Prefix": null,
          "ipv4Prefix": {
            "string": "15.1.1.11/24"
          }
        },
        "secondaryAddresses": [
          {
            "ipv6Prefix": null,
            "ipv4Prefix": {
              "string": "30.1.1.12/24"
            }
          }
        ],
        "peSideAS": 0,
        "routingStatic": {
          "routes": [
            {
              "routeType": "next_hop",
              "destination": {
                "ipv6Prefix": null,
                "ipv4Prefix": {
                  "string": "15.1.1.0/24"
                }
              },
              "targetIpAddress": {
                "ipv6Address": null,
                "ipv4Address": {
                  "string": "15.1.1.1"
                }
              },
              "preference": 5
            }
          ]
        },
        "routingBgp": {
          "routes": [
            {
              "peerIpAddress": {
                "ipv6Address": null,
                "ipv4Address": {
                  "string": "15.1.1.15"
                }
              },
              "peerAS": 6000
            }
          ]
        },
        "@class": "com.alu.wsc.api.generated.v4.L3ServiceEndpoint"
      }
    ],
    "mtu": 1500,
    "vcType": null,
    "autoBindType": "rsvp_te",
    "topology": "FULL_MESH_TOPOLOGY",
    "encryption": false,
    "loopbackEndpoints": null,
    "@class": "com.alu.wsc.api.generated.v4.L3Service"
  }
}