{ "swagger" : "2.0", "info" : { "description" : "This API describes the REST interface to interact with the Network Services Platform", "title" : "Network Services Platform REST API - v4", "license" : { } }, "host" : "10.0.0.67:8543", "basePath" : "/sdn/api", "tags" : [ { "name" : "sdn-nrcp-configuration", "description" : " " }, { "name" : "sdn-generic", "description" : " " }, { "name" : "sdn-services", "description" : " " }, { "name" : "sdn-ietf", "description" : " " }, { "name" : "sdn-backhaul-paths", "description" : " " }, { "name" : "sdn-mediation", "description" : " " }, { "name" : "sdn-mpls", "description" : " " }, { "name" : "sdn-mpls-lsp-path", "description" : " " }, { "name" : "sdn-ne", "description" : " " }, { "name" : "sdn-nsp", "description" : " " }, { "name" : "sdn-openflow", "description" : " " }, { "name" : "sdn-physicallinks", "description" : " " }, { "name" : "sdn-policy", "description" : " " }, { "name" : "sdn-ports", "description" : " " }, { "name" : "sdn-security", "description" : " " }, { "name" : "sdn-services", "description" : " " }, { "name" : "sdn-service-debug", "description" : " " }, { "name" : "sdn-system", "description" : " " }, { "name" : "sdn-template", "description" : " " }, { "name" : "sdn-tenants", "description" : " " }, { "name" : "sdn-usergroups", "description" : " " } ], "paths" : { "/v4/generic/application-id/{id}" : { "get" : { "tags" : [ "sdn-generic" ], "summary" : "Find an object by Application ID", "description" : "Find an object by Application ID", "operationId" : "getApplicationId", "produces" : [ "*/*" ], "parameters" : [ { "name" : "id", "in" : "path", "description" : "The Application ID of the object", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseEntity»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/generic/application-id/{id}/{appId}" : { "put" : { "tags" : [ "sdn-generic" ], "summary" : "Set an object Application ID", "description" : "Set an object Application ID", "operationId" : "setApplicationId", "consumes" : [ "application/json" ], "produces" : [ "*/*" ], "parameters" : [ { "name" : "appId", "in" : "path", "description" : "The Application ID to be set", "required" : false, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "The unique identifier of the object", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseEntity»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/generic/consumed/{uuid}" : { "get" : { "tags" : [ "sdn-generic" ], "summary" : "Find all objects being consumed by an object", "description" : "Find all objects being consumed by an object", "operationId" : "getConsumed", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier of the object", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«string»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/generic/find-by-external-id" : { "post" : { "tags" : [ "sdn-generic" ], "summary" : "Find the unique identifier of an object given an external identifier", "description" : "Find the unique identifier of an object given an external identifier", "operationId" : "findByExternalId", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "An external identifier to the NSP.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ExternalId»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«string»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/generic/tenants/{uuid}" : { "get" : { "tags" : [ "sdn-generic" ], "summary" : "Find all tenants assigned to an object", "description" : "Find all tenants assigned to an object", "operationId" : "getTenants", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifiers for the object", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«string»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/generic/{uuid}" : { "get" : { "tags" : [ "sdn-generic" ], "summary" : "Find an object by a unique identifier", "description" : "Find an object by a unique identifier", "operationId" : "get", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier for the query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseEntity»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Add an endpoint to a L2 Backhaul Service", "description" : "Add an endpoint to a L2 Backhaul Service", "operationId" : "addL2BackhaulEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "ETH transport services access parameters", "required" : false, "schema" : { "$ref" : "#/definitions/Request«NspEthtSvcAccessParameters»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint/{endpointUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Update endpoint of a L2 Backhaul service", "description" : "Update endpoint of a L2 Backhaul service", "operationId" : "updateL2BackhaulEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "ETH transport services access parameters", "required" : false, "schema" : { "$ref" : "#/definitions/Request«NspEthtSvcAccessParameters»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch endpoint of an L3 VPN service", "description" : "Patch endpoint of an L3 VPN service", "operationId" : "patchL2BackhaulEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be patched", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "ETH transport services access parameters", "required" : false, "schema" : { "$ref" : "#/definitions/Request«NspEthtSvcAccessParameters»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/ethtsvc/l2backhaul/{autoPath}" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create L2 Backhaul Service", "description" : "Create L2 Backhaul Service", "operationId" : "createL2backhaul", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "autoPath", "in" : "path", "description" : "If True SF will automatically compuate the best path and use it for service provisioning", "required" : false, "type" : "boolean" }, { "in" : "body", "name" : "body", "description" : "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«BackhaulL2RequestData»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/ethtsvc/l2backhaul/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify L2 Backhaul service", "description" : "Modify L2 Backhaul service", "operationId" : "updateL2backhaul", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«BackhaulL2RequestData»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch L2 Backhaul service", "description" : "Patch L2 Backhaul service", "operationId" : "patchL2backhaul", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«BackhaulL2RequestData»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being patched", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/te/link/{linkId}" : { "get" : { "tags" : [ "sdn-ietf" ], "summary" : "Get TE link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point).", "description" : "Get TE link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point).", "operationId" : "getLink", "produces" : [ "*/*" ], "parameters" : [ { "name" : "linkId", "in" : "path", "description" : "UUID: Identifier for a link", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Link»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/te/link/{linkUuid}" : { "patch" : { "tags" : [ "sdn-ietf" ], "summary" : "Patch TE link by updating the configuration parameters. Supported configuration parameter(s): SRLG, Latency, AdminStatus", "description" : "Patch TE link by updating the configuration parameters. Supported configuration parameter(s): SRLG, Latency, AdminStatus", "operationId" : "patchLink", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "linkUuid", "in" : "path", "description" : "The unique identifier of the TE link", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "TE link configuration grouping.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«TeLinkConfig»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Link»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/te/network/{networkId}" : { "get" : { "tags" : [ "sdn-ietf" ], "summary" : "Get TE network. A network has a UUID, attributes, a list of nodes and a list of links.", "description" : "Get TE network. A network has a UUID, attributes, a list of nodes and a list of links.", "operationId" : "getNetwork", "produces" : [ "*/*" ], "parameters" : [ { "name" : "networkId", "in" : "path", "description" : "UUID: Identifier for a network", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Network»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/te/networks" : { "get" : { "tags" : [ "sdn-ietf" ], "summary" : "Get TE networks. A list of networks where each network has a UUID.", "description" : "Get TE networks. A list of networks where each network has a UUID.", "operationId" : "getNetworks", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Networks»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/te/node/{nodeId}" : { "get" : { "tags" : [ "sdn-ietf" ], "summary" : "Get TE node. A node has a UUID, attributes and a list of termination-points.", "description" : "Get TE node. A node has a UUID, attributes and a list of termination-points.", "operationId" : "getNode", "produces" : [ "*/*" ], "parameters" : [ { "name" : "nodeId", "in" : "path", "description" : "UUID: Identifier for a node", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Node»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ietf/te/termination-point/{tpId}" : { "get" : { "tags" : [ "sdn-ietf" ], "summary" : "Get TE termination-point. A termination-point has a UUID and attributes.", "description" : "Get TE termination-point. A termination-point has a UUID and attributes.", "operationId" : "getTerminationPoint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tpId", "in" : "path", "description" : "UUID: Identifier for a termination-point", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«TerminationPoint»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/l2/backhaul/paths/l2-paths" : { "get" : { "tags" : [ "sdn-backhaul-paths" ], "summary" : "Get L2 Path", "description" : "Get L2 Path", "operationId" : "getL2Paths", "produces" : [ "*/*" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The path calculation request definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«PathSearchRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BackhaulPath»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mediation/ami-version-templates" : { "get" : { "tags" : [ "sdn-mediation" ], "summary" : "Fetch the template global names for all AMIs, grouped by AMI", "description" : "Fetch the template global names for all AMIs, grouped by AMI", "operationId" : "getAmiVersionTemplates", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«AmiNameVersionTemplates»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mediation/amis-versions" : { "get" : { "tags" : [ "sdn-mediation" ], "summary" : "Fetch the AMIs and the versions.", "description" : "Fetch the AMIs and the versions.", "operationId" : "getAmisVersions", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«AmiNameVersions»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mediation/augmentation-meta" : { "get" : { "tags" : [ "sdn-mediation" ], "summary" : "Query all Augmentation Meta Infos", "description" : "Query all Augmentation Meta Infos", "operationId" : "getAllAugmentationMeta", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«AugmentationMetaInput»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-mediation" ], "summary" : "Create an Augmentation Meta", "description" : "Create an Augmentation Meta", "operationId" : "createAugmentationMeta", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Request to update the JSON augmentation meta information for a given hierarchy and template.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«AugmentationMeta»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«AugmentationMeta»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mediation/augmentation-meta/{id}" : { "put" : { "tags" : [ "sdn-mediation" ], "summary" : "Modify an Augmentation Meta", "description" : "Modify an Augmentation Meta", "operationId" : "updateAugmentationMeta", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Json file name to read the json from the file for Augmentation Meta.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«AugmentationMetaJsonFileName»" } }, { "name" : "id", "in" : "path", "description" : "The unique ID of the augmentation-meta that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«AugmentationMeta»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-mediation" ], "summary" : "Delete an Augmentation meta", "description" : "Delete an Augmentation meta", "operationId" : "deleteAugmentationMeta", "produces" : [ "*/*" ], "parameters" : [ { "name" : "id", "in" : "path", "description" : "The unique ID of the augmentation-meta that is being deleted", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mediation/mediation-augmentation" : { "post" : { "tags" : [ "sdn-mediation" ], "summary" : "This action is to fetch the meta information of the passthrough attributes that could be provided during a template invocation. The returned information would be a JSON describing the attributes, their types, and optional constraint information", "description" : "This action is to fetch the meta information of the passthrough attributes that could be provided during a template invocation. The returned information would be a JSON describing the attributes, their types, and optional constraint information", "operationId" : "getMediationAugmentation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Mediation Augmentation Request", "required" : false, "schema" : { "$ref" : "#/definitions/Request«MediationAugmentationRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«string»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsp-list" : { "post" : { "tags" : [ "sdn-mpls" ], "summary" : "Fetch RSVP or SR-TE LSP list which discovered by SDN through device management NFMP or MDM", "description" : "Fetch RSVP or SR-TE LSP list which discovered by SDN through device management NFMP or MDM", "operationId" : "fetchLspList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "IDs: List of unique LSP identifiers", "required" : false, "schema" : { "$ref" : "#/definitions/Request«List«string»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Lsp»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsp-path" : { "post" : { "tags" : [ "sdn-mpls" ], "summary" : "Asynchronous API to create MPLS LSP path (PCE Initiated only)", "description" : "Asynchronous API to create MPLS LSP path (PCE Initiated only)", "operationId" : "createLspPath", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "lspPathConfigRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«LspPathConfigRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«string»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsp-path-list" : { "post" : { "tags" : [ "sdn-mpls" ], "summary" : "Fetch MPLS LSP path list", "description" : "Fetch MPLS LSP path list", "operationId" : "fetchLspPathList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "IDs: List of unique LSP path identifiers", "required" : false, "schema" : { "$ref" : "#/definitions/Request«List«string»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«LspPath»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsp-path/{pathId}" : { "get" : { "tags" : [ "sdn-mpls" ], "summary" : "Get MPLS LSP path", "description" : "Get MPLS LSP path", "operationId" : "getLspPath", "produces" : [ "*/*" ], "parameters" : [ { "name" : "pathId", "in" : "path", "description" : "ID: Unique LSP path identifier", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«LspPath»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-mpls" ], "summary" : "Asynchronous API to delete MPLS LSP path(PCE Initiated only)", "description" : "Asynchronous API to delete MPLS LSP path(PCE Initiated only)", "operationId" : "deleteLspPath", "produces" : [ "*/*" ], "parameters" : [ { "name" : "pathId", "in" : "path", "description" : "ID: Unique LSP path identifier", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-mpls" ], "summary" : "Asynchronous API to patch PCE Initiated MPLS LSP path config and add/remove path profile override for a MPLS LSP path. Setting pathProfileId.profileId = -1 deletes overide and sending same pathProfileOverride will cause a reset if the profileOverrideState is FAILED.", "description" : "Asynchronous API to patch PCE Initiated MPLS LSP path config and add/remove path profile override for a MPLS LSP path. Setting pathProfileId.profileId = -1 deletes overide and sending same pathProfileOverride will cause a reset if the profileOverrideState is FAILED.", "operationId" : "patchLspPath", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "lspPathConfigRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«LspPathConfigRequest»" } }, { "name" : "pathId", "in" : "path", "description" : "ID: Unique LSP path identifier", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsp-paths" : { "get" : { "tags" : [ "sdn-mpls" ], "summary" : "Get MPLS LSP paths", "description" : "Get MPLS LSP paths", "operationId" : "getLspPaths", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«LspPath»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-mpls" ], "summary" : "Asynchronous API to create MPLS LSP paths(PCE Initiated only)", "description" : "Asynchronous API to create MPLS LSP paths(PCE Initiated only)", "operationId" : "createLspPaths", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "lspPathConfigRequests", "required" : true, "schema" : { "$ref" : "#/definitions/Request«List«LspPathConfigRequest»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«string»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-mpls" ], "summary" : "Asynchronous API to delete MPLS LSP paths(PCE Initiated only). List maximum size is 500.", "description" : "Asynchronous API to delete MPLS LSP paths(PCE Initiated only). List maximum size is 500.", "operationId" : "deleteLspPaths", "produces" : [ "*/*" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "pathIds", "required" : true, "schema" : { "$ref" : "#/definitions/Request«List«string»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsp-paths-paginated/{limit}/{page}" : { "get" : { "tags" : [ "sdn-mpls" ], "summary" : "Get MPLS LSP paths", "description" : "Get MPLS LSP paths", "operationId" : "getLspPathsPaginated", "produces" : [ "*/*" ], "parameters" : [ { "name" : "limit", "in" : "path", "description" : "Size of results per page. Greater than or equal to 0", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "page", "in" : "path", "description" : "Zero-based index of result set", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«LspPath»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsp/paths/on-link/{linkId}/{requestType}" : { "get" : { "tags" : [ "sdn-mpls-lsp-path" ], "summary" : "Get MPLS LSP paths on link", "description" : "Get MPLS LSP paths on link", "operationId" : "getOnLink", "produces" : [ "*/*" ], "parameters" : [ { "name" : "linkId", "in" : "path", "description" : "UUID: Identifier for a link", "required" : false, "type" : "string" }, { "name" : "requestType", "in" : "path", "description" : "OUTGOING: Return all LSP Paths in the forward direction of the link which egress from this router. INCOMING: Return all LSP paths that ingress into the router on this link. LSPs are unidirectional, however links form symmetric adjacencies/neighbours when point to point and it may be valuable to know which LSPs flow across a given adjacency from the other router. For broadcast links, the termination point between a router and the subnet effectively carries LSP path traffic in both directions. This option will return the list of LSPs which transit through neighbor routers, the subnet and then to this router MOVED: Return all LSP paths moved off the link due to maintenance enabled.", "required" : false, "type" : "string", "enum" : [ "MOVED", "INCOMING", "OUTGOING" ] } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«LspPath»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsp/{lspId}" : { "get" : { "tags" : [ "sdn-mpls" ], "summary" : "Get RSVP or SR-TE LSP which discovered by SDN through device management NFMP or MDM", "description" : "Get RSVP or SR-TE LSP which discovered by SDN through device management NFMP or MDM", "operationId" : "getLsp", "produces" : [ "*/*" ], "parameters" : [ { "name" : "lspId", "in" : "path", "description" : "ID: Unique LSP identifier", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Lsp»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/lsps" : { "get" : { "tags" : [ "sdn-mpls" ], "summary" : "Get RSVP or SR-TE LSPs which discovered by SDN through device management NFMP or MDM", "description" : "Get RSVP or SR-TE LSPs which discovered by SDN through device management NFMP or MDM", "operationId" : "getLsps", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Lsp»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/optimization" : { "post" : { "tags" : [ "sdn-mpls" ], "summary" : "Trigger global concurrent optimization on PCEP LSP paths", "description" : "Trigger global concurrent optimization on PCEP LSP paths", "operationId" : "createOptimization", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "IDs: List of unique LSP paths identifiers", "required" : false, "schema" : { "$ref" : "#/definitions/Request«List«string»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/mpls/resignal" : { "post" : { "tags" : [ "sdn-mpls" ], "summary" : "Trigger resignal on a list of PCEP LSP paths", "description" : "Trigger resignal on a list of PCEP LSP paths", "operationId" : "createResignal", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "IDs: List of unique LSP paths identifiers", "required" : false, "schema" : { "$ref" : "#/definitions/Request«List«string»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ne" : { "get" : { "tags" : [ "sdn-ne" ], "summary" : "Query all Network Elements", "description" : "Query all Network Elements", "operationId" : "gets", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«NetworkElement»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ne/system/{systemId}" : { "get" : { "tags" : [ "sdn-ne" ], "summary" : "Query a unique identifier for a Network Element by System ID", "description" : "Query a unique identifier for a Network Element by System ID", "operationId" : "getSystem", "produces" : [ "*/*" ], "parameters" : [ { "name" : "systemId", "in" : "path", "description" : "The System ID for the Network Element to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«NetworkElement»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ne/{id}" : { "put" : { "tags" : [ "sdn-ne" ], "summary" : "Update Network Element capabilities", "description" : "Update Network Element capabilities", "operationId" : "update", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "description" : "The unique identifier of the network element", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "A request object used to modify Network Element", "required" : false, "schema" : { "$ref" : "#/definitions/Request«NetworkElementRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ne/{uuid}" : { "get" : { "tags" : [ "sdn-ne" ], "summary" : "Find a network element by a unique identifier", "description" : "Find a network element by a unique identifier", "operationId" : "get", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier for the query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«NetworkElement»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/configuration/latency" : { "get" : { "tags" : [ "sdn-nrcp-configuration" ], "summary" : "Get NSP latency parameters", "description" : "Get NSP latency parameters", "operationId" : "getLatency", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Latency»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-nrcp-configuration" ], "summary" : "Patch NSP latency parameters", "description" : "Patch NSP latency parameters", "operationId" : "patchLatency", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Grouping of all latency related parameters for IP/MPLS optimization. If using classic mode, the user must define the session name, source, and destination for twamp tests using the twampTests body. Test session names must be unique among all tests. A new test with an already used session name will overwrite previous one.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«Latency»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/configuration/latency/{session}" : { "delete" : { "tags" : [ "sdn-nrcp-configuration" ], "summary" : "API used to delete twamp tests.", "description" : "API used to delete twamp tests.", "operationId" : "deleteLatency", "produces" : [ "*/*" ], "parameters" : [ { "name" : "session", "in" : "path", "description" : "Session name for test to be removed. If session is \"all\" it will remove all tests.", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/configuration/tca-config-policy" : { "get" : { "tags" : [ "sdn-nrcp-configuration" ], "summary" : "Get TCA Policy configuration. Policies configuration include list of policies and collection enable flag", "description" : "Get TCA Policy configuration. Policies configuration include list of policies and collection enable flag", "operationId" : "getTcaConfigPolicy", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«SnmpTcaPolicyInfo»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-nrcp-configuration" ], "summary" : "Patch a TCA configuration policy by updating the parameters", "description" : "Patch a TCA configuration policy by updating the parameters", "operationId" : "patchTcaConfigPolicy", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "NSP configuration on SNMP TCA policy for statistic collection", "required" : false, "schema" : { "$ref" : "#/definitions/Request«SnmpTcaPolicyInfo»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/configuration/traffic-data-collection" : { "get" : { "tags" : [ "sdn-nrcp-configuration" ], "summary" : "Get NSP traffic collection parameters.", "description" : "Get NSP traffic collection parameters.", "operationId" : "getTrafficDataCollection", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«TrafficDataCollection»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-nrcp-configuration" ], "summary" : "Patch NSP traffic-collection parameters.", "description" : "Patch NSP traffic-collection parameters.", "operationId" : "patchTrafficDataCollection", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Grouping of all traffic collection parameters", "required" : false, "schema" : { "$ref" : "#/definitions/Request«TrafficDataCollection»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/link/tp/{tpId}" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get link connected to the given termination point. The link may be a source or destination on the termination point. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point)", "description" : "Get link connected to the given termination point. The link may be a source or destination on the termination point. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point)", "operationId" : "getLinkTp", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tpId", "in" : "path", "description" : "UUID: Identifier for a termination point", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Link»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/link/{linkId}" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point)", "description" : "Get link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point)", "operationId" : "getLink", "produces" : [ "*/*" ], "parameters" : [ { "name" : "linkId", "in" : "path", "description" : "UUID: Identifier for a link", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Link»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/link/{linkUuid}" : { "patch" : { "tags" : [ "sdn-nsp" ], "summary" : "Patch a link by updating the configuration parameters. Configuration parameters supported are srlg-value, latency, te-metric, igp-metric, administrative-group, admin-status, measuredIpBw and measuredMplsBw", "description" : "Patch a link by updating the configuration parameters. Configuration parameters supported are srlg-value, latency, te-metric, igp-metric, administrative-group, admin-status, measuredIpBw and measuredMplsBw", "operationId" : "patchLink", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "NSP link parameters grouping", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LinkParams»" } }, { "name" : "linkUuid", "in" : "path", "description" : "The unique identifier of the link", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Link»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/network/{networkId}" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get NSP network. A network has a UUID, attributes, a list of nodes and a list of links", "description" : "Get NSP network. A network has a UUID, attributes, a list of nodes and a list of links", "operationId" : "getNetwork", "produces" : [ "*/*" ], "parameters" : [ { "name" : "networkId", "in" : "path", "description" : "UUID: Identifier for a network", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Network»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/networks" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get NSP networks. A list of networks where each network has a UUID", "description" : "Get NSP networks. A list of networks where each network has a UUID", "operationId" : "getNetworks", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Networks»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/node/{nodeId}" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get NSP node. A node has a UUID, attributes and a list of termination-points", "description" : "Get NSP node. A node has a UUID, attributes and a list of termination-points", "operationId" : "getNode", "produces" : [ "*/*" ], "parameters" : [ { "name" : "nodeId", "in" : "path", "description" : "UUID: Identifier for a node", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Node»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/nodes/router/{routerId}" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get NSP nodes by IGP Router ID. A node has a UUID, attributes and a list of termination-points", "description" : "Get NSP nodes by IGP Router ID. A node has a UUID, attributes and a list of termination-points", "operationId" : "getNodesRouter", "produces" : [ "*/*" ], "parameters" : [ { "name" : "routerId", "in" : "path", "description" : "IPv4 IGP Router ID of the node", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«NspNodeWithNetwork»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/nodes/site/{siteIp}" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get NSP nodes by Site IP. A node has a UUID, attributes and a list of termination-points", "description" : "Get NSP nodes by Site IP. A node has a UUID, attributes and a list of termination-points", "operationId" : "getNodesSite", "produces" : [ "*/*" ], "parameters" : [ { "name" : "siteIp", "in" : "path", "description" : "IPv4 Site ID of the node", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«NspNodeWithNetwork»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/termination-point/{tpId}" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get NSP termination-point. A termination-point has a UUID and attributes", "description" : "Get NSP termination-point. A termination-point has a UUID and attributes", "operationId" : "getTerminationPoint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tpId", "in" : "path", "description" : "UUID: Identifier for a termination-point", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«TerminationPoint»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/termination-point/{tpId}/reverse" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get NSP reverse termination-point for a given UUID. If the UUID corresponds to a termination point on a point-to-point link, the returned termination point will be the termination point on the connected remote router. If the UUID corresponds to a termination point on a broadcast link, the returned termination point will be the reverse termination point connected to the source router", "description" : "Get NSP reverse termination-point for a given UUID. If the UUID corresponds to a termination point on a point-to-point link, the returned termination point will be the termination point on the connected remote router. If the UUID corresponds to a termination point on a broadcast link, the returned termination point will be the reverse termination point connected to the source router", "operationId" : "getTerminationPointReverse", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tpId", "in" : "path", "description" : "UUID: Identifier for a termination-point", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«TerminationPoint»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/nsp/net/l3/termination-points/{nodeId}/{ipAddress}" : { "get" : { "tags" : [ "sdn-nsp" ], "summary" : "Get NSP termination-point for a given node ID and IP Address", "description" : "Get NSP termination-point for a given node ID and IP Address", "operationId" : "getTerminationPointsNodeip", "produces" : [ "*/*" ], "parameters" : [ { "name" : "ipAddress", "in" : "path", "description" : "The IP Address of the termination point", "required" : false, "type" : "string" }, { "name" : "nodeId", "in" : "path", "description" : "UUID: Identifier for a node", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«NspTerminationPoint»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/openflow/flows" : { "post" : { "tags" : [ "sdn-openflow" ], "summary" : "Create flows", "description" : "Create flows", "operationId" : "createFlows", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "flows", "required" : true, "schema" : { "$ref" : "#/definitions/Request«List«OpenflowFlowEntryRequest»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/DeferredResult«ResponseData«List«OpenflowFlowEntry»»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-openflow" ], "summary" : "Delete flows", "description" : "Delete flows", "operationId" : "deleteFlows", "produces" : [ "*/*" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The unique identifers of the flows to be deleted", "required" : false, "schema" : { "$ref" : "#/definitions/Request«List«string»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/DeferredResult«ResponseData«List«OpenflowFlowEntry»»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-openflow" ], "summary" : "Update flow instruction", "description" : "Update flow instruction", "operationId" : "patchFlows", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "flows", "required" : true, "schema" : { "$ref" : "#/definitions/Request«List«OpenflowFlowUpdateEntry»»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/DeferredResult«ResponseData«List«OpenflowFlowEntry»»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/openflow/flows/search" : { "post" : { "tags" : [ "sdn-openflow" ], "summary" : "Query flows based on search criteria", "description" : "Query flows based on search criteria", "operationId" : "getFlowsearch", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Search criteria", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpenflowFlowSearch»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/DeferredResult«ResponseData«List«OpenflowFlowEntry»»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/openflow/flows/search-by-id" : { "post" : { "tags" : [ "sdn-openflow" ], "summary" : "Query flows based on unique identifier", "description" : "Query flows based on unique identifier", "operationId" : "getFlowsearchById", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The unique identifiers of the flows to find", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpenflowFlowSearchById»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpenflowFlowEntry»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/openflow/ports/{datapathId}" : { "get" : { "tags" : [ "sdn-openflow" ], "summary" : "Query all ports of an openflow switch", "description" : "Query all ports of an openflow switch", "operationId" : "getPorts", "produces" : [ "*/*" ], "parameters" : [ { "name" : "datapathId", "in" : "path", "description" : "The hexadecimal openflow data-path id for this switch", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpenflowPort»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/openflow/switches" : { "get" : { "tags" : [ "sdn-openflow" ], "summary" : "Query all openflow switches", "description" : "Query all openflow switches", "operationId" : "getSwitches", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpenflowSwitch»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/openflow/switches/{neId}" : { "get" : { "tags" : [ "sdn-openflow" ], "summary" : "Query all openflow switches in a router", "description" : "Query all openflow switches in a router", "operationId" : "getSwitchesInRouter", "produces" : [ "*/*" ], "parameters" : [ { "name" : "neId", "in" : "path", "description" : "The unique identifier for the selected network element router", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpenflowSwitch»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/openflow/tables/{datapathId}" : { "get" : { "tags" : [ "sdn-openflow" ], "summary" : "Query all tables in an openflow switch", "description" : "Query all tables in an openflow switch", "operationId" : "getTables", "produces" : [ "*/*" ], "parameters" : [ { "name" : "datapathId", "in" : "path", "description" : "The hexadecimal openflow data-path id for this switch", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpenflowTable»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/physicallinks" : { "get" : { "tags" : [ "sdn-physicallinks" ], "summary" : "Query all physical links", "description" : "Query all physical links", "operationId" : "gets", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«PhysicalLink»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/physicallinks/{linkId}" : { "delete" : { "tags" : [ "sdn-physicallinks" ], "summary" : "Delete an undiscovered physical link that was defined in NSP", "description" : "Delete an undiscovered physical link that was defined in NSP", "operationId" : "delete", "produces" : [ "*/*" ], "parameters" : [ { "name" : "linkId", "in" : "path", "description" : "The unique identifier for the link to be deleted", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/physicallinks/{srcId}/{destId}" : { "post" : { "tags" : [ "sdn-physicallinks" ], "summary" : "Define an undicovered physical link in NSP", "description" : "Define an undicovered physical link in NSP", "operationId" : "create", "consumes" : [ "application/json" ], "produces" : [ "*/*" ], "parameters" : [ { "name" : "destId", "in" : "path", "description" : "The unique identifier for the destination port", "required" : false, "type" : "string" }, { "name" : "srcId", "in" : "path", "description" : "The unique identifier for the source port", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«PhysicalLink»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/physicallinks/{uuid}" : { "get" : { "tags" : [ "sdn-physicallinks" ], "summary" : "Find a physical link by a unique identifier", "description" : "Find a physical link by a unique identifier", "operationId" : "get", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier for the query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«PhysicalLink»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/ip-optical-correlation-policiy" : { "get" : { "tags" : [ "sdn-policy" ], "summary" : "Query all IP Optical correlation policies", "description" : "Query all IP Optical correlation policies", "operationId" : "getAllIpOpticalCorrelationPolicy", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«IpOpticalCorrelationPolicy»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/ip-optical-correlation-policy" : { "post" : { "tags" : [ "sdn-policy" ], "summary" : "Create an IP Optical correlation policy", "description" : "Create an IP Optical correlation policy", "operationId" : "createIpOpticalCorrelationPolicy", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "IP Optical correlation policies", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpOpticalCorrelationPolicy»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«IpOpticalCorrelationPolicy»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/ip-optical-correlation-policy/{policyId}" : { "get" : { "tags" : [ "sdn-policy" ], "summary" : "Query an IP Optical correlation policy", "description" : "Query an IP Optical correlation policy", "operationId" : "getIpOpticalCorrelationPolicy", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "Policy id", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«IpOpticalCorrelationPolicy»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-policy" ], "summary" : "Update an IP Optical correlation policy", "description" : "Update an IP Optical correlation policy", "operationId" : "updateIpOpticalCorrelationPolicy", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "IP Optical correlation policies", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpOpticalCorrelationPolicy»" } }, { "name" : "policyId", "in" : "path", "description" : "The unique ID of the policy that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-policy" ], "summary" : "Delete an IP Optical correlation policy", "description" : "Delete an IP Optical correlation policy", "operationId" : "deleteIpOpticalCorrelationPolicy", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "Policy id", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/rd-rt-ranges" : { "get" : { "tags" : [ "sdn-policy" ], "summary" : "Query all L3VPN RT/RD policies", "description" : "Query all L3VPN RT/RD policies", "operationId" : "getAllRdRtRanges", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«L3vpnRdRtPolicy»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-policy" ], "summary" : "Create a L3VPN RT/RD policy", "description" : "Create a L3VPN RT/RD policy", "operationId" : "createRdRtRanges", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "L3VPN RT/RD policy", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L3vpnRdRtPolicy»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«L3vpnRdRtPolicy»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/rd-rt-ranges/{policyId}" : { "put" : { "tags" : [ "sdn-policy" ], "summary" : "Update a L3VPN RT/RD policy", "description" : "Update a L3VPN RT/RD policy", "operationId" : "updateRdRtRanges", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "L3VPN RT/RD policy", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L3vpnRdRtPolicy»" } }, { "name" : "policyId", "in" : "path", "description" : "The unique ID of the policy that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-policy" ], "summary" : "Delete an existing L3VPN RT/RD policy.", "description" : "Delete an existing L3VPN RT/RD policy.", "operationId" : "deleteRdRtRanges", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "policyId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/router-port-protection-group-policy" : { "get" : { "tags" : [ "sdn-policy" ], "summary" : "Query all router port protection group policies", "description" : "Query all router port protection group policies", "operationId" : "getAllRouterPortProtectionGroupPolicy", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«RouterPortProtectionGroupPolicy»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-policy" ], "summary" : "Create a router port protection group policy", "description" : "Create a router port protection group policy", "operationId" : "createRouterPortProtectionGroupPolicy", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Router Port Protection Group policies", "required" : false, "schema" : { "$ref" : "#/definitions/Request«RouterPortProtectionGroupPolicy»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«RouterPortProtectionGroupPolicy»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/router-port-protection-group-policy/{policyId}" : { "get" : { "tags" : [ "sdn-policy" ], "summary" : "Query a router port protection group policy", "description" : "Query a router port protection group policy", "operationId" : "getRouterPortProtectionGroupPolicy", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "Policy id", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«RouterPortProtectionGroupPolicy»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-policy" ], "summary" : "Update a router port protection group policy", "description" : "Update a router port protection group policy", "operationId" : "updateRouterPortProtectionGroupPolicy", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "The unique ID of the policy that is being modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Router Port Protection Group policies", "required" : false, "schema" : { "$ref" : "#/definitions/Request«RouterPortProtectionGroupPolicy»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-policy" ], "summary" : "Delete a router port protection group policy", "description" : "Delete a router port protection group policy", "operationId" : "deleteRouterPortProtectionGroupPolicy", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "Policy id", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/steering-parameter" : { "post" : { "tags" : [ "sdn-policy" ], "summary" : "Create a Steering Parameter", "description" : "Create a Steering Parameter", "operationId" : "createSteeringParameter", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "A steering parameter is used to mark tunnels and guide tunnel selection", "required" : false, "schema" : { "$ref" : "#/definitions/Request«SteeringParameter»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«SteeringParameter»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/steering-parameter/{steeringParameterName}" : { "delete" : { "tags" : [ "sdn-policy" ], "summary" : "Delete a Steering Parameter", "description" : "Delete a Steering Parameter", "operationId" : "deleteSteeringParameter", "produces" : [ "*/*" ], "parameters" : [ { "name" : "steeringParameterName", "in" : "path", "description" : "The name of the Steering Parameter to be deleted", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/steering-parameters" : { "get" : { "tags" : [ "sdn-policy" ], "summary" : "Query all Steering Paramters", "description" : "Query all Steering Paramters", "operationId" : "getSteeringParameters", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«SteeringParameter»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/tunnel-selections" : { "get" : { "tags" : [ "sdn-policy" ], "summary" : "Query all tunnel selection policies.", "description" : "Query all tunnel selection policies.", "operationId" : "getAllTunnelSelections", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«TunnelSelectionTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-policy" ], "summary" : "Create a tunnel selection policy.", "description" : "Create a tunnel selection policy.", "operationId" : "createTunnelSelections", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The tunnel selection template controls system behaviour when selecting/creating tunnels in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«TunnelSelectionTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«TunnelSelectionTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/policy/tunnel-selections/{policyId}" : { "get" : { "tags" : [ "sdn-policy" ], "summary" : "Query a tunnel selections policy by its unique identifier.", "description" : "Query a tunnel selections policy by its unique identifier.", "operationId" : "getTunnelSelections", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "policyId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«TunnelSelectionTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-policy" ], "summary" : "Update a tunnel selection policy.", "description" : "Update a tunnel selection policy.", "operationId" : "updateTunnelSelections", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "The unique ID of the policy that is being modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The tunnel selection template controls system behaviour when selecting/creating tunnels in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«TunnelSelectionTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-policy" ], "summary" : "Delete an existing tunnel selections policy.", "description" : "Delete an existing tunnel selections policy.", "operationId" : "deleteTunnelSelections", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "policyId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ports" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "Find all ports in the network", "description" : "Find all ports in the network", "operationId" : "gets", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Port»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ports/ne-all-by-tenant/{neId}/tenant/{tenantUuid}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "getNeAllByTenant", "operationId" : "getNeAllByTenant", "produces" : [ "*/*" ], "parameters" : [ { "name" : "neId", "in" : "path", "description" : "The unique identifier of the network element to be queried", "required" : false, "type" : "string" }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Port»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/ports/ne-all/{neId}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "Query all ports of the provided network element", "description" : "Query all ports of the provided network element", "operationId" : "getNeAll", "produces" : [ "*/*" ], "parameters" : [ { "name" : "neId", "in" : "path", "description" : "The unique identifier of the network element to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Port»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ports/ne-by-tenant/{neId}/servicetype/{serviceType}/tenant/{tenantUuid}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "getNeByTenant", "operationId" : "getNeByTenant", "produces" : [ "*/*" ], "parameters" : [ { "name" : "neId", "in" : "path", "description" : "The unique identifier of the network element to be queried", "required" : false, "type" : "string" }, { "name" : "serviceType", "in" : "path", "description" : "The service type for the port to be queried", "required" : false, "type" : "string", "enum" : [ "ODU", "TUNNEL", "EACCESS", "L2_EXTENSION_UNI", "CLINE", "L2_EXTENSION_NNI", "L2_BACKHAUL", "L2_DCI", "PHYSICAL_LINK", "LAG", "ELAN", "OCH", "ELINE", "IES", "L3_VPN", "L3_DCI" ] }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Port»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/ports/ne/{neUuid}/servicetype/{serviceType}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "Query all ports of the provided network element of a service type", "description" : "Query all ports of the provided network element of a service type", "operationId" : "getNe", "produces" : [ "*/*" ], "parameters" : [ { "name" : "neUuid", "in" : "path", "description" : "The unique identifier of the network element to be queried", "required" : false, "type" : "string" }, { "name" : "serviceType", "in" : "path", "description" : "The service type for the port to be queried", "required" : false, "type" : "string", "enum" : [ "ODU", "TUNNEL", "EACCESS", "L2_EXTENSION_UNI", "CLINE", "L2_EXTENSION_NNI", "L2_BACKHAUL", "L2_DCI", "PHYSICAL_LINK", "LAG", "ELAN", "OCH", "ELINE", "IES", "L3_VPN", "L3_DCI" ] } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Port»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ports/service-count-on-port/{portUuid}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "Find number of services on a specified port", "description" : "Find number of services on a specified port", "operationId" : "getServiceCountOnPort", "produces" : [ "*/*" ], "parameters" : [ { "name" : "portUuid", "in" : "path", "description" : "The unique identifier for the query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«long»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ports/services-on-port/{portUuid}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "Query all services using a port", "description" : "Query all services using a port", "operationId" : "getServicesOnPort", "produces" : [ "*/*" ], "parameters" : [ { "name" : "portUuid", "in" : "path", "description" : "The unique identifier of the port to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«BaseService»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ports/servicetype/{serviceType}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "Find all ports in the network that support a given service type", "description" : "Find all ports in the network that support a given service type", "operationId" : "getServicetype", "produces" : [ "*/*" ], "parameters" : [ { "name" : "serviceType", "in" : "path", "description" : "The service type for the port to be queried", "required" : false, "type" : "string", "enum" : [ "ODU", "TUNNEL", "EACCESS", "L2_EXTENSION_UNI", "CLINE", "L2_EXTENSION_NNI", "L2_BACKHAUL", "L2_DCI", "PHYSICAL_LINK", "LAG", "ELAN", "OCH", "ELINE", "IES", "L3_VPN", "L3_DCI" ] } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Port»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ports/servicetype/{serviceType}/tenant/{tenantUuid}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "getServicetypeByTenant", "operationId" : "getServicetypeByTenant", "produces" : [ "*/*" ], "parameters" : [ { "name" : "serviceType", "in" : "path", "description" : "The service type for the port to be queried", "required" : false, "type" : "string", "enum" : [ "ODU", "TUNNEL", "EACCESS", "L2_EXTENSION_UNI", "CLINE", "L2_EXTENSION_NNI", "L2_BACKHAUL", "L2_DCI", "PHYSICAL_LINK", "LAG", "ELAN", "OCH", "ELINE", "IES", "L3_VPN", "L3_DCI" ] }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Port»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/ports/tenant/{tenantUuid}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "getTenant", "operationId" : "getTenant", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Port»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/ports/{id}" : { "put" : { "tags" : [ "sdn-ports" ], "summary" : "Update the port", "description" : "Update the port", "operationId" : "update", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "description" : "The unique identifier of the port to be modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "A request object used to modify Port", "required" : false, "schema" : { "$ref" : "#/definitions/Request«PortRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Port»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/ports/{portUuid}" : { "get" : { "tags" : [ "sdn-ports" ], "summary" : "Find a port by unique identifier", "description" : "Find a port by unique identifier", "operationId" : "get", "produces" : [ "*/*" ], "parameters" : [ { "name" : "portUuid", "in" : "path", "description" : "The unique identifier for the query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Port»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/security/authentication" : { "get" : { "tags" : [ "sdn-security" ], "summary" : "Retrieve information about the currently-authenticated user from the perspective of the system", "description" : "Retrieve information about the currently-authenticated user from the perspective of the system", "operationId" : "getAuthentication", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Authentication»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/servicedebug/constraint-test/{serviceUuid}" : { "post" : { "tags" : [ "sdn-service-debug" ], "summary" : "BETA - Run service constraint test", "description" : "BETA - Run service constraint test", "operationId" : "createConstraintTest", "consumes" : [ "application/json" ], "produces" : [ "*/*" ], "parameters" : [ { "name" : "serviceUuid", "in" : "path", "description" : "The UUID of service to run constraint test on", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ServiceDebugResult»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/servicedebug/dci-recompute/{serviceUuid}" : { "post" : { "tags" : [ "sdn-service-debug" ], "summary" : "Triggers re-computation for a L2 or L3 DCI Service. The DCI Service types automatically react to topological and service requirements and perform necessary differential actions for the service however this API can be used to manually invoke that execution. The process that is normally automatically triggered to differentiate the service state with the required state will be triggered", "description" : "Triggers re-computation for a L2 or L3 DCI Service. The DCI Service types automatically react to topological and service requirements and perform necessary differential actions for the service however this API can be used to manually invoke that execution. The process that is normally automatically triggered to differentiate the service state with the required state will be triggered", "operationId" : "createDciRecompute", "consumes" : [ "application/json" ], "produces" : [ "*/*" ], "parameters" : [ { "name" : "serviceUuid", "in" : "path", "description" : "The UUID of the L2 or L3 DCI Service to run a re-computation against. Differential Output will only be visible in the NSP log files. The result of this API will indicate whether the process was queued", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Query all service objects", "description" : "Query all service objects", "operationId" : "gets", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«BaseService»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/clines" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create a C-Line service", "description" : "Create a C-Line service", "operationId" : "createClines", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized IP C-Line service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ClineServiceRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/clines/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify a C-Line service", "description" : "Modify a C-Line service", "operationId" : "updateClines", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized IP C-Line service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ClineServiceRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch a C-Line service", "description" : "Patch a C-Line service", "operationId" : "patchClines", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized IP C-Line service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ClineServiceRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being patched", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/clines/{serviceUuid}/endpoint/{endpointUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Update the endpoint of a C-Line service", "description" : "Update the endpoint of a C-Line service", "operationId" : "updateClineEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be updated", "required" : false, "type" : "string" }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The TDM DS0 channel group definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«TdmEndpointRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch the endpoint of a C-Line service", "description" : "Patch the endpoint of a C-Line service", "operationId" : "patchClineEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be patched", "required" : false, "type" : "string" }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The TDM DS0 channel group definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«TdmEndpointRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/components/{uuid}" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Retrieve inventory of service endpoints, tunnels, and physical links for the requested service UUID", "description" : "Retrieve inventory of service endpoints, tunnels, and physical links for the requested service UUID", "operationId" : "getComponents", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier of service", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ServiceHierarchy»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/eaccess" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create an IP E-Access service", "description" : "Create an IP E-Access service", "operationId" : "createEaccess", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized E-Access service request", "required" : false, "schema" : { "$ref" : "#/definitions/Request«EaccessRequestData»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/eaccess/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify an IP E-Access service", "description" : "Modify an IP E-Access service", "operationId" : "updateEaccess", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized E-Access service request", "required" : false, "schema" : { "$ref" : "#/definitions/Request«EaccessRequestData»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch an IP E-Access service", "description" : "Patch an IP E-Access service", "operationId" : "patchEaccess", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized E-Access service request", "required" : false, "schema" : { "$ref" : "#/definitions/Request«EaccessRequestData»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being patched", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/elans" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create an E-LAN VPN service", "description" : "Create an E-LAN VPN service", "operationId" : "createElans", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized E-LAN service request", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpElanServiceRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/elans/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify an E-LAN service", "description" : "Modify an E-LAN service", "operationId" : "updateElans", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized E-LAN service request", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpElanServiceRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch an E-LAN service", "description" : "Patch an E-LAN service", "operationId" : "patchElans", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized E-LAN service request", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpElanServiceRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/elans/{serviceUuid}/endpoint" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Add an endpoint to an E-LAN service", "description" : "Add an endpoint to an E-LAN service", "operationId" : "addElanEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The Layer 2 endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L2EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/elans/{serviceUuid}/endpoint/{endpointUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Update the endpoint of an E-LAN service", "description" : "Update the endpoint of an E-LAN service", "operationId" : "updateElanEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The Layer 2 endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L2EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch the endpoint of an E-LAN service", "description" : "Patch the endpoint of an E-LAN service", "operationId" : "patchElanEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be patched", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The Layer 2 endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L2EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/elines" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create an IP or optical E-Line service", "description" : "Create an IP or optical E-Line service", "operationId" : "createElines", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ElineRequestData»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/elines/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify an IP or optical E-Line service", "description" : "Modify an IP or optical E-Line service", "operationId" : "updateElines", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ElineRequestData»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch an IP or optical E-Line service", "description" : "Patch an IP or optical E-Line service", "operationId" : "patchElines", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ElineRequestData»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being patched", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/elines/{serviceUuid}/endpoint/{endpointUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Update the endpoint of an E-Line service", "description" : "Update the endpoint of an E-Line service", "operationId" : "updateElineEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be updated", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The Layer 2 endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L2EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch the endpoint of an E-Line service", "description" : "Patch the endpoint of an E-Line service", "operationId" : "patchElineEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be patched", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The Layer 2 endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L2EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/fix-l3-vpn-vrf-membership/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Sites within the specified L3-VPN service that are not correctly connected by VRF membership will be moved to a new service. Currently, only sites connected by Extranet route targets will be moved to a new service.", "description" : "Sites within the specified L3-VPN service that are not correctly connected by VRF membership will be moved to a new service. Currently, only sites connected by Extranet route targets will be moved to a new service.", "operationId" : "updateFixL3VpnVrfMembership", "consumes" : [ "application/json" ], "produces" : [ "*/*" ], "parameters" : [ { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the L3-VPN service that is being corrected", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/ies" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create an IP IES service", "description" : "Create an IP IES service", "operationId" : "createIes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The IES service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpIesServiceRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify an IP IES service", "description" : "Modify an IP IES service", "operationId" : "updateIes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The IES service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpIesServiceRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch an IP IES service", "description" : "Patch an IP IES service", "operationId" : "patchIes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The IES service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpIesServiceRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being patched", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}/endpoint" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Add an endpoint to a IES service", "description" : "Add an endpoint to a IES service", "operationId" : "addIesEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "l3EndpointRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«L3EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}/endpoint/{endpointUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Update the endpoint of an IES service", "description" : "Update the endpoint of an IES service", "operationId" : "updateIesEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be updated", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "l3EndpointRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«L3EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch the endpoint of an IES service", "description" : "Patch the endpoint of an IES service", "operationId" : "patchIesEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be patched", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "l3EndpointRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«L3EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}/loopback-endpoint" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Add a loop back endpoint to an IES service", "description" : "Add a loop back endpoint to an IES service", "operationId" : "addIesLoopbackEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The LoopBack endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LoopbackEndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}/loopback-endpoint/{endpointUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Update loop back endpoint of an IES service", "description" : "Update loop back endpoint of an IES service", "operationId" : "updateIesLoopbackEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The LoopBack endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LoopbackEndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch loop back endpoint of an IES service", "description" : "Patch loop back endpoint of an IES service", "operationId" : "patchIesLoopbackEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be patched", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The LoopBack endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LoopbackEndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-dci-vpns" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Support for limited Data Center use cases as VXLAN Stitched connectivity type. Unsupported Proof of Concept with MPLS End-to-End connectivity type. An L3 DCI Service is a Network Function Interconnect implementation providing Layer 3 Data Center connectivity for EVPN services in between data center and WAN entities. Integrates various use cases with the Nokia Nuage Solution, Segment Routing and VXLAN", "description" : "Support for limited Data Center use cases as VXLAN Stitched connectivity type. Unsupported Proof of Concept with MPLS End-to-End connectivity type. An L3 DCI Service is a Network Function Interconnect implementation providing Layer 3 Data Center connectivity for EVPN services in between data center and WAN entities. Integrates various use cases with the Nokia Nuage Solution, Segment Routing and VXLAN", "operationId" : "createL3DciVpns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The L3 DCI service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpL3DciServiceRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-dcis/{serviceUuid}/endpoint/{endpointUuid}" : { "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch L3 endpoint of an L3 DCI service", "description" : "Patch L3 endpoint of an L3 DCI service", "operationId" : "patchL3DciL3Endpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the L3 endpoint to be patched", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "l3EndpointRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«L3EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the L3 DCI Service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-vpn-rt-audit" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Runs an audit to find all L3-VPN services with invalid VRF membership. Currently the audit only considers L3-VPN services that contains sites connected by Extranet route targets as invalid.", "description" : "Runs an audit to find all L3-VPN services with invalid VRF membership. Currently the audit only considers L3-VPN services that contains sites connected by Extranet route targets as invalid.", "operationId" : "getL3VpnRtAudit", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«string»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-vpns" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create an L3 VPN service", "description" : "Create an L3 VPN service", "operationId" : "createL3Vpns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The L3 VPN service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpL3ServiceRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify an L3 VPN service", "description" : "Modify an L3 VPN service", "operationId" : "updateL3Vpns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The L3 VPN service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpL3ServiceRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch an L3 VPN service", "description" : "Patch an L3 VPN service", "operationId" : "patchL3Vpns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The L3 VPN service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpL3ServiceRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being patched", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}/endpoint" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Add an endpoint to an L3 VPN service", "description" : "Add an endpoint to an L3 VPN service", "operationId" : "addL3VpnEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "l3EndpointRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«L3EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Update endpoint of an L3 VPN service", "description" : "Update endpoint of an L3 VPN service", "operationId" : "updateL3VpnEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "l3EndpointRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«L3EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch endpoint of an L3 VPN service", "description" : "Patch endpoint of an L3 VPN service", "operationId" : "patchL3VpnEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be patched", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "l3EndpointRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«L3EndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}/loopback-endpoint" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Add a loop back endpoint to an L3 VPN service", "description" : "Add a loop back endpoint to an L3 VPN service", "operationId" : "addL3VpnLoopbackEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The LoopBack endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LoopbackEndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Update loop back endpoint of an L3 VPN service", "description" : "Update loop back endpoint of an L3 VPN service", "operationId" : "updateL3VpnLoopbackEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The LoopBack endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LoopbackEndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch loop back endpoint of an L3 VPN service", "description" : "Patch loop back endpoint of an L3 VPN service", "operationId" : "patchL3VpnLoopbackEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be patched", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The LoopBack endpoint definition", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LoopbackEndpointRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to which the endpoint belongs", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/lags" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create a LAG service", "description" : "Create a LAG service", "operationId" : "createLags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized LAG service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LagRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/lags/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify an LAG service", "description" : "Modify an LAG service", "operationId" : "updateLags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized LAG service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LagRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/normalized-l3-vpns" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create a normalized L3 VPN service", "description" : "Create a normalized L3 VPN service", "operationId" : "createNormalizedL3Vpns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized L3 VPN service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpL3ServiceNormalizedRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/normalized-l3-vpns/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify a normalized L3 VPN service", "description" : "Modify a normalized L3 VPN service", "operationId" : "updateNormalizedL3Vpns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized L3 VPN service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpL3ServiceNormalizedRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch a normalized L3 VPN service", "description" : "Patch a normalized L3 VPN service", "operationId" : "patchNormalizedL3Vpns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized L3 VPN service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IpL3ServiceNormalizedRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being patched", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/normalized-l3-vpns/{serviceUuid}/endpoint" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Add an endpoint to a normalized L3 VPN service", "description" : "Add an endpoint to a normalized L3 VPN service", "operationId" : "addL3VpnNormalizedEndpoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "l3EndpointNormalizedRequest", "required" : true, "schema" : { "$ref" : "#/definitions/Request«L3EndpointNormalizedRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/optical" : { "post" : { "tags" : [ "sdn-services" ], "summary" : "Create or modify an optical service", "description" : "Create or modify an optical service", "operationId" : "createOptical", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized Optical service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticsRequest»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/optical/{serviceUuid}" : { "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify an optical service", "description" : "Modify an optical service", "operationId" : "updateOptical", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized Optical service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticsRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "patch" : { "tags" : [ "sdn-services" ], "summary" : "Patch an optical service", "description" : "Patch an optical service", "operationId" : "patchOptical", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The normalized Optical service request. This object is used to create and modify service entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticsRequest»" } }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/physical-links-on-service/{serviceUuid}" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Query physical links used by service", "description" : "Query physical links used by service", "operationId" : "getPhysicalLinksOnService", "produces" : [ "*/*" ], "parameters" : [ { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of service", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«PhysicalLink»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/resource-count/{tenantUuid}/{resourceType}" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "getResourceCount", "operationId" : "getResourceCount", "produces" : [ "*/*" ], "parameters" : [ { "name" : "resourceType", "in" : "path", "description" : "The resource type to be queried", "required" : false, "type" : "string", "enum" : [ "EACCESS_SERVICE", "OCH_SERVICE", "L3VPN_SERVICE", "LAG_SERVICE", "L3VPN_ENDPOINT", "ELAN_SERVICE", "ELAN_ENDPOINT", "IES_ENDPOINT", "ELINE_SERVICE", "ELINE_ENDPOINT", "ODU_SERVICE", "IES_SERVICE", "LAG_ENDPOINT" ] }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«long»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/services/services-on-tunnel/{tunnelUuid}" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Query services using a tunnel", "description" : "Query services using a tunnel", "operationId" : "getServicesOnTunnel", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tunnelUuid", "in" : "path", "description" : "The unique identifier of tunnel to query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«BaseService»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/tenant/{uuid}" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "getTenant", "operationId" : "getTenant", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier for the tenant to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«BaseService»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/services/tunnel/{tunnelUuid}" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Find a Tunnel", "description" : "Find a Tunnel", "operationId" : "getTunnel", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tunnelUuid", "in" : "path", "description" : "The unique identifier for the query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ServiceTunnel»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-services" ], "summary" : "Modify a tunnel", "description" : "Modify a tunnel", "operationId" : "updateTunnel", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "A request object used to modify tunnel entities in the network.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ServiceTunnelRequest»" } }, { "name" : "tunnelUuid", "in" : "path", "description" : "The unique identifier of the tunnel that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/tunnels" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Query all Tunnels", "description" : "Query all Tunnels", "operationId" : "getTunnels", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«ServiceTunnel»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/tunnels-on-service/{serviceUuid}" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Query service tunnels used by service", "description" : "Query service tunnels used by service", "operationId" : "getTunnelsOnService", "produces" : [ "*/*" ], "parameters" : [ { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of service", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«ServiceTunnel»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/{serviceUuid}/endpoint/{endpointUuid}" : { "delete" : { "tags" : [ "sdn-services" ], "summary" : "Delete a service endpoint from a service", "description" : "Delete a service endpoint from a service", "operationId" : "deleteServiceEndpoint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "endpointUuid", "in" : "path", "description" : "The unique identifier of the service endpoint to be deleted", "required" : false, "type" : "string" }, { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier of the service", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/{serviceUuid}/endpoints" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Query all endpoints associated to a service object", "description" : "Query all endpoints associated to a service object", "operationId" : "getEndpoints", "produces" : [ "*/*" ], "parameters" : [ { "name" : "serviceUuid", "in" : "path", "description" : "The unique identifier for the service to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«BaseServiceEndpoint»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/services/{uuid}" : { "get" : { "tags" : [ "sdn-services" ], "summary" : "Find a service by a unique identifier", "description" : "Find a service by a unique identifier", "operationId" : "get", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier for the query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«BaseService»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-services" ], "summary" : "Delete a service", "description" : "Delete a service", "operationId" : "delete", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier of the service to be deleted", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/system/isMaster" : { "get" : { "tags" : [ "sdn-system" ], "summary" : "NSP server is master", "description" : "NSP server is master", "operationId" : "isMaster", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/system/plugin-connect/{pluginName}/{pluginVId}/{pluginKey}?pluginName=VSR_NRC" : { "put" : { "tags" : [ "sdn-system" ], "summary" : "BETA: Forces NSP Plugin to form a specific connection", "description" : "BETA: Forces NSP Plugin to form a specific connection", "operationId" : "setPluginConnect", "consumes" : [ "application/json" ], "produces" : [ "*/*" ], "parameters" : [ { "name" : "pluginKey", "in" : "path", "description" : "The key for the target plugin for example IP Address", "required" : false, "type" : "string" }, { "name" : "pluginName", "in" : "path", "description" : "The name of the plugin", "required" : false, "type" : "string", "enum" : [ "VSR_NRC" ] }, { "name" : "pluginVId", "in" : "path", "description" : "The virtual identifier for the target plugin", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«string»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/system/resync-nms" : { "get" : { "tags" : [ "sdn-system" ], "summary" : "Triggers a data synchronization with the connected NMS", "description" : "Triggers a data synchronization with the connected NMS", "operationId" : "resyncNms", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/system/resync-object/{uuid}" : { "get" : { "tags" : [ "sdn-system" ], "summary" : "Triggers a data synchronization with the connected NMS on a specific object", "description" : "Triggers a data synchronization with the connected NMS on a specific object", "operationId" : "resyncObject", "produces" : [ "*/*" ], "parameters" : [ { "name" : "uuid", "in" : "path", "description" : "The unique identifier of the object to be synchronized", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/system/state" : { "get" : { "tags" : [ "sdn-system" ], "summary" : "Retrieves the state of the system", "description" : "Retrieves the state of the system", "operationId" : "getState", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«string»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/system/version" : { "get" : { "tags" : [ "sdn-system" ], "summary" : "Retrieves the version of the system", "description" : "Retrieves the version of the system", "operationId" : "getVersion", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«string»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/cline-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all C-Line service creation templates", "description" : "Query all C-Line service creation templates", "operationId" : "getAllClineServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«ClineServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create a C-Line service creation template", "description" : "Create a C-Line service creation template", "operationId" : "createClineServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during C-Line service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ClineServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ClineServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/cline-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a C-Line service creation template by its unique identifier", "description" : "Find a C-Line service creation template by its unique identifier", "operationId" : "getClineServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ClineServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify a C-Line service creation template", "description" : "Modify a C-Line service creation template", "operationId" : "updateClineServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during C-Line service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ClineServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete a C-Line service creation template", "description" : "Delete a C-Line service creation template", "operationId" : "deleteClineServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/custom-attributes" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all Custom Attributes templates", "description" : "Query all Custom Attributes templates", "operationId" : "getAllCustomAttributes", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«CustomAttributesTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create a Custom Attributes template", "description" : "Create a Custom Attributes template", "operationId" : "createCustomAttributes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "custom attributes template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«CustomAttributesTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«CustomAttributesTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/custom-attributes/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a Custom Attributes template by its unique identifier", "description" : "Find a Custom Attributes template by its unique identifier", "operationId" : "getCustomAttributes", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«CustomAttributesTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify a Custom Attributes template", "description" : "Modify a Custom Attributes template", "operationId" : "updateCustomAttributes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "custom attributes template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«CustomAttributesTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique identifier of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete a Custom Attributes template", "description" : "Delete a Custom Attributes template", "operationId" : "deleteCustomAttributes", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/elan-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all E-LAN service creation templates", "description" : "Query all E-LAN service creation templates", "operationId" : "getAllElanServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«ElanServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an E-LAN service creation template", "description" : "Create an E-LAN service creation template", "operationId" : "createElanServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during E-LAN service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ElanServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ElanServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/elan-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an E-LAN service creation template by its unique identifier", "description" : "Find an E-LAN service creation template by its unique identifier", "operationId" : "getElanServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ElanServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an E-LAN service creation template", "description" : "Modify an E-LAN service creation template", "operationId" : "updateElanServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during E-LAN service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ElanServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an E-LAN service creation template", "description" : "Delete an E-LAN service creation template", "operationId" : "deleteElanServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/eline-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all E-Line service creation templates", "description" : "Query all E-Line service creation templates", "operationId" : "getAllElineServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«ElineServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an E-Line service creation template", "description" : "Create an E-Line service creation template", "operationId" : "createElineServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during E-Line service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ElineServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ElineServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/eline-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an E-Line service creation template by its unique identifier", "description" : "Find an E-Line service creation template by its unique identifier", "operationId" : "getElineServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«ElineServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an E-Line service creation template", "description" : "Modify an E-Line service creation template", "operationId" : "updateElineServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during E-Line service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«ElineServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an E-Line service creation template", "description" : "Delete an E-Line service creation template", "operationId" : "deleteElineServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/generic-qos" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all generic QoS profiles.", "description" : "Query all generic QoS profiles.", "operationId" : "getAllGenericQos", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«QosProfile»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create a Generic QoS Profile", "description" : "Create a Generic QoS Profile", "operationId" : "createGenericQos", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The Generic QoS Profile (GQP), which applies to L2 and L3 access interfaces.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«QosProfile»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«QosProfile»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/generic-qos-profiles/{neId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all generic QoS profiles of the provided network element", "description" : "Query all generic QoS profiles of the provided network element", "operationId" : "getGenericQosProfiles", "produces" : [ "*/*" ], "parameters" : [ { "name" : "neId", "in" : "path", "description" : "The unique identifier of the network element to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«QosProfile»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/generic-qos/{gqpId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a generic QoS profile by its unique ID", "description" : "Find a generic QoS profile by its unique ID", "operationId" : "getGenericQos", "produces" : [ "*/*" ], "parameters" : [ { "name" : "gqpId", "in" : "path", "description" : "gqpId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«QosProfile»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Update a Generic QoS Profile", "description" : "Update a Generic QoS Profile", "operationId" : "updateGenericQos", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "gqpId", "in" : "path", "description" : "The unique ID of the policy that is being modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The Generic QoS Profile (GQP), which applies to L2 and L3 access interfaces.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«QosProfile»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete a Generic QoS Profile", "description" : "Delete a Generic QoS Profile", "operationId" : "deleteGenericQos", "produces" : [ "*/*" ], "parameters" : [ { "name" : "gqpId", "in" : "path", "description" : "gqpId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/ies-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all IES service creation templates", "description" : "Query all IES service creation templates", "operationId" : "getAllIesServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«IesServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an IES service creation template", "description" : "Create an IES service creation template", "operationId" : "createIesServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during IES service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IesServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«IesServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/ies-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an IES service creation template by its unique identifier", "description" : "Find an IES service creation template by its unique identifier", "operationId" : "getIesServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«IesServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an IES service creation template", "description" : "Modify an IES service creation template", "operationId" : "updateIesServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during IES service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«IesServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an IES service creation template", "description" : "Delete an IES service creation template", "operationId" : "deleteIesServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/l2-dci-vpn-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all L2 DCI VPN service creation templates", "description" : "Query all L2 DCI VPN service creation templates", "operationId" : "getAllL2DciVpnServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«L2DciVpnServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/l2-dci-vpn-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an L2 DCI VPN service creation template by its unique identifier", "description" : "Find an L2 DCI VPN service creation template by its unique identifier", "operationId" : "getL2DciVpnServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«L2DciVpnServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an L2 DCI VPN service creation template", "description" : "Modify an L2 DCI VPN service creation template", "operationId" : "updateL2DciVpnServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during L2 DCI VPN service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L2DciVpnServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/l2backhaul-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all L2 Backhaul service creation templates", "description" : "Query all L2 Backhaul service creation templates", "operationId" : "getAllL2backhaulServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«L2backhaulServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an L2 backhaul service creation template", "description" : "Create an L2 backhaul service creation template", "operationId" : "createL2backhaulServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during L2 Backhaul service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L2backhaulServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«L2backhaulServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/l2backhaul-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an L2 Backhaul service creation template by its unique identifier", "description" : "Find an L2 Backhaul service creation template by its unique identifier", "operationId" : "getL2backhaulServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«L2backhaulServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an L2 Backhaul service creation template", "description" : "Modify an L2 Backhaul service creation template", "operationId" : "updateL2backhaulServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during L2 Backhaul service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L2backhaulServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an L2 Backhaul service creation template", "description" : "Delete an L2 Backhaul service creation template", "operationId" : "deleteL2backhaulServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/l3-dci-vpn-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all L3 DCI VPN service creation templates", "description" : "Query all L3 DCI VPN service creation templates", "operationId" : "getAllL3DciVpnServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«L3DciVpnServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an L3 DCI VPN service creation template", "description" : "Create an L3 DCI VPN service creation template", "operationId" : "createL3DciVpnServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during L3 DCI VPN service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L3DciVpnServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«L3DciVpnServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/l3-dci-vpn-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an L3 DCI VPN service creation template by its unique identifier", "description" : "Find an L3 DCI VPN service creation template by its unique identifier", "operationId" : "getL3DciVpnServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«L3DciVpnServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an L3 DCI VPN service creation template", "description" : "Modify an L3 DCI VPN service creation template", "operationId" : "updateL3DciVpnServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during L3 DCI VPN service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L3DciVpnServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an L3 DCI VPN service creation template", "description" : "Delete an L3 DCI VPN service creation template", "operationId" : "deleteL3DciVpnServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/l3-vpn-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all L3 VPN service creation templates", "description" : "Query all L3 VPN service creation templates", "operationId" : "getAllL3VpnServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«L3vpnServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an L3 VPN service creation template", "description" : "Create an L3 VPN service creation template", "operationId" : "createL3VpnServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during L3 VPN service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L3vpnServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«L3vpnServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/l3-vpn-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an L3 VPN service creation template by its unique identifier", "description" : "Find an L3 VPN service creation template by its unique identifier", "operationId" : "getL3VpnServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«L3vpnServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an L3 VPN service creation template", "description" : "Modify an L3 VPN service creation template", "operationId" : "updateL3VpnServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during L3 VPN service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«L3vpnServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an L3 VPN service creation template", "description" : "Delete an L3 VPN service creation template", "operationId" : "deleteL3VpnServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/lag-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all LAG service creation templates", "description" : "Query all LAG service creation templates", "operationId" : "getAllLagServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«LagServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create a LAG service creation template", "description" : "Create a LAG service creation template", "operationId" : "createLagServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during LAG service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LagServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«LagServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/lag-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a LAG service creation template by its unique identifier", "description" : "Find a LAG service creation template by its unique identifier", "operationId" : "getLagServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«LagServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify a LAG service creation template", "description" : "Modify a LAG service creation template", "operationId" : "updateLagServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during LAG service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«LagServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete a LAG service creation template", "description" : "Delete a LAG service creation template", "operationId" : "deleteLagServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/mediation-profile-mapping" : { "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an Mediation profile Mapping", "description" : "Create an Mediation profile Mapping", "operationId" : "createMediationProfileMapping", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Mediation profile that defines the Mediation and their template associations.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«MediationProfileTemplateMapping»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«MediationProfileTemplateMapping»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/mediation-profile-mapping/{profileId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a mediation profile mapping by its unique identifier", "description" : "Find a mediation profile mapping by its unique identifier", "operationId" : "getMediationProfileMapping", "produces" : [ "*/*" ], "parameters" : [ { "name" : "profileId", "in" : "path", "description" : "profileId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«MediationProfileTemplateMapping»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Update a mediation profile mapping", "description" : "Update a mediation profile mapping", "operationId" : "updateMediationProfileMapping", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Mediation profile that defines the Mediation and their template associations.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«MediationProfileTemplateMapping»" } }, { "name" : "profileId", "in" : "path", "description" : "Update a mediation profile mapping", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an Mediation profile mapping", "description" : "Delete an Mediation profile mapping", "operationId" : "deleteMediationProfileMapping", "produces" : [ "*/*" ], "parameters" : [ { "name" : "profileId", "in" : "path", "description" : "profileId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/mediation-profile-mappings" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all mediation profile mappings", "description" : "Query all mediation profile mappings", "operationId" : "getAllMediationProfileMappings", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«MediationProfileTemplateMapping»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/nfmp-template" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query NFM-P system scripts. Some of these scripts may be used for service creation or modification.", "description" : "Query NFM-P system scripts. Some of these scripts may be used for service creation or modification.", "operationId" : "getNfmpTemplate", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«string»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/och-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all OCH service creation templates", "description" : "Query all OCH service creation templates", "operationId" : "getAllOchServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OchServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an OCH service creation template", "description" : "Create an OCH service creation template", "operationId" : "createOchServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during OCH service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OchServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OchServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/och-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an OCH service creation template by its unique identifier", "description" : "Find an OCH service creation template by its unique identifier", "operationId" : "getOchServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OchServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an OCH service creation template", "description" : "Modify an OCH service creation template", "operationId" : "updateOchServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during OCH service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OchServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique identifier of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an OCH service creation template", "description" : "Delete an OCH service creation template", "operationId" : "deleteOchServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/odu-services" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all ODU service creation templates", "description" : "Query all ODU service creation templates", "operationId" : "getAllOduServices", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OduServiceCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an ODU service creation template", "description" : "Create an ODU service creation template", "operationId" : "createOduServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during ODU service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OduServiceCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OduServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/odu-services/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an ODU service creation template by its unique identifier", "description" : "Find an ODU service creation template by its unique identifier", "operationId" : "getOduServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OduServiceCreationTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an ODU service creation template", "description" : "Modify an ODU service creation template", "operationId" : "updateOduServices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "This template is used during ODU service creation", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OduServiceCreationTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an ODU service creation template", "description" : "Delete an ODU service creation template", "operationId" : "deleteOduServices", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/optical-connectivity-constraint" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all optical connectivity constraint templates", "description" : "Query all optical connectivity constraint templates", "operationId" : "getAllOpticalConnectivityConstraint", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpticalConnectivityConstraintTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an optical connectivity constraint creation template", "description" : "Create an optical connectivity constraint creation template", "operationId" : "createOpticalConnectivityConstraint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Optical connectivity constraint template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticalConnectivityConstraintTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OpticalConnectivityConstraintTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/optical-connectivity-constraint/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an optical connectivity constraint creation template by its unique identifier", "description" : "Find an optical connectivity constraint creation template by its unique identifier", "operationId" : "getOpticalConnectivityConstraint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OpticalConnectivityConstraintTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an optical connectivity constraint creation template", "description" : "Modify an optical connectivity constraint creation template", "operationId" : "updateOpticalConnectivityConstraint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Optical connectivity constraint template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticalConnectivityConstraintTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an optical connectivity constraint creation template", "description" : "Delete an optical connectivity constraint creation template", "operationId" : "deleteOpticalConnectivityConstraint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/optical-connectivity-service" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all optical connectivity service templates", "description" : "Query all optical connectivity service templates", "operationId" : "getAllOpticalConnectivityService", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpticalConnectivityServiceTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an optical connectivity service creation template", "description" : "Create an optical connectivity service creation template", "operationId" : "createOpticalConnectivityService", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Optical connectivity service template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticalConnectivityServiceTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OpticalConnectivityServiceTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/optical-connectivity-service/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an optical connectivity service creation template by its unique identifier", "description" : "Find an optical connectivity service creation template by its unique identifier", "operationId" : "getOpticalConnectivityService", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OpticalConnectivityServiceTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an optical connectivity service creation template", "description" : "Modify an optical connectivity service creation template", "operationId" : "updateOpticalConnectivityService", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Optical connectivity service template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticalConnectivityServiceTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an optical connectivity service creation template", "description" : "Delete an optical connectivity service creation template", "operationId" : "deleteOpticalConnectivityService", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/optical-resilience-constraint" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all optical resilience constraint templates", "description" : "Query all optical resilience constraint templates", "operationId" : "getAllOpticalResilienceConstraint", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpticalResilienceConstraintTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an optical resilience constraint creation template", "description" : "Create an optical resilience constraint creation template", "operationId" : "createOpticalResilienceConstraint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Optical resilience constraint template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticalResilienceConstraintTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OpticalResilienceConstraintTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/optical-resilience-constraint/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an optical resilience constraint creation template by its unique identifier", "description" : "Find an optical resilience constraint creation template by its unique identifier", "operationId" : "getOpticalResilienceConstraint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OpticalResilienceConstraintTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an optical resilience constraint creation template", "description" : "Modify an optical resilience constraint creation template", "operationId" : "updateOpticalResilienceConstraint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Optical resilience constraint template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticalResilienceConstraintTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an optical resilience constraint creation template", "description" : "Delete an optical resilience constraint creation template", "operationId" : "deleteOpticalResilienceConstraint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/optical-routing-constraint" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all optical routing constraint templates", "description" : "Query all optical routing constraint templates", "operationId" : "getAllOpticalRoutingConstraint", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«OpticalRoutingConstraintTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create an optical routing constraint creation template", "description" : "Create an optical routing constraint creation template", "operationId" : "createOpticalRoutingConstraint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Optical routing constraint template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticalRoutingConstraintTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OpticalRoutingConstraintTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/optical-routing-constraint/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find an optical routing constraint creation template by its unique identifier", "description" : "Find an optical routing constraint creation template by its unique identifier", "operationId" : "getOpticalRoutingConstraint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«OpticalRoutingConstraintTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify an optical routing constraint creation template", "description" : "Modify an optical routing constraint creation template", "operationId" : "updateOpticalRoutingConstraint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Optical routing constraint template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«OpticalRoutingConstraintTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an optical routing constraint creation template", "description" : "Delete an optical routing constraint creation template", "operationId" : "deleteOpticalRoutingConstraint", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/path-profiles" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all path profile templates", "description" : "Query all path profile templates", "operationId" : "getAllPathProfiles", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«PathProfileTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create a path profile template", "description" : "Create a path profile template", "operationId" : "createPathProfiles", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The path profile template controls computation parameters for creating paths in the network", "required" : false, "schema" : { "$ref" : "#/definitions/Request«PathProfileTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«PathProfileTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/path-profiles/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a path profile template by its unique identifier", "description" : "Find a path profile template by its unique identifier", "operationId" : "getPathProfiles", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«PathProfileTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Update a path profile template", "description" : "Update a path profile template", "operationId" : "updatePathProfiles", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The path profile template controls computation parameters for creating paths in the network", "required" : false, "schema" : { "$ref" : "#/definitions/Request«PathProfileTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete an existing path profile template", "description" : "Delete an existing path profile template", "operationId" : "deletePathProfiles", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/qos" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all QoS templates", "description" : "Query all QoS templates", "operationId" : "getAllQos", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«QosTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create a QoS template", "description" : "Create a QoS template", "operationId" : "createQos", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Qos template that defines cir & pir. Also used to template certain endpoint values", "required" : false, "schema" : { "$ref" : "#/definitions/Request«QosTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«QosTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/qos-policies" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all QoS policies", "description" : "Query all QoS policies", "operationId" : "getAllQosPolicies", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«NePolicyIdentifier»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/qos-policies/{neId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all QoS policies of the provided network element", "description" : "Query all QoS policies of the provided network element", "operationId" : "getQosPolicies", "produces" : [ "*/*" ], "parameters" : [ { "name" : "neId", "in" : "path", "description" : "The unique identifier of the network element to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«PolicyIdentifier»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/qos/{templateId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a QoS template by its unique identifier", "description" : "Find a QoS template by its unique identifier", "operationId" : "getQos", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«QosTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify a QoS template", "description" : "Modify a QoS template", "operationId" : "updateQos", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Qos template that defines cir & pir. Also used to template certain endpoint values", "required" : false, "schema" : { "$ref" : "#/definitions/Request«QosTemplate»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique identifier of the template that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete a QoS template", "description" : "Delete a QoS template", "operationId" : "deleteQos", "produces" : [ "*/*" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "templateId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/router-id-system-id-mapping" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all router ID system ID mapping policy", "description" : "Query all router ID system ID mapping policy", "operationId" : "getAllRouterIdSystemIdMappings", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«RouterIdSystemIdMapping»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create a router ID system ID mapping policy", "description" : "Create a router ID system ID mapping policy", "operationId" : "createRouterIdSystemIdMapping", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Policy template that defines system ID and router ID mapping.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«RouterIdSystemIdMapping»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«RouterIdSystemIdMapping»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/router-id-system-id-mapping/{policyId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a router-id-system-id-mapping by its unique identifier", "description" : "Find a router-id-system-id-mapping by its unique identifier", "operationId" : "getRouterIdSystemIdMapping", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "policyId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«RouterIdSystemIdMapping»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify a router-id-system-id-mapping policy", "description" : "Modify a router-id-system-id-mapping policy", "operationId" : "updateRouterIdSystemIdMapping", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "The unique ID of the policy that is being modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Policy template that defines system ID and router ID mapping.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«RouterIdSystemIdMapping»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete a router-id-mapping policy", "description" : "Delete a router-id-mapping policy", "operationId" : "deleteRouterIdSystemIdMapping", "produces" : [ "*/*" ], "parameters" : [ { "name" : "policyId", "in" : "path", "description" : "policyId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/system-ip-mpls-config" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all system IP MPLS Configuration", "description" : "Query all system IP MPLS Configuration", "operationId" : "getAllSystemIpMplsConfig", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«SystemIpMplsConfig»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/system-ip-mpls-config/{templateId}" : { "put" : { "tags" : [ "sdn-template" ], "summary" : "Update a system ip mpls configuration", "description" : "Update a system ip mpls configuration", "operationId" : "updateSystemIpMplsConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "systemIpMplsConfig", "required" : true, "schema" : { "$ref" : "#/definitions/Request«SystemIpMplsConfig»" } }, { "name" : "templateId", "in" : "path", "description" : "The unique ID of the configuration that is being modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/tunnel-creations" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all tunnel creation templates. Deprecated: Use get-all-tunnel-selections instead.", "description" : "Query all tunnel creation templates. Deprecated: Use get-all-tunnel-selections instead.", "operationId" : "getAllTunnelCreations", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«TunnelCreationTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/tunnel-creations/{templateId}" : { "put" : { "tags" : [ "sdn-template" ], "summary" : "Modify a tunnel creation template. Deprecated: update-tunnel-selections instead.", "description" : "Modify a tunnel creation template. Deprecated: update-tunnel-selections instead.", "operationId" : "updateTunnelCreations", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "templateId", "in" : "path", "description" : "The unique ID of the template that is being modified", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "The tunnel creation template controls system behaviour when automatically creating tunnels in the network. Deprecated: Please use tunnel-creation-template instead.", "required" : false, "schema" : { "$ref" : "#/definitions/Request«TunnelCreationTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/workflow-profile" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Query all workflow profiles", "description" : "Query all workflow profiles", "operationId" : "getAllWorkflowProfileMappings", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«WorkflowProfileTemplate»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "post" : { "tags" : [ "sdn-template" ], "summary" : "Create a workflow profile mapping", "description" : "Create a workflow profile mapping", "operationId" : "createWorkflowProfile", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "workflow profile template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«WorkflowProfileTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«WorkflowProfileTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/template/workflow-profile/{profileId}" : { "get" : { "tags" : [ "sdn-template" ], "summary" : "Find a workflow profile mapping by its unique identifier", "description" : "Find a workflow profile mapping by its unique identifier", "operationId" : "getWorkflowProfile", "produces" : [ "*/*" ], "parameters" : [ { "name" : "profileId", "in" : "path", "description" : "profileId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«WorkflowProfileTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "put" : { "tags" : [ "sdn-template" ], "summary" : "Update a workflow profile mapping", "description" : "Update a workflow profile mapping", "operationId" : "updateWorkflowProfile", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "profileId", "in" : "path", "description" : "Update a workflow profile", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "workflow profile template", "required" : false, "schema" : { "$ref" : "#/definitions/Request«WorkflowProfileTemplate»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«WorkflowProfileTemplate»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] }, "delete" : { "tags" : [ "sdn-template" ], "summary" : "Delete a workflow profile", "description" : "Delete a workflow profile", "operationId" : "deleteWorkflowProfile", "produces" : [ "*/*" ], "parameters" : [ { "name" : "profileId", "in" : "path", "description" : "profileId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/tenants" : { "get" : { "tags" : [ "sdn-tenants" ], "summary" : "gets", "operationId" : "gets", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Tenant»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true }, "post" : { "tags" : [ "sdn-tenants" ], "summary" : "create", "operationId" : "create", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "A tenant is a logical group that allows the assigning of network resources", "required" : false, "schema" : { "$ref" : "#/definitions/Request«Tenant»" } } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Tenant»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/tenants/customer-all" : { "get" : { "tags" : [ "sdn-tenants" ], "summary" : "Query all Customers", "description" : "Query all Customers", "operationId" : "getCustomerAll", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Customer»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/tenants/customer/{customerId}" : { "get" : { "tags" : [ "sdn-tenants" ], "summary" : "Find a customer by customer-Id", "description" : "Find a customer by customer-Id", "operationId" : "getCustomer", "produces" : [ "*/*" ], "parameters" : [ { "name" : "customerId", "in" : "path", "description" : "The Customer-Id of the Customer", "required" : false, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Customer»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/tenants/resync/{provider}" : { "get" : { "tags" : [ "sdn-tenants" ], "summary" : "resync", "operationId" : "resync", "produces" : [ "*/*" ], "parameters" : [ { "name" : "provider", "in" : "path", "description" : "The Identity Provider in which to resynchronize data", "required" : false, "type" : "string", "enum" : [ "KEYSTONE", "SSO" ] } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/tenants/{tenantUuid}" : { "get" : { "tags" : [ "sdn-tenants" ], "summary" : "get", "operationId" : "get", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier for the query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Tenant»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true }, "put" : { "tags" : [ "sdn-tenants" ], "summary" : "update", "operationId" : "update", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "A request object used to modify Tenant", "required" : false, "schema" : { "$ref" : "#/definitions/Request«TenantRequest»" } }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true }, "delete" : { "tags" : [ "sdn-tenants" ], "summary" : "delete", "operationId" : "delete", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the Tenant to be deleted", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/tenants/{tenantUuid}/resources" : { "get" : { "tags" : [ "sdn-tenants" ], "summary" : "getResources", "operationId" : "getResources", "produces" : [ "*/*" ], "parameters" : [ { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier for the tenant", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«BaseEntity»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true }, "post" : { "tags" : [ "sdn-tenants" ], "summary" : "addResources", "operationId" : "addResources", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The resource unique identifier(s) to be assigned to the tenant", "required" : false, "schema" : { "$ref" : "#/definitions/Request«List«string»»" } }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true }, "delete" : { "tags" : [ "sdn-tenants" ], "summary" : "deleteResources", "operationId" : "deleteResources", "produces" : [ "*/*" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The resource unique identifier(s) to be removed from the tenant", "required" : false, "schema" : { "$ref" : "#/definitions/Request«List«string»»" } }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/tenants/{tenantUuid}/usergroup/{groupName}" : { "get" : { "tags" : [ "sdn-tenants" ], "summary" : "getUsergroup", "operationId" : "getUsergroup", "produces" : [ "*/*" ], "parameters" : [ { "name" : "groupName", "in" : "path", "description" : "The unique name of the Usergroup to be found", "required" : false, "type" : "string" }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to which the user is assigned", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«string»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true }, "delete" : { "tags" : [ "sdn-tenants" ], "summary" : "deleteUsergroup", "operationId" : "deleteUsergroup", "produces" : [ "*/*" ], "parameters" : [ { "name" : "groupName", "in" : "path", "description" : "The unique name of the Usergroup to be removed", "required" : false, "type" : "string" }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to which the user is assigned", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/tenants/{tenantUuid}/usergroup/{groupName}/role/{roleType}" : { "post" : { "tags" : [ "sdn-tenants" ], "summary" : "createUsergroup", "operationId" : "createUsergroup", "consumes" : [ "application/json" ], "produces" : [ "*/*" ], "parameters" : [ { "name" : "groupName", "in" : "path", "description" : "The unique name of the Usergroup to be assigned", "required" : false, "type" : "string" }, { "name" : "roleType", "in" : "path", "description" : "The role that the Usergroup will be assigned on the tenant. 'Operator' role can read/write on in its assigned tenant. 'User' role is read-only for its tenant. 'Admin' role is read/write across all tenants.", "required" : false, "type" : "string", "enum" : [ "OPERATOR", "ADMIN", "USER" ] }, { "name" : "tenantUuid", "in" : "path", "description" : "The unique identifier of the tenant to be modified", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«boolean»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } }, "/v4/usergroups" : { "get" : { "tags" : [ "sdn-usergroups" ], "summary" : "Query all Usergroups", "description" : "Query all Usergroups", "operationId" : "gets", "produces" : [ "*/*" ], "parameters" : [ ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Usergroup»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/usergroups/{groupName}" : { "get" : { "tags" : [ "sdn-usergroups" ], "summary" : "Find a Usergroup by a group name", "description" : "Find a Usergroup by a group name", "operationId" : "get", "produces" : [ "*/*" ], "parameters" : [ { "name" : "groupName", "in" : "path", "description" : "The unique name of the Userroup to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«Usergroup»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ] } }, "/v4/usergroups/{groupName}/tenants" : { "get" : { "tags" : [ "sdn-usergroups" ], "summary" : "getTenants", "operationId" : "getTenants", "produces" : [ "*/*" ], "parameters" : [ { "name" : "groupName", "in" : "path", "description" : "The unique name of the Usergroup to be queried", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK - Request executed successfully", "schema" : { "$ref" : "#/definitions/ResponseData«List«Tenant»»" } }, "400" : { "description" : "Bad Request - Malformed content or invalid data provided", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "401" : { "description" : "Unauthorized - Authentication rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "403" : { "description" : "Forbidden - Authorization rejected", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "404" : { "description" : "Not Found - Resource does not exist", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "409" : { "description" : "Conflict - System not ready", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } }, "500" : { "description" : "Internal Server Error - Unrecognized system error", "schema" : { "$ref" : "#/definitions/ErrorResponseData" } } }, "security" : [ { "REST Token" : [ "global" ] } ], "deprecated" : true } } }, "securityDefinitions" : { "REST Token" : { "type" : "apiKey", "name" : "Authorization", "in" : "header" } }, "definitions" : { "Adjacency" : { "type" : "object", "properties" : { "farEndIpAddress" : { "description" : "The external IP address of a service endpoint", "$ref" : "#/definitions/IpAddress" }, "vcId" : { "type" : "integer", "format" : "int64", "description" : "The pseudowire identifier that must match what is configured on the far-end." } }, "title" : "Adjacency", "description" : "Adjacency" }, "AdjacencySegmentId" : { "type" : "object", "properties" : { "adjacencySegmentIdsInfo" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/AdjacencySegmentIdsInfo" } } }, "title" : "AdjacencySegmentId", "description" : "Deprecated. Use AdjacencySegmentIdData as this only returns one entry. A list of segment ids and its destination router, flags and weight" }, "AdjacencySegmentIdData" : { "type" : "object", "properties" : { "adjacencySegmentIdsData" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/AdjacencySegmentIdsData" } } }, "title" : "AdjacencySegmentIdData", "description" : "A list of segment ids and its neighbor router, flags and weight" }, "AdjacencySegmentIdsData" : { "type" : "object", "properties" : { "flags" : { "description" : "Adjacency segment identifier flags", "$ref" : "#/definitions/AdjacencySidFlags" }, "neighbor" : { "type" : "string", "description" : "The IP address of the neighbor" }, "neighborId" : { "type" : "string", "description" : "An identifier to uniquely identify the neighbor router" }, "segmentId" : { "type" : "integer", "format" : "int64", "description" : "Segment identifier" }, "weight" : { "type" : "integer", "format" : "int32", "description" : "Adjacency segment identifier weight" } }, "title" : "AdjacencySegmentIdsData" }, "AdjacencySegmentIdsInfo" : { "type" : "object", "properties" : { "destRouter" : { "type" : "string", "description" : "Deprecated. Use AdjacencySegmentIdData as this only returns one entry. An identifier to uniquely identify the destination router" }, "flags" : { "description" : "Deprecated. Use AdjacencySegmentIdData as this only returns one entry. Adjacency segment identifier flags", "$ref" : "#/definitions/AdjacencySidFlags" }, "segmentId" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "weight" : { "type" : "integer", "format" : "int32", "description" : "Deprecated. Use AdjacencySegmentIdData as this only returns one entry. Adjacency segment identifier weight" } }, "title" : "AdjacencySegmentIdsInfo" }, "AdjacencySidFlags" : { "type" : "object", "properties" : { "addressFamilyFlag" : { "type" : "boolean" }, "backupFlag" : { "type" : "boolean" }, "localFlag" : { "type" : "boolean" }, "persistentFlag" : { "type" : "boolean" }, "setFlag" : { "type" : "boolean" }, "valueFlag" : { "type" : "boolean" } }, "title" : "AdjacencySidFlags" }, "AdminGroup" : { "type" : "object", "properties" : { "binary" : { "type" : "string", "format" : "byte" } }, "title" : "AdminGroup", "description" : "Administrative group/Resource class/Color." }, "AdminGroups" : { "type" : "object", "properties" : { "adminGroup" : { "$ref" : "#/definitions/AdminGroup" }, "extendedAdminGroup" : { "$ref" : "#/definitions/ExtendedAdminGroup" } }, "title" : "AdminGroups", "description" : "TE administrative group derived type" }, "AmiNameVersionTemplates" : { "type" : "object", "properties" : { "amiName" : { "type" : "string", "description" : "AMI name" }, "amiVersion" : { "type" : "string", "description" : "This is expressed as a semantic version number of the form: x.y.z where: * x corresponds to the major version, * y corresponds to a minor version, * z corresponds to a patch version. AMI version in the format x.y.z where This version corresponds to the model file within which it is defined, and does not cover the whole set of OpenConfig models. Where several modules are used to build up a single block of functionality, the same module version is specified across each file that makes up the module. A major version number of 0 indicates that this model is still in development (whether within OpenConfig or with industry partners), and is potentially subject to change. Following a release of major version 1, all modules will increment major revision number where backwards incompatible changes to the model are made. The minor version is changed when features are added to the model that do not impact current clients use of the model. The patch-level version is incremented when non-feature changes (such as bugfixes or clarifications to human-readable descriptions that do not impact model functionality) are made that maintain backwards compatibility." }, "globalTemplateNames" : { "type" : "array", "description" : "List of global template names", "items" : { "type" : "string" } } }, "title" : "AmiNameVersionTemplates", "description" : "Grouping for each AMI with available global templates" }, "AmiNameVersions" : { "type" : "object", "properties" : { "amiName" : { "type" : "string", "description" : "AMI name" }, "amiVersions" : { "type" : "array", "description" : "AMI versions", "items" : { "type" : "string" } } }, "title" : "AmiNameVersions", "description" : "AMI Name Versions" }, "Area" : { "type" : "object", "properties" : { "area" : { "type" : "string", "description" : "The area interpretation depends on the protocol. ie. area for ospf would be 0.0.0.1 and for isis would be 02 or 10.10.10.10 etc" }, "areaId" : { "type" : "string", "description" : "Unique identifier of the area" }, "displayName" : { "type" : "string", "description" : "The displayed name of the area" }, "isisLevel" : { "type" : "integer", "format" : "int32", "description" : "The level attribute for ISIS" }, "protocol" : { "type" : "string", "description" : "The protocol that this area was defined in", "enum" : [ "OSPFv2", "ISIS", "BGP", "ANY", "STATIC" ] } }, "title" : "Area" }, "AsNumber" : { "type" : "object", "properties" : { "uint32" : { "type" : "integer", "format" : "int64" } }, "title" : "AsNumber", "description" : "The as-number type represents autonomous system numbers which identify an Autonomous System (AS). An AS is a set of routers under a single technical administration, using an interior gateway protocol and common metrics to route packets within the AS, and using an exterior gateway protocol to route packets to other ASes. IANA maintains the AS number space and has delegated large parts to the regional registries. Autonomous system numbers were originally limited to 16 bits. BGP extensions have enlarged the autonomous system number space to 32 bits. This type therefore uses an uint32 base type without a range restriction in order to support a larger autonomous system number space. In the value set and its semantics, this type is equivalent to the InetAutonomousSystemNumber textual convention of the SMIv2." }, "AsymmetricalOperation" : { "type" : "object", "properties" : { "egress" : { "description" : "Egress operations", "$ref" : "#/definitions/Egress" }, "ingress" : { "description" : "Ingress operations", "$ref" : "#/definitions/Ingress" } }, "title" : "AsymmetricalOperation", "description" : "Asymmetrical operations" }, "AugmentationMeta" : { "type" : "object", "properties" : { "augmentationMetaInput" : { "description" : "Augmentation meta input parameters for given hierarchy and template", "$ref" : "#/definitions/AugmentationMetaInput" }, "augmentationMetaJsonFileName" : { "description" : "Json file name to read the json from the file for Augmentation Meta.", "$ref" : "#/definitions/AugmentationMetaJsonFileName" } }, "title" : "AugmentationMeta", "description" : "Request to update the JSON augmentation meta information for a given hierarchy and template." }, "AugmentationMetaInput" : { "type" : "object", "required" : [ "pathName", "templateName" ], "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the Augmentation Meta" }, "pathName" : { "type" : "string", "description" : "The hierarchy for a given yang entity in the following format : eg., nsd-service:/services/elan-sites/site/config This information is used to find the appropriate JSON which corresponds to the given ne-id, ami-name, ami-version, template-name. This field has to be encoded to handle the special characters." }, "templateName" : { "type" : "string", "description" : "The global name of the template" } }, "title" : "AugmentationMetaInput", "description" : "Augmentation meta input parameters for given hierarchy and template" }, "AugmentationMetaJsonFileName" : { "type" : "object", "properties" : { "jsonFileName" : { "type" : "string", "description" : "The json file name" } }, "title" : "AugmentationMetaJsonFileName", "description" : "Json file name to read the json from the file for Augmentation Meta." }, "Authentication" : { "type" : "object", "properties" : { "expires" : { "type" : "integer", "format" : "int64", "description" : "Specifies the expiry date of the token in milliseconds since January 1, 1970, 00:00:00 GMT" }, "roles" : { "type" : "array", "description" : "The role(s) this User has relative to their Tenant", "items" : { "type" : "string", "enum" : [ "OPERATOR", "ADMIN", "USER" ] } }, "tenant" : { "description" : "The Tenant in which the current user is currently authenticated against", "$ref" : "#/definitions/Tenant" }, "user" : { "description" : "The User currently authenticated", "$ref" : "#/definitions/User" } }, "title" : "Authentication", "description" : "Information regarding the current authentication status of the user" }, "BackhaulL2RequestData" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspEthtSvcAccessParameters" } }, "ethtSvcDescr" : { "type" : "string", "description" : "Description of the ETH transport service." }, "ethtSvcName" : { "type" : "string", "description" : "Name of the p2p ETH transport service." }, "ethtSvcType" : { "description" : "Type of Ethernet service (p2p, mp2mp or rmp).", "$ref" : "#/definitions/Servicetype" }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "BackhaulL2RequestData", "description" : "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network." }, "BackhaulPath" : { "type" : "object", "properties" : { "isHetrogenous" : { "type" : "boolean", "description" : "True if the path is hetrogenous " }, "methodType" : { "type" : "string", "description" : "Type of Path Search", "enum" : [ "PATH_SEARCH", "RING_COMPLETION" ] }, "pathNumber" : { "type" : "integer", "format" : "int64", "description" : "The Index of the Path" }, "routeList" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspEthtSvcAccessParameters" } }, "sourceService" : { "type" : "string", "description" : "The UUID of the service " }, "uuid" : { "type" : "string", "description" : "The UUID of the service " } }, "title" : "BackhaulPath" }, "BandwidthProfiles" : { "type" : "object", "properties" : { "egressBandwidthProfileName" : { "type" : "string", "description" : "Name of the bandwidth profile used in the egress direction." }, "ingressBandwidthProfileName" : { "type" : "string", "description" : "Name of the bandwidth profile used in the ingress direction." }, "ingressEgressBandwidthProfileName" : { "type" : "string", "description" : "Name of the bandwidth profile." } }, "title" : "BandwidthProfiles", "description" : "A grouping which represent bandwidth profile configuration." }, "BaseEndpointRequest" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" } }, "title" : "BaseEndpointRequest", "description" : "All endpoints type definition" }, "BaseEntity" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] } }, "title" : "BaseEntity" }, "BaseService" : { "type" : "object", "required" : [ "bidirectional", "objective" ], "properties" : { "actualEndState" : { "type" : "string", "description" : "Reflects the actual end state for this object, generally Saved, Deployed, etc. This is a read-only attribute.", "enum" : [ "Saved", "Deployed" ] }, "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so, what type of return path will be used. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4) and 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062600 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "endpointExtensions" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2EndPointExtension" } }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/BaseServiceEndpoint" } }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "lifeCycle" : { "description" : "The Life Cycle details for a given object.", "$ref" : "#/definitions/LifeCycle" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "name" : { "type" : "string", "description" : "The name of the service" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service. Populated only when same node service identifier is used across all sites. " }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "serviceType" : { "type" : "string", "description" : "The type of the service", "enum" : [ "ODU", "TUNNEL", "EACCESS", "L2_EXTENSION_UNI", "CLINE", "L2_EXTENSION_NNI", "L2_BACKHAUL", "L2_DCI", "PHYSICAL_LINK", "LAG", "ELAN", "OCH", "ELINE", "IES", "L3_VPN", "L3_DCI" ] }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service." }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." } }, "title" : "BaseService", "description" : "This object is a read only representation of a service" }, "BaseServiceEndpoint" : { "type" : "object", "properties" : { "actualEndState" : { "type" : "string", "description" : "The current end state of this endpoint (whether it is Saved, Deployed, etc)", "enum" : [ "Saved", "Deployed" ] }, "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "name" : { "type" : "string", "description" : "The name of the service endpoint" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "neId" : { "type" : "string", "description" : "The identifier of the network element where the service endpoint resides" }, "neName" : { "type" : "string", "description" : "The name of the network element to which this endpoint belongs" }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "portAdminState" : { "type" : "string", "description" : "The administrative state of port used by endpoint", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "portId" : { "type" : "string", "description" : "The identifier of the port upon which the service endpoint resides" }, "portName" : { "type" : "string", "description" : "The name of the port upon which the service endpoint resides" }, "portOperationalState" : { "type" : "string", "description" : "The operational state of port used by endpoint", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "portSpeed" : { "type" : "integer", "format" : "int64", "description" : "The bandwidth of port used by endpoint" }, "serviceId" : { "type" : "string", "description" : "The identifier of the service that uses this endpoint" } }, "title" : "BaseServiceEndpoint", "description" : "The service endpoint definition. The service endpoint is a port which is terminated against a service." }, "BaseServiceHierarchy" : { "type" : "object", "properties" : { "baseService" : { "description" : "This object is a read only representation of a service", "$ref" : "#/definitions/BaseService" }, "serviceTunnels" : { "type" : "array", "items" : { "$ref" : "#/definitions/ServiceTunnel" } } }, "title" : "BaseServiceHierarchy", "description" : "This object is a read only representation of a service" }, "BundledLink" : { "type" : "object", "properties" : { "desTpRef" : { "type" : "string", "description" : "Reference to another TE termination point on the same destination node." }, "sequence" : { "type" : "integer", "format" : "int64", "description" : "Identify the sequence in the bundle." }, "srcTpRef" : { "type" : "string", "description" : "Reference to another TE termination point on the same souruce node." } }, "title" : "BundledLink" }, "BundledLinks" : { "type" : "object", "properties" : { "bundledLink" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/BundledLink" } } }, "title" : "BundledLinks", "description" : "A set of bundled links." }, "Capacity" : { "type" : "object", "properties" : { "capacityValue" : { "description" : "The Capacity (Bandwidth) values that are applicable for digital layers.", "$ref" : "#/definitions/CapacityValue" } }, "title" : "Capacity", "description" : "Capacity of service requested" }, "CapacityValue" : { "type" : "object", "properties" : { "unit" : { "type" : "string", "description" : "none", "enum" : [ "MB", "TBPS", "KB", "GHz", "KBPS", "GB", "MBPS", "TB", "MHz", "GBPS" ] }, "value" : { "type" : "integer", "description" : "none" } }, "title" : "CapacityValue", "description" : "The Capacity (Bandwidth) values that are applicable for digital layers." }, "ClineServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "adminState" : { "type" : "string", "description" : "The administrative state required for the service.", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "cemUseRtpHeader" : { "type" : "boolean", "description" : "Enable the inclusion of RTP header. It is disabled by default." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "mediationProfileId" : { "type" : "string", "description" : "The ID of the Mediation Profile associated with the service" }, "meta" : { "type" : "array", "description" : "Meta data associated with template", "items" : { "type" : "string" } }, "monitorBandwidth" : { "type" : "boolean", "description" : "Specifies whether or not the service bandwidth should be monitored" }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. The valid values are between 0 and 9194." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "portFilter" : { "type" : "array", "items" : { "$ref" : "#/definitions/PortFilter" } }, "qosId" : { "type" : "string", "description" : "The ID of the default QoS template associated with the service. Not Supported on C-Line templates" }, "qosName" : { "type" : "string", "description" : "The name of the default QoS template associated with the service. Not Supported on C-Line templates" }, "tunnelSelectionId" : { "type" : "string", "description" : "The ID of the Tunnel Selection template associated with the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "The ID of the Workflow Profile associated with the service" }, "workflowValidate" : { "type" : "string", "description" : "Workflow to run for service validation" } }, "title" : "ClineServiceCreationTemplate", "description" : "This template is used during C-Line service creation" }, "ClineServiceRequest" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "cemUseRtpHeader" : { "type" : "boolean", "description" : "Enable the inclusion of RTP header. It is disabled by default." }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/TdmEndpointRequest" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values." }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "ClineServiceRequest", "description" : "The normalized IP C-Line service request. This object is used to create and modify service entities in the network." }, "ComponentLink" : { "type" : "object", "properties" : { "desInterfaceRef" : { "type" : "string", "description" : "Reference to component link interface on the destinatioin node." }, "sequence" : { "type" : "integer", "format" : "int64", "description" : "Identify the sequence in the bundle." }, "srcInterfaceRef" : { "type" : "string", "description" : "Reference to component link interface on the source node." } }, "title" : "ComponentLink" }, "ComponentLinks" : { "type" : "object", "properties" : { "componentLink" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/ComponentLink" } } }, "title" : "ComponentLinks", "description" : "A set of component links" }, "ComputedHops" : { "type" : "object", "properties" : { "pathHops" : { "description" : "LSP path hops", "$ref" : "#/definitions/PathHops" } }, "title" : "ComputedHops", "description" : "Path computed hops. Explicit Route Objects (ERO)" }, "Condition1" : { "type" : "object", "properties" : { "operator" : { "type" : "string", "description" : "Specifies the operator to tell how to filter for value" }, "value" : { "type" : "string", "description" : "Specifies the value to filter on" } }, "title" : "Condition1" }, "Condition2" : { "type" : "object", "properties" : { "operator" : { "type" : "string", "description" : "Specifies the operator to tell how to filter for value" }, "value" : { "type" : "string", "description" : "Specifies the value to filter on" } }, "title" : "Condition2" }, "Config" : { "type" : "object", "properties" : { "teLinkConfig" : { "description" : "TE link configuration grouping.", "$ref" : "#/definitions/TeLinkConfig" } }, "title" : "Config", "description" : "Configuration data." }, "ConnectivityConstraint" : { "type" : "object", "properties" : { "capacity" : { "description" : "Capacity of service requested", "$ref" : "#/definitions/Capacity" }, "connectivityDirection" : { "type" : "string", "description" : "Direction", "enum" : [ "UNDEFINED_OR_UNKNOWN", "BIDIRECTIONAL", "UNIDIRECTIONAL" ] }, "schedule" : { "description" : "Schedule", "$ref" : "#/definitions/Schedule" }, "serviceLevel" : { "type" : "string", "description" : "An abstract value the meaning of which is mutually agreed - typically represents metrics as - Class of service, priority, resiliency, availability" }, "serviceType" : { "type" : "string", "description" : "Type of service", "enum" : [ "ROOTED_MULTIPOINT_CONNECTIVITY", "POINT_TO_MULTIPOINT_CONNECTIVITY", "MULTIPOINT_CONNECTIVITY", "POINT_TO_POINT_CONNECTIVITY" ] } }, "title" : "ConnectivityConstraint", "description" : "Connectivity Service generic parameters" }, "ConnectivityLabelRestrictionList" : { "type" : "object", "properties" : { "labelRestriction" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/LabelRestriction" } } }, "title" : "ConnectivityLabelRestrictionList", "description" : "List of abel restrictions specifying what labels may or may not be used on a link connectivity." }, "ConnectivityMatrix" : { "type" : "object", "properties" : { "connectivityLabelRestrictionList" : { "$ref" : "#/definitions/ConnectivityLabelRestrictionList" }, "from" : { "description" : "Reference to source NTP.", "$ref" : "#/definitions/From" }, "id" : { "type" : "integer", "format" : "int64", "description" : "Identifies the connectivity-matrix entry." }, "isAllowed" : { "type" : "boolean", "description" : "true - switching is allowed, false - switching is disallowed." }, "teLinkConnectivityAttributes" : { "$ref" : "#/definitions/TeLinkConnectivityAttributes" }, "to" : { "description" : "Reference to destination NTP.", "$ref" : "#/definitions/To" } }, "title" : "ConnectivityMatrix" }, "CosMapping" : { "type" : "object", "properties" : { "cos" : { "type" : "string", "description" : "Class of Service for the qos profile" }, "queueId" : { "type" : "integer", "format" : "int32", "description" : "The ID of an endpoint queue." } }, "title" : "CosMapping" }, "CostCharacteristic" : { "type" : "object", "properties" : { "costAlgorithm" : { "type" : "string", "description" : "The cost may vary based upon some properties of the TopologicalEntity. The rules for the variation are conveyed by the costAlgorithm." }, "costName" : { "type" : "string", "description" : "The cost characteristic related to some aspect of the TopologicalEntity (e.g. cost, routing weight). This aspect will be conveyed by the costName." }, "costValue" : { "type" : "string", "description" : "The specific cost." } }, "title" : "CostCharacteristic", "description" : "The information for a particular cost characteristic." }, "CustomAttribute" : { "type" : "object", "properties" : { "attributeName" : { "type" : "string", "description" : "custom attribute name" }, "attributeValue" : { "type" : "string", "description" : "custom attribute value" } }, "title" : "CustomAttribute", "description" : "A custom attribute" }, "CustomAttributesTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" } }, "title" : "CustomAttributesTemplate", "description" : "custom attributes template" }, "Customer" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "The mailing address for the customer" }, "contactPerson" : { "type" : "string", "description" : "The contact of the customer" }, "customerName" : { "type" : "string", "description" : "The name of the customer" }, "description" : { "type" : "string", "description" : "The description of the customer" }, "email" : { "type" : "string", "description" : "The email address of the customer" }, "id" : { "type" : "integer", "format" : "int64", "description" : "The unique identifier for the customer" }, "phoneNumber" : { "type" : "string", "description" : "The phone number for the customer" } }, "title" : "Customer", "description" : "The customer defined in the system" }, "DateAndTime" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "DateAndTime", "description" : "The date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset 'Z'. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device's configured known offset to UTC time. A change of the device's offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00." }, "Dc" : { "type" : "object", "properties" : { "l3DomainTemplates" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3DcDomainTemplate" } } }, "title" : "Dc", "description" : "Contains DC related configuration" }, "DeferredResult«ResponseData«List«OpenflowFlowEntry»»»" : { "type" : "object", "properties" : { "result" : { "type" : "object", "properties" : { } }, "setOrExpired" : { "type" : "boolean" } }, "title" : "DeferredResult«ResponseData«List«OpenflowFlowEntry»»»" }, "Destination" : { "type" : "object", "required" : [ "destNode" ], "properties" : { "destNode" : { "type" : "string", "description" : "Destination node identifier, must be in the same network." }, "destTp" : { "type" : "string", "description" : "Termination point within destination node that terminates the link." } }, "title" : "Destination", "description" : "This container holds the logical destination of a particular link." }, "DomainName" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "DomainName", "description" : "The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible. Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability. The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation. The description clause of schema nodes using the domain-name type MUST describe when and how these names are resolved to IP addresses. Note that the resolution of a domain-name value may require to query multiple DNS records (e.g., A for IPv4 and AAAA for IPv6). The order of the resolution process and which DNS record takes precedence can either be defined explicitly or may depend on the configuration of the resolver. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be A-labels as per RFC 5890." }, "DottedQuad" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "DottedQuad", "description" : "An unsigned 32-bit number expressed in the dotted-quad notation, i.e., four octets written as decimal numbers and separated with the '.' (full stop) character." }, "Dscp" : { "type" : "object", "properties" : { "uint8" : { "type" : "integer", "format" : "int32" } }, "title" : "Dscp", "description" : "The dscp type represents a Differentiated Services Code Point that may be used for marking packets in a traffic stream. In the value set and its semantics, this type is equivalent to the Dscp textual convention of the SMIv2." }, "EaccessRequestData" : { "type" : "object", "properties" : { "adjacencies" : { "type" : "array", "items" : { "$ref" : "#/definitions/Adjacency" } }, "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2EndpointRequest" } }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. Must match with far-end." }, "name" : { "type" : "string", "description" : "The name of the service" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. Must match with far-end.", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] } }, "title" : "EaccessRequestData", "description" : "The normalized E-Access service request" }, "EbgpRoute" : { "type" : "object", "required" : [ "peerAS", "peerIpAddress" ], "properties" : { "bfdEnabled" : { "type" : "boolean", "description" : "BFD protocol monitoring for the remote peer" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "peerAS" : { "type" : "integer", "format" : "int64", "description" : "Autonomous System number for the remote peer. Mandatory for Post only" }, "peerIpAddress" : { "description" : "The name of the Peer group for the Peer resent the next-hop address. Mandatory for Post only", "$ref" : "#/definitions/IpAddress" } }, "title" : "EbgpRoute" }, "Egress" : { "type" : "object", "properties" : { "vlanOperations" : { "description" : "A grouping which represents VLAN operations.", "$ref" : "#/definitions/VlanOperations" } }, "title" : "Egress", "description" : "Egress operations" }, "EgressParam" : { "type" : "object", "properties" : { "tier1Scheduler" : { "description" : "Tier1 Egress QoS scheduler parameters", "$ref" : "#/definitions/Tier1Scheduler" } }, "title" : "EgressParam", "description" : "Egress Qos policy parameters associated with an endpoint." }, "ElanServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "adminState" : { "type" : "string", "description" : "The administrative state required for the service.", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "autoBindType" : { "type" : "string", "description" : "The type of autobind to be used for the service. The default autobind type is none and it creates PW-based E-Lan. Other Autobind types create eVPN-based E-Lan", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "extensionTemplate" : { "$ref" : "#/definitions/EndpointExtensionTemplate" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "mediationProfileId" : { "type" : "string", "description" : "The ID of the Mediation Profile associated with the service" }, "meta" : { "type" : "array", "description" : "Meta data associated with template", "items" : { "type" : "string" } }, "monitorBandwidth" : { "type" : "boolean", "description" : "Specifies whether or not the service bandwidth should be monitored" }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. The valid values are between 0 and 9194." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portFilter" : { "type" : "array", "items" : { "$ref" : "#/definitions/PortFilter" } }, "qosId" : { "type" : "string", "description" : "The ID of the default QoS template associated with the service. Not Supported on C-Line templates" }, "qosName" : { "type" : "string", "description" : "The name of the default QoS template associated with the service. Not Supported on C-Line templates" }, "relaxEndpointValidation" : { "type" : "boolean", "description" : "When enabled, SF will not validate mode or ensure that vlan tags entered match encapType of port. It is disabled by default." }, "tunnelSelectionId" : { "type" : "string", "description" : "The ID of the Tunnel Selection template associated with the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "The ID of the Workflow Profile associated with the service" }, "workflowValidate" : { "type" : "string", "description" : "Workflow to run for service validation" } }, "title" : "ElanServiceCreationTemplate", "description" : "This template is used during E-LAN service creation" }, "ElineRequestData" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "autoBindType" : { "type" : "string", "description" : "The type of autobind to be used for the service. The default autobind type is none and it creates PW-based E-Line. Other Autobind types create eVPN-based Eline. Autobind type 'gre' does not apply to eVPN-based E-Line. This is referred to as Tunnel Type on the GUI", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "diverseFrom" : { "type" : "string", "description" : "Specifies the identifier of the service to be diverse from. This currently only applies to PCEP-based LSPs" }, "endpointExtensions" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2EndpointExtensionRequest" } }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2EndpointRequest" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "monitorBandwidth" : { "type" : "boolean", "description" : "Specifies whether or not the bandwidth utilization of the service will be monitored" }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values." }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "ElineRequestData", "description" : "The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network." }, "ElineServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "adminState" : { "type" : "string", "description" : "The administrative state required for the service.", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "autoBindType" : { "type" : "string", "description" : "The type of autobind to be used for the service. The default autobind type is none and it creates PW-based E-Line. Other Autobind types create eVPN-based E-Line.", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "extensionTemplate" : { "$ref" : "#/definitions/EndpointExtensionTemplate" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "mediationProfileId" : { "type" : "string", "description" : "The ID of the Mediation Profile associated with the service" }, "meta" : { "type" : "array", "description" : "Meta data associated with template", "items" : { "type" : "string" } }, "monitorBandwidth" : { "type" : "boolean", "description" : "Specifies whether or not the service bandwidth should be monitored" }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. The valid values are between 0 and 9194." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portFilter" : { "type" : "array", "items" : { "$ref" : "#/definitions/PortFilter" } }, "qosId" : { "type" : "string", "description" : "The ID of the default QoS template associated with the service. Not Supported on C-Line templates" }, "qosName" : { "type" : "string", "description" : "The name of the default QoS template associated with the service. Not Supported on C-Line templates" }, "relaxEndpointValidation" : { "type" : "boolean", "description" : "When enabled, SF will not validate mode or ensure that vlan tags entered match encapType of port. It is disabled by default." }, "tunnelSelectionId" : { "type" : "string", "description" : "The ID of the Tunnel Selection template associated with the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "The ID of the Workflow Profile associated with the service" }, "workflowValidate" : { "type" : "string", "description" : "Workflow to run for service validation" } }, "title" : "ElineServiceCreationTemplate", "description" : "This template is used during E-Line service creation" }, "EndpointExtensionNniTemplate" : { "type" : "object", "properties" : { "autosetTagsToMatchServiceEndpoint" : { "type" : "boolean", "description" : "Auto-set the NNI tags to match the service-endpoint" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable QinQ ports." }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." } }, "title" : "EndpointExtensionNniTemplate" }, "EndpointExtensionPortTemplate" : { "type" : "object", "properties" : { "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable QinQ ports." }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." } }, "title" : "EndpointExtensionPortTemplate" }, "EndpointExtensionTemplate" : { "type" : "object", "properties" : { "allowL2ExtensionConfiguration" : { "type" : "boolean", "description" : "Allow L2 Extension" }, "enableL2ExtensionAugmentation" : { "type" : "boolean", "description" : "Enable L2 Augmentation " }, "nni" : { "$ref" : "#/definitions/EndpointExtensionNniTemplate" }, "uni" : { "$ref" : "#/definitions/EndpointExtensionPortTemplate" } }, "title" : "EndpointExtensionTemplate" }, "ErrorMessages" : { "type" : "object", "properties" : { "errorReports" : { "$ref" : "#/definitions/ErrorReports" }, "errors" : { "type" : "array", "description" : "Descriptive message of one or many errors", "items" : { "type" : "string" } } }, "title" : "ErrorMessages", "description" : "An object which carries a list of errors" }, "ErrorReport" : { "type" : "object", "required" : [ "errorTag", "errorType" ], "properties" : { "errorAppTag" : { "type" : "string", "description" : "The application-specific error tag" }, "errorInfo" : { "type" : "object", "description" : "This anydata value MUST represent a container with zero or more data nodes representing additional error information", "properties" : { } }, "errorMsg" : { "type" : "string", "description" : "A message describing the error" }, "errorPath" : { "type" : "string", "description" : "The instance identifier associated with the error node" }, "errorTag" : { "type" : "string", "description" : "The enumerated error tag" }, "errorType" : { "type" : "string", "description" : "The protocol layer where the error occurred", "enum" : [ "protocol", "application", "rpc_notification", "transport" ] } }, "title" : "ErrorReport" }, "ErrorReports" : { "type" : "object", "properties" : { "errorReport" : { "type" : "array", "items" : { "$ref" : "#/definitions/ErrorReport" } } }, "title" : "ErrorReports" }, "ErrorResponseData" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«ErrorMessages»" } }, "title" : "ErrorResponseData" }, "EthTagClassify" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "EthTagClassify", "description" : "Identifies a specific VLAN tag classification." }, "EthTagType" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "EthTagType", "description" : "Identifies a specific ETH VLAN tag type." }, "Ethernet" : { "type" : "object", "properties" : { "encapType" : { "type" : "string", "description" : "The encapsulation type of the ethernet port", "enum" : [ "Null", "Unknown", "Dot1Q", "QinQ" ] }, "lag" : { "description" : "Contains LAG related configuration", "$ref" : "#/definitions/Lag" }, "lldpConfiguration" : { "type" : "array", "items" : { "$ref" : "#/definitions/LldpConfigurationInfo" } }, "lldpRemotePeers" : { "type" : "array", "items" : { "$ref" : "#/definitions/LldpRemotePeerInfo" } }, "portMode" : { "type" : "string", "description" : "The port-mode type of the ethernet port", "enum" : [ "NETWORK", "UNDEFINED", "ACCESS", "HYBRID" ] } }, "title" : "Ethernet", "description" : "Contains all Ethernet interface related configuration" }, "ExtendedAdminGroup" : { "type" : "object", "properties" : { "binary" : { "type" : "string", "format" : "byte" } }, "title" : "ExtendedAdminGroup", "description" : "Extended administrative group/Resource class/Color." }, "ExternalDomain" : { "type" : "object", "properties" : { "plugId" : { "type" : "integer", "format" : "int64", "description" : "A topology-wide unique number that identifies on the network a connectivity supporting a given inter-domain TE link. This is more flexible alternative to specifying remote-te-node-id and remote-te-link-tp-id, when the provider does not know remote-te-node-id and remote-te-link-tp-id or need to give client the flexibility to mix-n-match multiple topologies." }, "remoteTeLinkTpId" : { "description" : "Remote TE link termination point identifier, used together with remote-te-node-id to identify the remote link termination point in a different domain.", "$ref" : "#/definitions/TeTpId" }, "remoteTeNodeId" : { "description" : "Remote TE node identifier, used together with remote-te-link-id to identify the remote link termination point in a different domain.", "$ref" : "#/definitions/TeNodeId" } }, "title" : "ExternalDomain", "description" : "For an inter-domain link, specify the attributes of the remote end of link, to facilitate the signalling at local end." }, "ExternalId" : { "type" : "object", "properties" : { "context" : { "type" : "string", "description" : "The entity type that is managing this external-id", "enum" : [ "NFM_T", "NFM_P", "NODE", "MDM", "NSP" ] }, "id" : { "type" : "string", "description" : "The local identifier used on the entity." }, "location" : { "type" : "array", "description" : "The entity instance that is managing this external-id. This may be an IP address or a DNS name.", "items" : { "type" : "string" } } }, "title" : "ExternalId", "description" : "An external identifier to the NSP." }, "FlowCollection" : { "type" : "object", "properties" : { "mplsLabelStackQueryRate" : { "type" : "integer", "format" : "int32", "description" : "Interval in seconds between each query of KPI-engine for cflowd statistics." }, "srTeLspEnabled" : { "type" : "boolean", "description" : "Toggle whether flow-collection telemetry for SR-TE LSPs is enabled or not. Flow collection only takes place when traffic-data-collection.enabled is also true." }, "staleStatsWipeInterval" : { "type" : "integer", "format" : "int32", "description" : "Interval in seconds between checks for stale cflowd stats." }, "statsTimeToLive" : { "type" : "integer", "format" : "int32", "description" : "Time to live in seconds for stats before they become stale." } }, "title" : "FlowCollection", "description" : "NSP configuration for flow-collection telemetry parameters." }, "From" : { "type" : "object", "properties" : { "tpRef" : { "type" : "string", "description" : "Relative reference to source termination point." } }, "title" : "From", "description" : "Reference to source NTP." }, "GeneralizedLabel" : { "type" : "object", "properties" : { "binary" : { "type" : "string", "format" : "byte" } }, "title" : "GeneralizedLabel", "description" : "Generalized label. Nodes sending and receiving the Generalized Label know what kinds of link they are using, the Generalized Label does not identify its type. Instead, nodes are expected to know from the context what type of label to expect." }, "GeoLocation" : { "type" : "object", "properties" : { "latitude" : { "type" : "number", "format" : "double", "description" : "The latitude of the geographical location in degrees" }, "longitude" : { "type" : "number", "format" : "double", "description" : "The longitude of the geographical location in degrees" } }, "title" : "GeoLocation", "description" : "The location of the network element site" }, "IesServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "adminState" : { "type" : "string", "description" : "The administrative state required for the service", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "mediationProfileId" : { "type" : "string", "description" : "The ID of the Mediation Profile associated with the service" }, "meta" : { "type" : "array", "description" : "Meta data associated with template", "items" : { "type" : "string" } }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. The valid values are 0 (which means to use the port's MTU) or between 512 and 9000. Applied to all endpoints." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portFilter" : { "type" : "array", "items" : { "$ref" : "#/definitions/PortFilter" } }, "qosId" : { "type" : "string", "description" : "The ID of the default QoS template associated with the service" }, "qosName" : { "type" : "string", "description" : "The name of the default QoS template associated with the service" }, "relaxEndpointValidation" : { "type" : "boolean", "description" : "When enabled, SF will not validate mode or ensure that vlan tags entered match encapType of port. It is disabled by default." }, "workflowProfileId" : { "type" : "string", "description" : "The ID of the Workflow Profile associated with the service" }, "workflowValidate" : { "type" : "string", "description" : "Workflow to run for service validation" } }, "title" : "IesServiceCreationTemplate", "description" : "This template is used during IES service creation" }, "InformationSourceAttributes" : { "type" : "object", "properties" : { "informationSource" : { "type" : "string", "description" : "Indicates the source of the information.", "enum" : [ "other", "locally_configured", "ospfv2", "ospfv3", "isis", "system_processed", "unknown" ] }, "informationSourceState" : { "description" : "The container contains state attributes related to the information source.", "$ref" : "#/definitions/InformationSourceState" } }, "title" : "InformationSourceAttributes", "description" : "The attributes identifying source that has provided the related information, and the source credibility." }, "InformationSourceEntry" : { "type" : "object", "properties" : { "informationSourceAttributes" : { "$ref" : "#/definitions/InformationSourceAttributes" }, "teLinkInfoAttributes" : { "$ref" : "#/definitions/TeLinkInfoAttributes" } }, "title" : "InformationSourceEntry" }, "InformationSourceState" : { "type" : "object", "properties" : { "credibilityPreference" : { "type" : "integer", "format" : "int32", "description" : "The preference value to calculate the traffic engineering database credibility value used for tie-break selection between different information-source values. Higher value is more preferable." }, "routingInstance" : { "type" : "string", "description" : "When applicable, this is the name of a routing instance from which the information is learned." }, "topology" : { "description" : "When the information is processed by the system, the attributes in this container indicate which topology is used to process to generate the result information.", "$ref" : "#/definitions/Topology" } }, "title" : "InformationSourceState", "description" : "The container contains state attributes related to the information source." }, "Ingress" : { "type" : "object", "properties" : { "vlanOperations" : { "description" : "A grouping which represents VLAN operations.", "$ref" : "#/definitions/VlanOperations" } }, "title" : "Ingress", "description" : "Ingress operations" }, "IngressParam" : { "type" : "object", "properties" : { "tier1Scheduler" : { "description" : "Tier1 Ingress QoS scheduler parameters", "$ref" : "#/definitions/Tier1Scheduler" } }, "title" : "IngressParam", "description" : "Ingress Qos policy parameters associated with an endpoint." }, "InterfaceSwitchingCapability" : { "type" : "object", "properties" : { "encoding" : { "description" : "Encoding supported by this interface.", "$ref" : "#/definitions/LspEncodingTypes" }, "maxLspBandwidth" : { "type" : "object", "additionalProperties" : { "type" : "number", "format" : "double" } }, "switchingCapability" : { "description" : "Switching Capability for this interface.", "$ref" : "#/definitions/SwitchingCapabilities" }, "timeDivisionMultiplexCapable" : { "description" : "Interface has time-division multiplex capabilities.", "$ref" : "#/definitions/TimeDivisionMultiplexCapable" } }, "title" : "InterfaceSwitchingCapability" }, "InterfaceSwitchingCapabilityList" : { "type" : "object", "properties" : { "interfaceSwitchingCapability" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/InterfaceSwitchingCapability" } } }, "title" : "InterfaceSwitchingCapabilityList", "description" : "List of Interface Switching Capabilities Descriptors (ISCD)" }, "IpAddress" : { "type" : "object", "properties" : { "ipv4Address" : { "$ref" : "#/definitions/Ipv4Address" }, "ipv6Address" : { "$ref" : "#/definitions/Ipv6Address" } }, "title" : "IpAddress", "description" : "The ip-address type represents an IP address and is IP version neutral. The format of the textual representation implies the IP version. This type supports scoped addresses by allowing zone identifiers in the address format." }, "IpElanServiceRequest" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "autoBindType" : { "type" : "string", "description" : "The type of autobind to be used for the service. The default autobind type is none and it creates PW-based E-Lan. Other Autobind types create eVPN-based E-Lan. Autobind type 'gre' does not apply to eVPN-based E-Lan. This is referred to as Tunnel Type on the GUI", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "endpointExtensions" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2EndpointExtensionRequest" } }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2EndpointRequest" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values." }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "IpElanServiceRequest", "description" : "The normalized E-LAN service request" }, "IpIesServiceRequest" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3EndpointRequest" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "loopbackEndpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/LoopbackEndpointRequest" } }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values." }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "IpIesServiceRequest", "description" : "The IES service request. This object is used to create and modify service entities in the network." }, "IpL3DciServiceRequest" : { "type" : "object", "required" : [ "bidirectional", "connectivity", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "autobind" : { "type" : "string", "description" : "The type of autobind to be used for the service. Autobind type 'any' does not apply to L3 services. This is referred to as Tunnel Type on the GUI", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "backhaulMtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU to used for the backhaul service connectivity" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "connectivity" : { "type" : "string", "description" : "Specifies the technology method in which the connectivity should be provided", "enum" : [ "VXLAN_STITCHED", "MPLS_E2E" ] }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "dcEndpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3DcEndpointRequest" } }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "dualHomed" : { "type" : "boolean", "description" : "Defines whether or not entities may be dual homed. If so, additional EVPN Service configurations to aid in dual-homed deployments will be issued" }, "ecmp" : { "type" : "integer", "format" : "int64", "description" : "Maximum ECMP configuration to deploy on the service for tunnel binding" }, "encryption" : { "type" : "boolean", "description" : "Specifies whether or not Network Group Encryption is enabled for the service" }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3EndpointRequest" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "loopbackEndpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/LoopbackEndpointRequest" } }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values." }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "IpL3DciServiceRequest", "description" : "The L3 DCI service request. This object is used to create and modify service entities in the network." }, "IpL3ServiceNormalizedRequest" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "autobind" : { "type" : "string", "description" : "The type of autobind to be used for the service. Autobind type 'any' does not apply to L3 services. This is referred to as Tunnel Type on the GUI", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "encryption" : { "type" : "boolean", "description" : "Specifies whether or not Network Group Encryption is enabled for the service" }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3EndpointNormalizedRequest" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "loopbackEndpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/LoopbackEndpointRequest" } }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values." }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "IpL3ServiceNormalizedRequest", "description" : "The normalized L3 VPN service request. This object is used to create and modify service entities in the network." }, "IpL3ServiceRequest" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "autobind" : { "type" : "string", "description" : "The type of autobind to be used for the service. Autobind type 'any' does not apply to L3 services. This is referred to as Tunnel Type on the GUI", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "encryption" : { "type" : "boolean", "description" : "Specifies whether or not Network Group Encryption is enabled for the service" }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3EndpointRequest" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "loopbackEndpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/LoopbackEndpointRequest" } }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values." }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "IpL3ServiceRequest", "description" : "The L3 VPN service request. This object is used to create and modify service entities in the network." }, "IpOpticalCorrelationPolicy" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "latencyUploadPolicy" : { "type" : "string", "description" : "Policy to indicate how the latency changes in optical network need to be uploaded to IP Controller app", "enum" : [ "auto", "manual" ] }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "srlgUploadPolicy" : { "type" : "string", "description" : "Policy to indicate how the SRLG changes in optical network need to be uploaded to IP Controller app", "enum" : [ "auto", "manual" ] } }, "title" : "IpOpticalCorrelationPolicy", "description" : "IP Optical correlation policies" }, "IpPrefix" : { "type" : "object", "properties" : { "ipv4Prefix" : { "$ref" : "#/definitions/Ipv4Prefix" }, "ipv6Prefix" : { "$ref" : "#/definitions/Ipv6Prefix" } }, "title" : "IpPrefix", "description" : "The ip-prefix type represents an IP prefix and is IP version neutral. The format of the textual representations implies the IP version." }, "Ipv4Address" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "Ipv4Address", "description" : "The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format" }, "Ipv4Prefix" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "Ipv4Prefix", "description" : "The ipv4-prefix type represents an IPv4 address prefix. The prefix length is given by the number following the slash character and must be less than or equal to 32. A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0. The canonical format of an IPv4 prefix has all bits of the IPv4 address set to zero that are not part of the IPv4 prefix." }, "Ipv6Address" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "Ipv6Address", "description" : "The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007." }, "Ipv6Prefix" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "Ipv6Prefix", "description" : "The ipv6-prefix type represents an IPv6 address prefix. The prefix length is given by the number following the slash character and must be less than or equal to 128. A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0. The IPv6 address should have all bits that do not belong to the prefix set to zero. The canonical format of an IPv6 prefix has all bits of the IPv6 address set to zero that are not part of the IPv6 prefix. Furthermore, the IPv6 address is represented as defined in Section 4 of RFC 5952." }, "IroHop" : { "type" : "object", "properties" : { "hopType" : { "type" : "string", "description" : "The hop type, only strict or loose is supported", "enum" : [ "STRICT", "LOOSE", "UNKNOWN" ] }, "ipAddress" : { "description" : "The hop ip address", "$ref" : "#/definitions/IpAddress" } }, "title" : "IroHop", "description" : "IRO hop" }, "L2DciVpnServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "autobind" : { "type" : "string", "description" : "The type of autobind to be used for the service", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "descriptionGenerationTemplate" : { "type" : "string", "description" : "A template pattern for L2 DCI description when auto generated. The parameters may include the arguments described in property nameGenerationTemplate" }, "dualHomed" : { "type" : "boolean", "description" : "Defines whether or not entities may be dual homed. If so, additional EVPN Service configurations to aid in dual-homed deployments will be issued" }, "ecmp" : { "type" : "integer", "format" : "int64", "description" : "Maximum ECMP configuration to deploy on the service for tunnel binding" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "mediationProfileId" : { "type" : "string", "description" : "The ID of the Mediation Profile associated with the service" }, "meta" : { "type" : "array", "description" : "Meta data associated with template", "items" : { "type" : "string" } }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. The valid values are 0 (which means to use the port's MTU) or between 512 and 9000. Applied to all endpoints." }, "name" : { "type" : "string", "description" : "The name of the template" }, "nameGenerationMaxLength" : { "type" : "integer", "format" : "int64", "description" : "The maximum length for the generated service name. The name will be pruned. If collision happens, a random UUID is used in the <%callingName%> parameter and pruned to fit within the character limit" }, "nameGenerationTemplate" : { "type" : "string", "description" : "A template pattern for L2 DCI name when auto generated. Recommended value is to contain '<%callingName%>'. Key values available are: <%callingName%> From the underlying L2 domain name. This is the VSD L2 Domain name. <%callingKey%> From the underlying L2 domain passed in key. This is VSD l2 Domain uuid. <%random%> A randomized UUID with the dashes removed. " }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "qosId" : { "type" : "string", "description" : "The ID of the default QoS template associated with the service" }, "qosName" : { "type" : "string", "description" : "The name of the default QoS template associated with the service" }, "rdRtRangePolicyId" : { "type" : "string", "description" : "The ID of the L3VPN RT/RD policy associated with the service." }, "tunnelSelectionId" : { "type" : "string", "description" : "The ID of the Tunnel Selection template associated with the service." }, "workflowProfileId" : { "type" : "string", "description" : "The ID of the Workflow Profile associated with the service" } }, "title" : "L2DciVpnServiceCreationTemplate", "description" : "This template is used during L2 DCI VPN service creation" }, "L2EndPointExtension" : { "type" : "object", "properties" : { "connectedInner" : { "type" : "integer", "format" : "int32", "description" : "The inner tag of connected port" }, "connectedOuter" : { "type" : "integer", "format" : "int32", "description" : "The outer tag of connected port" }, "connectedPortId" : { "type" : "string", "description" : "The uuid of the connected port" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "nniPort" : { "description" : "The nni-port attributes", "$ref" : "#/definitions/NniPort" }, "uniPort" : { "description" : "The uni-port attributes", "$ref" : "#/definitions/UniPort" } }, "title" : "L2EndPointExtension", "description" : "The L2 endpoint extension definition" }, "L2EndpointExtensionRequest" : { "type" : "object", "properties" : { "connectedInner" : { "type" : "integer", "format" : "int32", "description" : "The inner tag of connected port" }, "connectedOuter" : { "type" : "integer", "format" : "int32", "description" : "The outer tag of connected port" }, "connectedPortId" : { "type" : "string", "description" : "The UUID of the connected port" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "nniPortConfig" : { "description" : "The nni-port attributes", "$ref" : "#/definitions/NniPortConfig" }, "uniPortConfig" : { "description" : "The uni-port attributes", "$ref" : "#/definitions/UniPortConfig" } }, "title" : "L2EndpointExtensionRequest", "description" : "The Layer 2 endpoint extension definition" }, "L2EndpointRequest" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "encapType" : { "type" : "string", "description" : "The encapsulation type of the ethernet port", "enum" : [ "Null", "Unknown", "Dot1Q", "QinQ" ] }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "isHub" : { "type" : "boolean", "description" : "Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service." }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portMode" : { "type" : "string", "description" : "the mode of the Port", "enum" : [ "NETWORK", "UNDEFINED", "ACCESS", "HYBRID" ] }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "siteServiceQosProfile" : { "description" : "The name of Generic QoS profile applied to the endpoint", "$ref" : "#/definitions/SiteServiceQosProfile" } }, "title" : "L2EndpointRequest", "description" : "The Layer 2 endpoint definition" }, "L2backhaulServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "adminState" : { "type" : "string", "description" : "The administrative state required for the service.", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "meta" : { "type" : "array", "description" : "Meta data associated with template", "items" : { "type" : "string" } }, "monitorBandwidth" : { "type" : "boolean", "description" : "Specifies whether or not the service bandwidth should be monitored" }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. The valid values are between 0 and 9194." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portFilter" : { "type" : "array", "items" : { "$ref" : "#/definitions/PortFilter" } }, "qosId" : { "type" : "string", "description" : "The ID of the default QoS template associated with the service. Not Supported on C-Line templates" }, "qosName" : { "type" : "string", "description" : "The name of the default QoS template associated with the service. Not Supported on C-Line templates" }, "tunnelSelectionId" : { "type" : "string", "description" : "The ID of the Tunnel Selection template associated with the service." }, "vcType" : { "type" : "string", "description" : "The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)", "enum" : [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ] }, "workflowProfileId" : { "type" : "string", "description" : "The ID of the Workflow Profile associated with the service" }, "workflowValidate" : { "type" : "string", "description" : "Workflow to run for service validation" } }, "title" : "L2backhaulServiceCreationTemplate", "description" : "This template is used during L2 Backhaul service creation" }, "L3DcDomainTemplate" : { "type" : "object", "required" : [ "id", "name" ], "properties" : { "id" : { "type" : "string", "description" : "The ID of the DC Domain Template" }, "name" : { "type" : "string", "description" : "The name of the DC Domain Template" } }, "title" : "L3DcDomainTemplate", "description" : "DC Domain template information" }, "L3DcEndpointRequest" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "domainTemplateId" : { "type" : "string", "description" : "The domain template ID to instantiate" }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" } }, "title" : "L3DcEndpointRequest", "description" : "The Layer 3 DC Interconnect endpoint definition" }, "L3DciVpnServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "adminState" : { "type" : "string", "description" : "The administrative state required for the service", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "autobind" : { "type" : "string", "description" : "The type of autobind to be used for the service", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "backhaulMtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU to used for the backhaul service connectivity" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "connectivity" : { "type" : "string", "description" : "Specifies the technology method in which the connectivity should be provided", "enum" : [ "VXLAN_STITCHED", "MPLS_E2E" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "dualHomed" : { "type" : "boolean", "description" : "Defines whether or not entities may be dual homed. If so, additional EVPN Service configurations to aid in dual-homed deployments will be issued" }, "ecmp" : { "type" : "integer", "format" : "int64", "description" : "Maximum ECMP configuration to deploy on the service for tunnel binding" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "mediationProfileId" : { "type" : "string", "description" : "The ID of the Mediation Profile associated with the service" }, "meta" : { "type" : "array", "description" : "Meta data associated with template", "items" : { "type" : "string" } }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. The valid values are 0 (which means to use the port's MTU) or between 512 and 9000. Applied to all endpoints." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portFilter" : { "type" : "array", "items" : { "$ref" : "#/definitions/PortFilter" } }, "qosId" : { "type" : "string", "description" : "The ID of the default QoS template associated with the service" }, "qosName" : { "type" : "string", "description" : "The name of the default QoS template associated with the service" }, "rdRtRangePolicyId" : { "type" : "string", "description" : "The ID of the L3VPN RT/RD policy associated with the service." }, "relaxEndpointValidation" : { "type" : "boolean", "description" : "When enabled, SF will not validate mode or ensure that vlan tags entered match encapType of port. It is disabled by default." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "The ID of the Tunnel Selection template associated with the service." }, "vrfPerEndpoint" : { "type" : "boolean", "description" : "When enabled, SF will create a new VRF for newly added endpoints if the VRF name is not specified in the request. Currently, only used by the UI." }, "workflowProfileId" : { "type" : "string", "description" : "The ID of the Workflow Profile associated with the service" }, "workflowValidate" : { "type" : "string", "description" : "Workflow to run for service validation" } }, "title" : "L3DciVpnServiceCreationTemplate", "description" : "This template is used during L3 DCI VPN service creation" }, "L3EndpointNormalizedRequest" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "encapType" : { "type" : "string", "description" : "The encapsulation type of the ethernet port", "enum" : [ "Null", "Unknown", "Dot1Q", "QinQ" ] }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "isHub" : { "type" : "boolean", "description" : "Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service." }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portMode" : { "type" : "string", "description" : "the mode of the Port", "enum" : [ "NETWORK", "UNDEFINED", "ACCESS", "HYBRID" ] }, "primaryAddress" : { "description" : "The primary IP address assigned to the service endpoint", "$ref" : "#/definitions/IpPrefix" }, "rd" : { "type" : "string", "description" : "The route distinguisher for the service endpoint. Only used when configured with route target(s)." }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "routeTargets" : { "type" : "array", "items" : { "$ref" : "#/definitions/RouteTarget" } }, "routingBgp" : { "description" : "BGP specific configuration.", "$ref" : "#/definitions/RoutingBgp" }, "routingStatic" : { "$ref" : "#/definitions/RoutingStatic" }, "secondaryAddresses" : { "type" : "array", "description" : "A list of secondary IP addresses assigned to the service endpoint", "items" : { "$ref" : "#/definitions/IpPrefix" } }, "siteServiceQosProfile" : { "description" : "The name of Generic QoS profile applied to the endpoint", "$ref" : "#/definitions/SiteServiceQosProfile" }, "vrfName" : { "type" : "string", "description" : "The name of the VRF instance to which this spoke/hub endpoint belongs. Spoke/Hub endpoints with the VRF names will be provisioned on the same VRF instance. Name will be autogenerated if left empty. Only applicable to Hub and Spoke L3VPNs." } }, "title" : "L3EndpointNormalizedRequest" }, "L3EndpointRequest" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "encapType" : { "type" : "string", "description" : "The encapsulation type of the ethernet port", "enum" : [ "Null", "Unknown", "Dot1Q", "QinQ" ] }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "isHub" : { "type" : "boolean", "description" : "Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service." }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portMode" : { "type" : "string", "description" : "the mode of the Port", "enum" : [ "NETWORK", "UNDEFINED", "ACCESS", "HYBRID" ] }, "primaryAddress" : { "description" : "The primary IP address assigned to the service endpoint", "$ref" : "#/definitions/IpPrefix" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "routingBgp" : { "description" : "BGP specific configuration.", "$ref" : "#/definitions/RoutingBgp" }, "routingStatic" : { "$ref" : "#/definitions/RoutingStatic" }, "secondaryAddresses" : { "type" : "array", "description" : "A list of secondary IP addresses assigned to the service endpoint", "items" : { "$ref" : "#/definitions/IpPrefix" } }, "siteServiceQosProfile" : { "description" : "The name of Generic QoS profile applied to the endpoint", "$ref" : "#/definitions/SiteServiceQosProfile" }, "vrfName" : { "type" : "string", "description" : "The name of the VRF instance to which this spoke/hub endpoint belongs. Spoke/Hub endpoints with the VRF names will be provisioned on the same VRF instance. Name will be autogenerated if left empty. Only applicable to Hub and Spoke L3VPNs." } }, "title" : "L3EndpointRequest" }, "L3vpnRdRtPolicy" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "maxAssignedForRd" : { "type" : "integer", "format" : "int64", "description" : "Maximum assigned number for route distinguisher. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive" }, "maxAssignedForRt" : { "type" : "integer", "format" : "int64", "description" : "The maximum value that can be assigned for the Intranet route target. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive" }, "maxAssignedForRtExtranet" : { "type" : "integer", "format" : "int64", "description" : "The maximum value that can be assigned for the Extranet route target. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive" }, "minAssignedForRd" : { "type" : "integer", "format" : "int64", "description" : "The minimum value that can be assigned for the route distinguisher. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive" }, "minAssignedForRt" : { "type" : "integer", "format" : "int64", "description" : "The minimum value that can be assigned for the Intranet route target. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive" }, "minAssignedForRtExtranet" : { "type" : "integer", "format" : "int64", "description" : "The minimum value that can be assigned for the Extranet route target. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive" }, "name" : { "type" : "string", "description" : "The name of the template" }, "networkASForRd" : { "type" : "boolean", "description" : "Specifies whether or not the network AS number will be used for the route distinguisher" }, "networkASForRt" : { "type" : "boolean", "description" : "Specifies whether or not the network AS number will be used for the Intranet route target" }, "networkASForRtExtranet" : { "type" : "boolean", "description" : "Specifies whether or not the network AS number will be used for the Extranet route target" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "policyType" : { "type" : "string", "description" : "Specifies L3VPN RT/RD policy type. Type can be RD and RT, RD only, or RT only.", "enum" : [ "RD_ONLY", "RD_AND_RT", "RT_EXTRANET_ONLY", "RT_ONLY" ] }, "rdAS" : { "type" : "integer", "format" : "int64", "description" : "The customer-specified AS number for the route distinguisher. For type 0, the value must be between 1 and 65535, inclusive. For Type 2, the value must be between 1 and 4294967295, inclusive. When the policy is configured using the network AS number, this value is not checked" }, "rdType" : { "type" : "integer", "format" : "int32", "description" : "The route distinguisher type. The value can be 0/1/2. When the policy is configured using the network AS number, this value is not checked" }, "rtAS" : { "type" : "integer", "format" : "int64", "description" : "The customer-specified AS number for the Intranet route target. For type 0, the value must be between 0 and 65535, inclusive. For Type 2, the value must be between 0 and 4294967295, inclusive. When the policy is configured using the network AS number, this value is not checked" }, "rtExtranetAS" : { "type" : "integer", "format" : "int64", "description" : "The customer-specified AS number for the Extranet route target. For type 0, the value must be between 0 and 65535, inclusive. For Type 2, the value must be between 0 and 4294967295, inclusive. When the policy is configured using the network AS number, this value is not checked" }, "rtExtranetType" : { "type" : "integer", "format" : "int32", "description" : "The Extranet route target. The value can be 0/1/2. When the policy is configured using the network AS number, this value is not checked" }, "rtType" : { "type" : "integer", "format" : "int32", "description" : "The Intranet route target. The value can be 0/1/2. When the policy is configured using the network AS number, this value is not checked" } }, "title" : "L3vpnRdRtPolicy", "description" : "L3VPN RT/RD policy" }, "L3vpnServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "adminState" : { "type" : "string", "description" : "The administrative state required for the service", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "autobind" : { "type" : "string", "description" : "The type of autobind to be used for the service", "enum" : [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ] }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "mediationProfileId" : { "type" : "string", "description" : "The ID of the Mediation Profile associated with the service" }, "meta" : { "type" : "array", "description" : "Meta data associated with template", "items" : { "type" : "string" } }, "mtu" : { "type" : "integer", "format" : "int64", "description" : "The MTU for the service. The valid values are 0 (which means to use the port's MTU) or between 512 and 9000. Applied to all endpoints." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portFilter" : { "type" : "array", "items" : { "$ref" : "#/definitions/PortFilter" } }, "qosId" : { "type" : "string", "description" : "The ID of the default QoS template associated with the service" }, "qosName" : { "type" : "string", "description" : "The name of the default QoS template associated with the service" }, "rdRtRangePolicyId" : { "type" : "string", "description" : "The ID of the L3VPN RT/RD policy associated with the service." }, "relaxEndpointValidation" : { "type" : "boolean", "description" : "When enabled, SF will not validate mode or ensure that vlan tags entered match encapType of port. It is disabled by default." }, "transportSliceName" : { "type" : "string", "description" : "Name of Transport Slice to be used by the service; absent if none. a transport slice will be auto-created if it does not already exist" }, "tunnelSelectionId" : { "type" : "string", "description" : "The ID of the Tunnel Selection template associated with the service." }, "vrfPerEndpoint" : { "type" : "boolean", "description" : "When enabled, SF will create a new VRF for newly added endpoints if the VRF name is not specified in the request. Currently, only used by the UI." }, "workflowProfileId" : { "type" : "string", "description" : "The ID of the Workflow Profile associated with the service" }, "workflowValidate" : { "type" : "string", "description" : "Workflow to run for service validation" } }, "title" : "L3vpnServiceCreationTemplate", "description" : "This template is used during L3 VPN service creation" }, "LXContainer" : { "type" : "object", "properties" : { "lxinformationList" : { "type" : "array", "items" : { "$ref" : "#/definitions/LXInformation" } } }, "title" : "LXContainer" }, "LXInformation" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The id of the 1830 LX" }, "ip" : { "description" : "The IP address of the 1830 LX", "$ref" : "#/definitions/IpAddress" }, "name" : { "type" : "string", "description" : "The name of the 1830 LX" }, "sink" : { "type" : "string", "description" : "The sink port of the 1830 LX" }, "sinkID" : { "type" : "string", "description" : "The id of the Sink Port" }, "source" : { "type" : "string", "description" : "The source port of the 1830 LX" }, "sourceID" : { "type" : "string", "description" : "The id of the Source Port" } }, "title" : "LXInformation" }, "LabelRestriction" : { "type" : "object", "properties" : { "inclusiveExclusive" : { "type" : "string", "description" : "Whether the list item is inclusive or exclusive.", "enum" : [ "inclusive", "exclusive" ] }, "labelEnd" : { "description" : "The ending lable if a lable range is specified; This attribute is not set, If a single lable is specified.", "$ref" : "#/definitions/GeneralizedLabel" }, "labelStart" : { "description" : "This is the starting lable if a lable range is specified. This is the lable value if a single lable is specified, in which case, attribute 'label-end' is not set.", "$ref" : "#/definitions/GeneralizedLabel" }, "rangeBitmap" : { "type" : "string", "format" : "byte", "description" : "When there are gaps between label-start and label-end, this attribute is used to specified the possitions of the used labels." } }, "title" : "LabelRestriction" }, "Lag" : { "type" : "object", "properties" : { "lagId" : { "type" : "integer", "format" : "int32", "description" : "The Id of the LAG" }, "lagMembers" : { "type" : "array", "items" : { "$ref" : "#/definitions/LagMemberInfo" } } }, "title" : "Lag", "description" : "Contains LAG related configuration" }, "LagMemberInfo" : { "type" : "object", "properties" : { "bandwidth" : { "type" : "integer", "format" : "int64", "description" : "The bandwidth of the LAG member" }, "id" : { "type" : "string", "description" : "The unique identifier of the LAG member" }, "name" : { "type" : "string", "description" : "The name of the LAG member" } }, "title" : "LagMemberInfo", "description" : "LAG member parameters" }, "LagRequest" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "destinationTimeslot" : { "type" : "string", "description" : "Applies timeslots to the port represented in a comma seperated value" }, "destinations" : { "type" : "array", "description" : "A list of destination service endpoints", "items" : { "type" : "string" } }, "encryption" : { "type" : "boolean", "description" : "Specifies whether the service should be encrypted or not. The service will be rejected if no path can be found which does not support encryption." }, "excludeRouteObject" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspOpticsExplicitRoute" } }, "facility" : { "type" : "integer", "format" : "int32", "description" : "Specifies the port facility number to be used for the OCH service. The value can be 1, or 2 for 260SCX2 L port in 200G mode" }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "includeRouteObject" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspOpticsExplicitRoute" } }, "lambda" : { "type" : "number", "format" : "double", "description" : "Unsupported - Specifies the lambda to be used for the service" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "modulation" : { "type" : "string", "description" : "Specifies the modulation scheme for the optical signal", "enum" : [ "SYSTEM_ASSIGNED", "MOD_SP_QPSK", "MOD_QPSK", "MOD_8QAM", "MOD_16QAM", "MOD_BPSK" ] }, "monitorBandwidth" : { "type" : "boolean", "description" : "Specifies whether or not the bandwidth utilization of the service will be monitored" }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "phaseEncoding" : { "type" : "string", "description" : "Specifies the encoding type of the optical signal", "enum" : [ "system_assigned", "absolute", "differential" ] }, "protection" : { "type" : "boolean", "description" : "Unsupported - Specifies whether a protection path should be created" }, "protectionExcludeRouteObject" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspOpticsExplicitRoute" } }, "protectionIncludeRouteObject" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspOpticsExplicitRoute" } }, "protectionType" : { "type" : "string", "description" : "Specifies the provisioned protection type of the connection. Only UNPROTECTED/OPSB/YCABLE are supported for ODU service and UNPROTECTED/OPSA are supported for OCH service.", "enum" : [ "SERVER_PROTECTED", "SNC_N", "SNC_N_SERVER_PROTECTED", "SNCP_N_SERVER_PROTECTED", "SNC_I", "OPSA", "YCABLE", "SNCP", "NA", "OPSB", "UNPROTECTED", "SNCP_N", "PROTECTED", "SNC_I_SERVER_PROTECTED", "OMSP" ] }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "regeneration" : { "type" : "boolean", "description" : "Specifies whether the service is permitted over a network element which performs optical regeneration" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "restoration" : { "type" : "string", "description" : "Specifies the recovery technique of a path after failure.", "enum" : [ "SBR", "GR", "None" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "reversionMode" : { "type" : "string", "description" : "Specifies how the path switches from the recovery to the the working path previously under failure condition.", "enum" : [ "softauto", "auto", "manual" ] }, "servicePlaneType" : { "type" : "string", "description" : "Specifies whether the service is Control Plane or Management Plane.", "enum" : [ "controlPlane", "mixedPlane", "mrn", "managementPlane" ] }, "sourceTimeslot" : { "type" : "string", "description" : "Applies timeslots to the port represented in a comma seperated value" }, "sources" : { "type" : "array", "description" : "A list of source service endpoints", "items" : { "type" : "string" } }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "waveshape" : { "type" : "string", "description" : "Specifies the shape of the optical signal to be used", "enum" : [ "single", "_super", "system_assigned", "alien" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "LagRequest", "description" : "The normalized LAG service request. This object is used to create and modify service entities in the network." }, "LagServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "bandwidth" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for LAG service creation" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "monitorBandwidth" : { "type" : "boolean", "description" : "Specifies whether or not the service bandwidth should be monitored" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "reverseBandwidth" : { "type" : "integer", "format" : "int64", "description" : "Specifies the reverse bandwidth required for LAG service creation" } }, "title" : "LagServiceCreationTemplate", "description" : "This template is used during LAG service creation" }, "Latency" : { "type" : "object", "properties" : { "classic" : { "type" : "boolean", "description" : "Enable/disable classic latency streaming. Requires the use of the twampTests to define source and destination for each session." }, "modelDriven" : { "type" : "boolean", "description" : "Enable/disable model-driven latency which uses the model-driven OAM application to create/execute/stop tests. The use of twampTests is not required with this mode." }, "twampTests" : { "type" : "array", "items" : { "$ref" : "#/definitions/TwampTest" } } }, "title" : "Latency", "description" : "Grouping of all latency related parameters for IP/MPLS optimization. If using classic mode, the user must define the session name, source, and destination for twamp tests using the twampTests body. Test session names must be unique among all tests. A new test with an already used session name will overwrite previous one." }, "LatencyCharacteristic" : { "type" : "object", "properties" : { "fixedLatencyCharacteristic" : { "type" : "string", "description" : "A TopologicalEntity suffers delay caused by the realization of the servers (e.g. distance related; FEC encoding etc.) along with some client specific processing. This is the total average latency effect of the TopologicalEntity" }, "jitterCharacteristic" : { "type" : "string", "description" : "High frequency deviation from true periodicity of a signal and therefore a small high rate of change of transfer latency. Applies to TDM systems (and not packet)." }, "queingLatencyCharacteristic" : { "type" : "string", "description" : "The specific queuing latency for the traffic property." }, "trafficPropertyName" : { "type" : "string", "description" : "The identifier of the specific traffic property to which the queuing latency applies." }, "wanderCharacteristic" : { "type" : "string", "description" : "Low frequency deviation from true periodicity of a signal and therefore a small low rate of change of transfer latency. Applies to TDM systems (and not packet)." } }, "title" : "LatencyCharacteristic", "description" : "Provides information on latency characteristic for a particular stated trafficProperty." }, "LifeCycle" : { "type" : "object", "properties" : { "phase" : { "type" : "string", "description" : "The phase of the life cycle object", "enum" : [ "Creation", "Deployment", "Activation", "Planning" ] }, "reason" : { "type" : "string", "description" : "The reason for the current phase/state of the life cycle object" }, "state" : { "type" : "string", "description" : "The state of the life cycle object", "enum" : [ "Delete", "PartiallyDeployed", "Deploying", "Undeployed", "Routing", "Planned", "Deployed", "DeploymentFailed", "WaitingForDeployment", "RoutedAndSaved", "RoutingFailed", "Saved", "Undeploy" ] } }, "title" : "LifeCycle", "description" : "The Life Cycle details for a given object." }, "Link" : { "type" : "object", "properties" : { "destination" : { "description" : "This container holds the logical destination of a particular link.", "$ref" : "#/definitions/Destination" }, "linkId" : { "description" : "The identifier of a link in the topology. A link is specific to a topology to which it belongs.", "$ref" : "#/definitions/LinkId" }, "nspLink" : { "description" : "Augmentation for NSP link", "$ref" : "#/definitions/NspLink" }, "source" : { "description" : "This container holds the logical source of a particular link.", "$ref" : "#/definitions/Source" }, "supportingLink" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/SupportingLink" } } }, "title" : "Link", "description" : "Configuration parameters for NSP at link level" }, "LinkConfig" : { "type" : "object", "properties" : { "linkParams" : { "description" : "NSP link parameters grouping", "$ref" : "#/definitions/LinkParams" } }, "title" : "LinkConfig", "description" : "Configuration data" }, "LinkCost" : { "type" : "object", "properties" : { "cost" : { "type" : "number", "format" : "double", "description" : "Allocation cost of the physical link" }, "latency" : { "type" : "number", "format" : "double", "description" : "The latency of the physical link in microseconds" } }, "title" : "LinkCost" }, "LinkId" : { "type" : "object", "properties" : { "uri" : { "$ref" : "#/definitions/Uri" } }, "title" : "LinkId", "description" : "An identifier for a link in a topology. The precise structure of the link-id will be up to the implementation. The identifier SHOULD be chosen such that the same link in a real network topology will always be identified through the same identifier, even if the model is instantiated in separate datastores. An implementation MAY choose to capture semantics in the identifier, for example to indicate the type of link and/or the type of topology that the link is a part of." }, "LinkParams" : { "type" : "object", "properties" : { "accessType" : { "type" : "string", "description" : "Link access type, which can be point-to-point ormulti-access", "enum" : [ "point_to_point", "multi_access" ] }, "adminStatus" : { "type" : "string", "description" : "The administrative state of the link", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "administrativeGroup" : { "description" : "Administrative group or color of the link. This attribute covers both administrative group (defined in RFC3630, RFC5329, and RFC5305), and extended administrative group (defined in RFC7308)", "$ref" : "#/definitions/AdminGroups" }, "igpMetric" : { "type" : "integer", "format" : "int32", "description" : "IGP topology Metric" }, "isAbstract" : { "type" : "object", "description" : "Present if the link is abstract", "properties" : { } }, "latency" : { "type" : "number", "format" : "double", "description" : "Delay or latency in micro seconds. The value must be greater than or equal to 0" }, "maxResvLinkBandwidth" : { "type" : "integer", "format" : "int64", "description" : "Maximum amount of bandwidth that can be reserved in this direction in this link. Units in kbps" }, "measuredIpBw" : { "type" : "number", "format" : "double", "description" : "Measured IP bandwidth. Units in Mbps. The value must be greater than or equal to 0" }, "measuredMplsBw" : { "type" : "number", "format" : "double", "description" : "Measured MPLS bandwidth. Units in Mbps. The value must be greater than or equal to 0" }, "name" : { "type" : "string", "description" : "Link Name" }, "srlgValue" : { "type" : "array", "description" : "A list of SRLG values", "items" : { "$ref" : "#/definitions/Srlg" } }, "teMetric" : { "type" : "integer", "format" : "int64", "description" : "Traffic Engineering Metric" }, "unreservedBandwidth" : { "type" : "integer", "format" : "int64", "description" : "Unreserved bandwidth. Units in kbps" } }, "title" : "LinkParams", "description" : "NSP link parameters grouping" }, "LinkState" : { "type" : "object", "properties" : { "linkParams" : { "description" : "NSP link parameters grouping", "$ref" : "#/definitions/LinkParams" }, "operStatus" : { "type" : "string", "description" : "The current operational state of the link", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] } }, "title" : "LinkState", "description" : "Operational state data" }, "LinkTemplate" : { "type" : "object", "properties" : { "name" : { "description" : "The name to identify a TE link template.", "$ref" : "#/definitions/TeTemplateName" }, "teLinkConfigAttributes" : { "$ref" : "#/definitions/TeLinkConfigAttributes" }, "templateAttributes" : { "$ref" : "#/definitions/TemplateAttributes" } }, "title" : "LinkTemplate" }, "LldpConfigurationInfo" : { "type" : "object", "properties" : { "administrativeStatus" : { "type" : "string", "description" : "The LLDP administrative status for the port", "enum" : [ "DISABLED", "TX_ONLY", "TX_AND_RX", "RX_ONLY" ] }, "configurationType" : { "type" : "string", "description" : "Whether this configuration is for Nearest Bridge, Nearest Customer, or Nearest Non TPMR", "enum" : [ "NEAREST_NON_TPMR", "NEAREST_CUSTOMER", "NEAREST_BRIDGE" ] }, "notifications" : { "type" : "boolean", "description" : "Whether notifications for LLDP are enabled on this port" } }, "title" : "LldpConfigurationInfo", "description" : "LLDP parameters reflect physical connectivity in the network" }, "LldpRemotePeerInfo" : { "type" : "object", "properties" : { "capabilitiesEnabled" : { "type" : "integer", "format" : "int64", "description" : "The capabilities that are enabled on the remote port" }, "capabilitiesSupported" : { "type" : "integer", "format" : "int64", "description" : "The capabilities the remote port supports" }, "portDescription" : { "type" : "string", "description" : "The description of the remote port" }, "remoteChassisId" : { "type" : "string", "description" : "A string identifying the remote chassis" }, "remoteChassisIdType" : { "type" : "string", "description" : "The remote chassis id type", "enum" : [ "INTERFACE_ALIAS", "INTERFACE_NAME", "SUBNET", "NETWORK_ADDRESS", "PORT_COMPONENT", "LOCAL", "CHASSIS_COMPONENT", "MAC_ADDRESS" ] }, "remoteIndex" : { "type" : "integer", "format" : "int64", "description" : "The remote peer index" }, "remoteManagementIpAddress" : { "type" : "array", "items" : { "$ref" : "#/definitions/IpAddress" } }, "remotePeerType" : { "type" : "string", "description" : "The remote peer type", "enum" : [ "NEAREST_NON_TPMR", "NEAREST_CUSTOMER", "NEAREST_BRIDGE" ] }, "remotePortId" : { "type" : "string", "description" : "A string identifying the remote port" }, "remotePortIdType" : { "type" : "string", "description" : "The remote port id type", "enum" : [ "INTERFACE_ALIAS", "INTERFACE_NAME", "NETWORK_ADDRESS", "PORT_COMPONENT", "LOCAL", "AGENT_CIRCUIT_ID", "MAC_ADDRESS" ] }, "remoteSystemName" : { "type" : "string", "description" : "The name of the remote system" } }, "title" : "LldpRemotePeerInfo", "description" : "LLDP parameters reflect physical connectivity in the network" }, "LoopbackEndpointRequest" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "isHub" : { "type" : "boolean", "description" : "Specifies whether or not the loopback endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service." }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "primaryAddress" : { "description" : "The primary IP address assigned to the service loopBack endpoint", "$ref" : "#/definitions/IpPrefix" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "vrfName" : { "type" : "string", "description" : "The name of the VRF instance to which this spoke/hub endpoint belongs. Spoke/Hub endpoints with the VRF names will be provisioned on the same VRF instance. Name will be autogenerated if left empty. Only applicable to Hub and Spoke L3VPNs." } }, "title" : "LoopbackEndpointRequest", "description" : "The LoopBack endpoint definition" }, "Lsp" : { "type" : "object", "properties" : { "externalId" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/ExternalId" } }, "lspId" : { "type" : "string", "description" : "ID: Unique identifier of the LSP" }, "lspName" : { "type" : "string", "description" : "LSP name" }, "measuredBandwidth" : { "type" : "integer", "description" : "Measured bandwidth on active LSP path" }, "paths" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/LspPath" } }, "tunnelId" : { "type" : "integer", "format" : "int64", "description" : "LSP tunnel identifier" } }, "title" : "Lsp", "description" : "MPLS LSP" }, "LspEncodingTypes" : { "type" : "object", "title" : "LspEncodingTypes", "description" : "Base identity for encoding types" }, "LspPath" : { "type" : "object", "properties" : { "administrativeFailureErrorCode" : { "type" : "string", "description" : "The error code when administrative operation is failed", "enum" : [ "INVALID_PLSPID", "PROTO_DISCONNECTED", "PATH_NAME_IN_USE", "UNACCEPTABLE_PARAM", "VSR_NOT_EXSIST", "PCC_NOT_CAPABLE", "PATH_NOT_FOUND", "NSP_INTERNAL", "UNDEFINED_PATH_ERR", "PCE_NOT_FOUND", "ADMIN_DOWN", "NO_ERROR", "PCC_DISCONNECTED", "UNKNOWN_REASON", "SRC_NOT_EXIST", "NO_RESPONSE", "PCC_INTERNAL_ERROR", "VSR_NOT_CAPABLE", "INTERNAL_ERROR", "LSP_BAD_PARAM", "SYNC_DELETE", "SRC_NOT_UNIQUE", "UNKNOWN_PLSPID", "SIGNALLING", "LIMIT_RCHD", "PCC_NOT_EXIST", "PCC_ADMIN_DOWN" ] }, "administrativeState" : { "type" : "string", "description" : "Path administrative state", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "computationState" : { "type" : "string", "description" : "Path computation state", "enum" : [ "PATH_NOT_FOUND", "PATH_ERROR", "PATH_FOUND", "UNKNOWN", "PATH_NOT_COMPUTED" ] }, "computedHops" : { "description" : "Path computed hops. Explicit Route Objects (ERO)", "$ref" : "#/definitions/ComputedHops" }, "creationType" : { "type" : "string", "description" : "Path creation origin", "enum" : [ "PROVISIONED", "REQUESTED", "UNKNOWN", "INITIATED", "DISCOVERED" ] }, "destinationAddress" : { "description" : "Path destination IP address", "$ref" : "#/definitions/IpAddress" }, "destinationId" : { "type" : "string", "description" : "ID: Unique identifier of the destination topology link/tp" }, "destinationNetworkName" : { "type" : "array", "description" : "Path destination network topology name", "items" : { "type" : "string" } }, "latency" : { "type" : "number", "format" : "double", "description" : "Path latency" }, "lifecycleState" : { "type" : "string", "description" : "Path lifecycle state", "enum" : [ "Delete", "PartiallyDeployed", "Deploying", "Undeployed", "Routing", "Planned", "Deployed", "DeploymentFailed", "WaitingForDeployment", "RoutedAndSaved", "RoutingFailed", "Saved", "Undeploy" ] }, "lspId" : { "type" : "string", "description" : "ID: Unique identifier of the parent LSP" }, "maintenanceAffected" : { "type" : "string", "description" : "This flag indicates if any of the LSP path hops are affected by maintenance mode", "enum" : [ "MAINTENANCE_CLEAR", "HOPS_IN_MAINTENANCE", "NONE" ] }, "operationalState" : { "type" : "string", "description" : "Path operational state", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "ownershipState" : { "description" : "Path ownership state", "$ref" : "#/definitions/OwnershipState" }, "paramsConfig" : { "description" : "Path parameters configuration", "$ref" : "#/definitions/ParamsConfig" }, "paramsState" : { "description" : "Path parameters state", "$ref" : "#/definitions/ParamsState" }, "pathErrorCode" : { "type" : "string", "description" : "The error code of path status", "enum" : [ "INVALID_PLSPID", "PROTO_DISCONNECTED", "PATH_NAME_IN_USE", "UNACCEPTABLE_PARAM", "VSR_NOT_EXSIST", "PCC_NOT_CAPABLE", "PATH_NOT_FOUND", "NSP_INTERNAL", "UNDEFINED_PATH_ERR", "PCE_NOT_FOUND", "ADMIN_DOWN", "NO_ERROR", "PCC_DISCONNECTED", "UNKNOWN_REASON", "SRC_NOT_EXIST", "NO_RESPONSE", "PCC_INTERNAL_ERROR", "VSR_NOT_CAPABLE", "INTERNAL_ERROR", "LSP_BAD_PARAM", "SYNC_DELETE", "SRC_NOT_UNIQUE", "UNKNOWN_PLSPID", "SIGNALLING", "LIMIT_RCHD", "PCC_NOT_EXIST", "PCC_ADMIN_DOWN" ] }, "pathId" : { "type" : "string", "description" : "ID: Unique identifier of the path" }, "pathName" : { "type" : "string", "description" : "Path name" }, "pathType" : { "type" : "string", "description" : "Path type denoting signaling type", "enum" : [ "SRTE", "UNKNOWN", "RSVP" ] }, "protectionState" : { "type" : "string", "description" : "Path protection/redundancy activity state", "enum" : [ "ACTIVE", "INACTIVE", "UNKNOWN" ] }, "protectionType" : { "type" : "string", "description" : "Path protection/redundancy type", "enum" : [ "SECONDARY", "STANDBY", "PRIMARY", "UNKNOWN" ] }, "provisionedHops" : { "description" : "Path provisioned hops. Include Route Objects (IRO)", "$ref" : "#/definitions/ProvisionedHops" }, "recordedHops" : { "description" : "Path recorded/actual hops. Recorded Route Objects (RRO)", "$ref" : "#/definitions/RecordedHops" }, "sourceAddress" : { "description" : "Path source IP address", "$ref" : "#/definitions/IpAddress" }, "sourceId" : { "type" : "string", "description" : "ID: Unique identifier of the source topology link/tp" }, "sourceNetworkName" : { "type" : "array", "description" : "Path source network topology name", "items" : { "type" : "string" } }, "sourceRouterAddress" : { "description" : "Path source router IP address", "$ref" : "#/definitions/IpAddress" }, "tunnelId" : { "type" : "integer", "format" : "int64", "description" : "Path tunnel identifier" } }, "title" : "LspPath", "description" : "LSP path" }, "LspPathConfigRequest" : { "type" : "object", "required" : [ "creationType", "destinationAddress", "pathName", "pathType", "sourceAddress", "sourceRouterAddress" ], "properties" : { "administrativeState" : { "type" : "string", "description" : "Path administrative state", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "creationType" : { "type" : "string", "description" : "Path creation origin", "enum" : [ "PROVISIONED", "REQUESTED", "UNKNOWN", "INITIATED", "DISCOVERED" ] }, "destinationAddress" : { "description" : "Path destination IP address", "$ref" : "#/definitions/IpAddress" }, "paramsConfig" : { "description" : "Path parameters configuration", "$ref" : "#/definitions/LspPathConfigRequestParamsConfig" }, "pathName" : { "type" : "string", "description" : "Path name" }, "pathType" : { "type" : "string", "description" : "Path type denoting signaling type", "enum" : [ "SRTE", "UNKNOWN", "RSVP" ] }, "sourceAddress" : { "description" : "Path source IP address", "$ref" : "#/definitions/IpAddress" }, "sourceRouterAddress" : { "description" : "Path source router IP address", "$ref" : "#/definitions/IpAddress" } }, "title" : "LspPathConfigRequest" }, "LspPathConfigRequestParamsConfig" : { "type" : "object", "properties" : { "pathParams" : { "description" : "LSP path parameters", "$ref" : "#/definitions/PathParams" } }, "title" : "LspPathConfigRequestParamsConfig", "description" : "Path parameters configuration" }, "LspProtType" : { "type" : "object", "title" : "LspProtType", "description" : "Base identity from which LSP protection types are derived." }, "Measurement" : { "type" : "object", "properties" : { "performanceMetricAttributes" : { "description" : "Link performance information in real time.", "$ref" : "#/definitions/PerformanceMetricAttributes" } }, "title" : "Measurement", "description" : "Measured performance metric values. Static configuration and manual overrides of these measurements are also allowed." }, "MediationAugmentationRequest" : { "type" : "object", "required" : [ "neId", "pathName" ], "properties" : { "neId" : { "type" : "string", "description" : "The Network Element identifier" }, "pathName" : { "type" : "string", "description" : "The hierarchy for a given yang entity in the following format : eg., nsd-service:/services/elan-sites/site/config This information is used to find the appropriate JSON which corresponds to the given ne-id, ami-name, ami-version, template-name. This field has to be encoded to handle the special characters." }, "serviceType" : { "type" : "string", "description" : "The type of the service", "enum" : [ "ODU", "TUNNEL", "EACCESS", "L2_EXTENSION_UNI", "CLINE", "L2_EXTENSION_NNI", "L2_BACKHAUL", "L2_DCI", "PHYSICAL_LINK", "LAG", "ELAN", "OCH", "ELINE", "IES", "L3_VPN", "L3_DCI" ] }, "templateId" : { "type" : "string", "description" : "The identifier of the template associated to the augmentation." } }, "title" : "MediationAugmentationRequest", "description" : "Mediation Augmentation Request" }, "MediationInfo" : { "type" : "object", "properties" : { "mediationName" : { "type" : "string", "description" : "The Application Mediation Interface name. If the mediation info is for network elements managed by NFM-P then this value must be 'NfmpService'. For MDM managed nodes, the valid values are dynamic and can be queried using the get /v4/mediation/ami-version-templates rpc." }, "mediationVersion" : { "type" : "string", "description" : "The Application Mediation Interface version" }, "templateGlobalName" : { "type" : "string", "description" : "The global name for the template" } }, "title" : "MediationInfo", "description" : "Mediation Template mapping information" }, "MediationProfileTemplateMapping" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "mediationInfos" : { "type" : "array", "items" : { "$ref" : "#/definitions/MediationInfo" } }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "profileType" : { "type" : "string", "description" : "The service type associated with the Mediation profile", "enum" : [ "ELAN", "CLINE", "ELINE", "IES", "L3VPN" ] } }, "title" : "MediationProfileTemplateMapping", "description" : "Mediation profile that defines the Mediation and their template associations." }, "NePolicyIdentifier" : { "type" : "object", "properties" : { "ipAddress" : { "type" : "string", "description" : "The IP address of the network element" }, "policyIdentifiers" : { "type" : "array", "items" : { "$ref" : "#/definitions/PolicyIdentifier" } }, "siteName" : { "type" : "string", "description" : "The name of the network element site" } }, "title" : "NePolicyIdentifier", "description" : "The list of policy identifiers per NE" }, "Network" : { "type" : "object", "properties" : { "link" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/Link" } }, "networkId" : { "description" : "Identifies a network.", "$ref" : "#/definitions/NetworkId" }, "networkTypes" : { "description" : "Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container.", "$ref" : "#/definitions/NetworkTypes" }, "node" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/Node" } }, "nspNetwork" : { "description" : "Augmentation for NSP network", "$ref" : "#/definitions/NspNetwork" }, "serverProvided" : { "type" : "boolean", "description" : "Indicates whether the information concerning this particular network is populated by the server (server-provided true, the general case for network information discovered from the server), or whether it is configured by a client (server-provided true, possible e.g. for service overlays managed through a controller). Clients should not attempt to make modifications to network instances with server-provided set to true; when they do, they need to be aware that any modifications they make are subject to be reverted by the server. For servers that support NACM (Netconf Access Control Model), data node rules should ideally prevent write access by other clients to the network instance when server-provided is set to true." }, "supportingNetwork" : { "type" : "array", "items" : { "type" : "string" } } }, "title" : "Network", "description" : "Configuration parameters for NSP L3 topology" }, "NetworkConfig" : { "type" : "object", "properties" : { "networkParams" : { "description" : "NSP network topology parameters grouping", "$ref" : "#/definitions/NetworkParams" } }, "title" : "NetworkConfig", "description" : "Configuration data" }, "NetworkElement" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "baseMacAddress" : { "type" : "string", "description" : "The base MAC address for the network element" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customProperties" : { "type" : "array", "description" : "The custom properties of the network element", "items" : { "type" : "string" } }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "geoLocation" : { "description" : "The location of the network element site", "$ref" : "#/definitions/GeoLocation" }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "ipAddress" : { "type" : "string", "description" : "The IP address of the network element" }, "l3vpnCapable" : { "type" : "boolean", "description" : "Specifies whether or not the network element is l3vpn capable" }, "location" : { "type" : "string", "description" : "The name of the site where the network element is located" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "nspDbFdn" : { "type" : "string", "description" : "FDN of the network element used for this object in the NSP DB" }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "platform" : { "description" : "Contains vendor-specific information for identifying the system platform and operating system.", "$ref" : "#/definitions/Platform" }, "pwSwitchingCapable" : { "type" : "boolean", "description" : "Specifies whether or not the network element is pseudowire switching capable. Defaults to false" }, "siteName" : { "type" : "string", "description" : "The name of the network element site" } }, "title" : "NetworkElement", "description" : "The network element definition" }, "NetworkElementRequest" : { "type" : "object", "properties" : { "l3vpnCapable" : { "type" : "boolean", "description" : "Specifies whether or not the network element is l3vpn capable" }, "pwSwitchingCapable" : { "type" : "boolean", "description" : "Specifies whether or not the network element is pseudowire switching capable. Defaults to false" } }, "title" : "NetworkElementRequest", "description" : "A request object used to modify Network Element" }, "NetworkId" : { "type" : "object", "properties" : { "uri" : { "$ref" : "#/definitions/Uri" } }, "title" : "NetworkId", "description" : "Identifier for a network. The precise structure of the network-id will be up to an implementation. The identifier SHOULD be chosen such that the same network will always be identified through the same identifier, even if the model is instantiated in separate datastores. An implementation MAY choose to capture semantics in the identifier, for example to indicate the type of network." }, "NetworkIdentifierType" : { "type" : "object", "properties" : { "uint32" : { "type" : "integer", "format" : "int64" } }, "title" : "NetworkIdentifierType", "description" : "Network identifier." }, "NetworkParams" : { "type" : "object", "properties" : { "area" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/Area" } }, "preference" : { "type" : "integer", "format" : "int32", "description" : "Specifies a preference for this topology. A lower number indicates a higher preference" } }, "title" : "NetworkParams", "description" : "NSP network topology parameters grouping" }, "NetworkState" : { "type" : "object", "properties" : { "networkParams" : { "description" : "NSP network topology parameters grouping", "$ref" : "#/definitions/NetworkParams" } }, "title" : "NetworkState", "description" : "Operational state data" }, "NetworkTypes" : { "type" : "object", "title" : "NetworkTypes", "description" : "Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container." }, "Networks" : { "type" : "object", "properties" : { "network" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/Network" } }, "nspNetworks" : { "$ref" : "#/definitions/NspNetworks" } }, "title" : "Networks" }, "NetworksConfig" : { "type" : "object", "properties" : { "networksParams" : { "description" : "networks attributes in a topology", "$ref" : "#/definitions/NetworksParams" } }, "title" : "NetworksConfig" }, "NetworksParams" : { "type" : "object", "title" : "NetworksParams", "description" : "networks attributes in a topology" }, "NetworksState" : { "type" : "object", "properties" : { "networksParams" : { "description" : "networks attributes in a topology", "$ref" : "#/definitions/NetworksParams" } }, "title" : "NetworksState" }, "NniPort" : { "type" : "object", "properties" : { "actualEndState" : { "type" : "string", "description" : "The current end state of this endpoint (whether it is Saved, Deployed, etc)", "enum" : [ "Saved", "Deployed" ] }, "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "name" : { "type" : "string", "description" : "The name of the service endpoint" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "neId" : { "type" : "string", "description" : "The identifier of the network element where the service endpoint resides" }, "neName" : { "type" : "string", "description" : "The name of the network element to which this endpoint belongs" }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portAdminState" : { "type" : "string", "description" : "The administrative state of port used by endpoint", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "portId" : { "type" : "string", "description" : "The identifier of the port upon which the service endpoint resides" }, "portName" : { "type" : "string", "description" : "The name of the port upon which the service endpoint resides" }, "portOperationalState" : { "type" : "string", "description" : "The operational state of port used by endpoint", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "portSpeed" : { "type" : "integer", "format" : "int64", "description" : "The bandwidth of port used by endpoint" }, "serviceId" : { "type" : "string", "description" : "The identifier of the service that uses this endpoint" } }, "title" : "NniPort" }, "NniPortConfig" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" } }, "title" : "NniPortConfig", "description" : "The NNI endpoint definition" }, "Node" : { "type" : "object", "properties" : { "nodeId" : { "description" : "Identifies a node uniquely within the containing network.", "$ref" : "#/definitions/NodeId" }, "nspNode" : { "description" : "Augmentation for NSP node", "$ref" : "#/definitions/NspNode" }, "supportingNode" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/SupportingNode" } }, "terminationPoint" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/TerminationPoint" } } }, "title" : "Node" }, "NodeConfig" : { "type" : "object", "properties" : { "nodeParams" : { "description" : "NSP node parameters grouping", "$ref" : "#/definitions/NodeParams" } }, "title" : "NodeConfig", "description" : "Configuration data" }, "NodeData" : { "type" : "object", "properties" : { "nspNode" : { "description" : "Augmentation for NSP node", "$ref" : "#/definitions/NspNode" } }, "title" : "NodeData", "description" : "Node data" }, "NodeId" : { "type" : "object", "properties" : { "uri" : { "$ref" : "#/definitions/Uri" } }, "title" : "NodeId", "description" : "Identifier for a node. The precise structure of the node-id will be up to the implementation. Some implementations MAY for example, pick a uri that includes the network-id as part of the path. The identifier SHOULD be chosen such that the same node in a real network topology will always be identified through the same identifier, even if the model is instantiated in separate datastores. An implementation MAY choose to capture semantics in the identifier, for example to indicate the type of node." }, "NodeParams" : { "type" : "object", "properties" : { "areaId" : { "type" : "array", "items" : { "type" : "string" } }, "correlatedNetworkElementUuid" : { "type" : "string", "description" : "The network element UUID that was correlated to match with the IGP Router ID. This value may be null if no correlation to a network element was achieved" }, "correlatedSiteId" : { "type" : "string", "description" : "The Site ID is the IP address of the network element that is managed via NFMP or MDM, and was correlated to match with the IGP Router ID. This value may be null if no correlation to a network element was achieved" }, "designatedRouter" : { "type" : "string", "description" : "The designated-router interpretation depends on the protocol and it is only applicable to subnets. For ISIS, it contains system ID. For ospfv2, it contains the designated router ID" }, "designatedRouterIp" : { "type" : "string", "description" : "The designated-router-ip interpretation depends on the protocol and it is only applicable to subnets. For ISIS, it contains PSN identifier. For OSPFV2, it contains the ip address of the designated router's interface" }, "nodeId" : { "description" : "The identifier of a node in the NSP topology A node is specific to a topology to which it belongs", "$ref" : "#/definitions/TeNodeId" }, "operStatus" : { "type" : "string", "description" : "The current operational state of the node", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "srStartLabel" : { "type" : "integer", "format" : "int64", "description" : "MPLS label range start value" } }, "title" : "NodeParams", "description" : "NSP node parameters grouping" }, "NodeState" : { "type" : "object", "properties" : { "nodeParams" : { "description" : "NSP node parameters grouping", "$ref" : "#/definitions/NodeParams" } }, "title" : "NodeState", "description" : "Operational state data" }, "NodeTemplate" : { "type" : "object", "properties" : { "name" : { "description" : "The name to identify a TE node template.", "$ref" : "#/definitions/TeTemplateName" }, "teNodeConfigAttributesTemplate" : { "$ref" : "#/definitions/TeNodeConfigAttributesTemplate" }, "templateAttributes" : { "$ref" : "#/definitions/TemplateAttributes" } }, "title" : "NodeTemplate" }, "Normality" : { "type" : "object", "properties" : { "performanceMetricNormalityAttributes" : { "description" : "Link performance metric normality attributes.", "$ref" : "#/definitions/PerformanceMetricNormalityAttributes" } }, "title" : "Normality", "description" : "Performance metric normality values." }, "NspEthtSvcAccessParameters" : { "type" : "object", "properties" : { "accessLtpId" : { "description" : "The TE link termination point identifier, used together with access-node-id to identify the access LTP.", "$ref" : "#/definitions/TeTpId" }, "accessNodeId" : { "description" : "The identifier of the access node in the ETH transport topology.", "$ref" : "#/definitions/TeNodeId" }, "bandwidthProfiles" : { "description" : "A grouping which represent bandwidth profile configuration.", "$ref" : "#/definitions/BandwidthProfiles" }, "baseEndpointRequest" : { "description" : "All endpoints type definition", "$ref" : "#/definitions/BaseEndpointRequest" }, "outerTag" : { "description" : "Classifies traffic using the outermost VLAN tag.", "$ref" : "#/definitions/VlanClassificationOuterTag" }, "secondTag" : { "description" : "Classifies traffic using the second outermost VLAN tag.", "$ref" : "#/definitions/VlanClassificationSecondTag" }, "serviceClassificationType" : { "description" : "Service classification type.", "$ref" : "#/definitions/ServiceClassificationType" }, "splitHorizonGroup" : { "type" : "string", "description" : "Identify a split horizon group" }, "vlanOperations" : { "$ref" : "#/definitions/NspEthtSvcAccessParametersVlanOperations" } }, "title" : "NspEthtSvcAccessParameters", "description" : "ETH transport services access parameters" }, "NspEthtSvcAccessParametersVlanOperations" : { "type" : "object", "properties" : { "asymmetricalOperation" : { "description" : "Asymmetrical operations", "$ref" : "#/definitions/AsymmetricalOperation" }, "symmetricalOperation" : { "description" : "Symmetrical operations. Expressed in the ingress direction, but the reverse operation is applied to egress traffic", "$ref" : "#/definitions/SymmetricalOperation" } }, "title" : "NspEthtSvcAccessParametersVlanOperations" }, "NspLink" : { "type" : "object", "properties" : { "linkConfig" : { "description" : "Configuration data", "$ref" : "#/definitions/LinkConfig" }, "linkState" : { "description" : "Operational state data", "$ref" : "#/definitions/LinkState" } }, "title" : "NspLink", "description" : "Augmentation for NSP link" }, "NspNetwork" : { "type" : "object", "properties" : { "networkConfig" : { "description" : "Configuration data", "$ref" : "#/definitions/NetworkConfig" }, "networkName" : { "type" : "string", "description" : "The name of the network" }, "networkState" : { "description" : "Operational state data", "$ref" : "#/definitions/NetworkState" } }, "title" : "NspNetwork", "description" : "Augmentation for NSP network" }, "NspNetworks" : { "type" : "object", "properties" : { "networksConfig" : { "$ref" : "#/definitions/NetworksConfig" }, "networksState" : { "$ref" : "#/definitions/NetworksState" } }, "title" : "NspNetworks" }, "NspNode" : { "type" : "object", "properties" : { "nodeConfig" : { "description" : "Configuration data", "$ref" : "#/definitions/NodeConfig" }, "nodeState" : { "description" : "Operational state data", "$ref" : "#/definitions/NodeState" } }, "title" : "NspNode", "description" : "Augmentation for NSP node" }, "NspNodeWithNetwork" : { "type" : "object", "properties" : { "networkId" : { "type" : "string", "description" : "The ID of the network which this node belongs to" }, "nodeData" : { "description" : "Node data", "$ref" : "#/definitions/NodeData" } }, "title" : "NspNodeWithNetwork", "description" : "Augmentation for NSP node" }, "NspOpticsExplicitRoute" : { "type" : "object", "properties" : { "asNumber" : { "type" : "integer", "format" : "int32", "description" : "AS number" }, "interfaceId" : { "type" : "integer", "format" : "int64", "description" : "The interface identifier" }, "linkId" : { "type" : "string", "description" : "The identifier for the link." }, "linkLoose" : { "type" : "boolean", "description" : "Specifies if this contraint is strict or loose." }, "regenInterfaceIds" : { "type" : "array", "description" : "The regen interface identifiers", "items" : { "type" : "string" } }, "regenLoose" : { "type" : "boolean", "description" : "Specifies if this constraint is strict or loose" }, "regenRouterId" : { "description" : "A router-id address", "$ref" : "#/definitions/Ipv4Address" }, "routerId" : { "description" : "A router-id address", "$ref" : "#/definitions/IpAddress" }, "srlgLoose" : { "type" : "boolean", "description" : "Specifies if this constraint is strict or loose" }, "srlgs" : { "type" : "array", "description" : "The srlg value", "items" : { "type" : "integer", "format" : "int64" } }, "v4Address" : { "description" : "An IPv4 address. This address is treated as a prefix based on the prefix length value below. Bits beyond the prefix are ignored on receipt and SHOULD be set to zero on transmission.", "$ref" : "#/definitions/Ipv4Address" }, "v4Loose" : { "type" : "boolean", "description" : "Describes whether the object is loose if set, or otherwise strict" }, "v4PrefixLength" : { "type" : "integer", "format" : "int32", "description" : "Length in bits of the IPv4 prefix" }, "v6Address" : { "description" : "An IPv6 address. This address is treated as a prefix based on the prefix length value below. Bits beyond the prefix are ignored on receipt and SHOULD be set to zero on transmission.", "$ref" : "#/definitions/Ipv6Address" }, "v6Loose" : { "type" : "boolean", "description" : "Describes whether the object is loose if set, or otherwise strict" }, "v6PrefixLength" : { "type" : "integer", "format" : "int32", "description" : "Length in bits of the IPv4 prefix" }, "value" : { "type" : "integer", "format" : "int64", "description" : "the label value" } }, "title" : "NspOpticsExplicitRoute", "description" : "The explicit route object for Optical services" }, "NspTerminationPoint" : { "type" : "object", "properties" : { "terminationPointConfig" : { "description" : "Configuration data", "$ref" : "#/definitions/TerminationPointConfig" }, "terminationPointState" : { "description" : "Operational state data", "$ref" : "#/definitions/TerminationPointState" } }, "title" : "NspTerminationPoint", "description" : "Augmentation for NSP termination point" }, "OchServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "restoration" : { "type" : "string", "description" : "Specifies the recovery technique of a path after failure.", "enum" : [ "SBR", "GR", "None" ] }, "reversionMode" : { "type" : "string", "description" : "Specifies how the path switches from the recovery to the the working path previously under failure condition.", "enum" : [ "softauto", "auto", "manual" ] } }, "title" : "OchServiceCreationTemplate", "description" : "This template is used during OCH service creation" }, "OduServiceCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "bandwidth" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for ODU creation" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "The maximum cost. The value must be greater than or equal to 0." }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "The maximum hops. The value must be greater than or equal to 0." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "The maximum latency. The value must be greater than or equal to 0." }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values.", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "reverseBandwidth" : { "type" : "integer", "format" : "int64", "description" : "Specifies the reverse bandwidth required for ODU creation" } }, "title" : "OduServiceCreationTemplate", "description" : "This template is used during ODU service creation" }, "OpenflowAction" : { "type" : "object", "properties" : { "actionType" : { "type" : "string", "description" : "Type of the action", "enum" : [ "OUT_PORT", "EXPERIMENTER", "SET_FIELD" ] }, "experimenterActionType" : { "type" : "string", "description" : "Type of the experimenter action. Applicable only for experimenter actions", "enum" : [ "REDIRECT_TO_NEXTHOP", "REDIRECT_TO_SVCT" ] }, "ipAddress" : { "description" : "Next Hop IP address", "$ref" : "#/definitions/IpAddress" }, "isIndirect" : { "type" : "boolean", "description" : "Set the value for indirect hop" }, "outerVlanId" : { "type" : "integer", "format" : "int64", "description" : "Outer QinQ tag VlanId" }, "portId" : { "type" : "integer", "format" : "int64", "description" : "Openflow switch output port id" }, "sdpId" : { "type" : "integer", "format" : "int64", "description" : "SDP id" }, "vcId" : { "type" : "integer", "format" : "int64", "description" : "Virtual circuit id" }, "vlanId" : { "type" : "integer", "format" : "int64", "description" : "Dot1Q tag or inner QinQ tag VlanId" } }, "title" : "OpenflowAction", "description" : "Openflow action" }, "OpenflowFlowEntry" : { "type" : "object", "required" : [ "applicationGroupId", "applicationId", "auditstate", "cookie", "datapathId", "flowId", "lifecycle", "priority", "tableId" ], "properties" : { "applicationGroupId" : { "type" : "integer", "format" : "int64", "description" : "The identification of the application group, used by the application to categorize this flow" }, "applicationId" : { "type" : "integer", "format" : "int32", "description" : "The identification of the application which deployed the flow, negative numbers are reserved and should not be used" }, "auditstate" : { "type" : "string", "description" : "The audit state of the flow", "enum" : [ "SUCCESS", "NOT_DONE", "FAILURE" ] }, "cookie" : { "type" : "string", "description" : "The hexadecimal controller issued identifier for this flow" }, "datapathId" : { "type" : "string", "description" : "The hexadecimal openflow data-path id for this switch" }, "flowId" : { "type" : "string", "description" : "The unique identifier of the flow, this is auto generated on the server" }, "lifecycle" : { "type" : "string", "description" : "The lifecycle of the flow", "enum" : [ "PENDING_DELETE", "NO_ACTION", "DEPLOYED", "PENDING_SYNC", "DELETED", "PENDING_CREATE", "PENDING_MODIFICATION" ] }, "openflowInstruction" : { "description" : "The instruction to be performed on the flow", "$ref" : "#/definitions/OpenflowInstruction" }, "openflowMatch" : { "description" : "The match criteria for this flow", "$ref" : "#/definitions/OpenflowMatch" }, "priority" : { "type" : "integer", "format" : "int64", "description" : "The priority of the flow" }, "tableId" : { "type" : "integer", "format" : "int64", "description" : "The table id number within the switch" } }, "title" : "OpenflowFlowEntry", "description" : "Openflow flow entry" }, "OpenflowFlowEntryRequest" : { "type" : "object", "required" : [ "applicationId", "cookie", "datapathId", "priority", "tableId" ], "properties" : { "applicationGroupId" : { "type" : "integer", "format" : "int64", "description" : "The identification of the application group, used by the application to categorize this flow" }, "applicationId" : { "type" : "integer", "format" : "int32", "description" : "The identification of the application which deployed the flow, negative numbers are reserved and should not be used" }, "cookie" : { "type" : "string", "description" : "The hexadecimal controller issued identifier for this flow" }, "datapathId" : { "type" : "string", "description" : "The hexadecimal openflow data-path id for this switch" }, "openflowInstruction" : { "description" : "The instruction to be performed on the flow", "$ref" : "#/definitions/OpenflowInstruction" }, "openflowMatch" : { "description" : "The match criteria for this flow", "$ref" : "#/definitions/OpenflowMatch" }, "priority" : { "type" : "integer", "format" : "int64", "description" : "The priority of the flow" }, "tableId" : { "type" : "integer", "format" : "int64", "description" : "The table id number within the switch" } }, "title" : "OpenflowFlowEntryRequest", "description" : "Flows to be created" }, "OpenflowFlowSearch" : { "type" : "object", "required" : [ "datapathId" ], "properties" : { "applicationGroupId" : { "type" : "integer", "format" : "int64", "description" : "The identification of the application group, used by the application to categorize this flow" }, "applicationId" : { "type" : "integer", "format" : "int32", "description" : "The identification number of the application which deployed the flow" }, "cookie" : { "type" : "string", "description" : "The hexadecimal identifier or its prefix for the flow" }, "datapathId" : { "type" : "string", "description" : "The hexadecimal openflow data-path id for this switch" }, "headerOnly" : { "type" : "boolean", "description" : "To control whether to fetch only flow headers or complete flow details" }, "openflowMatch" : { "description" : "The match criteria for this flow", "$ref" : "#/definitions/OpenflowMatch" }, "priority" : { "type" : "integer", "format" : "int64", "description" : "The priority of the flow" }, "tableId" : { "type" : "integer", "format" : "int64", "description" : "The table id number within the switch" } }, "title" : "OpenflowFlowSearch", "description" : "Search criteria" }, "OpenflowFlowSearchById" : { "type" : "object", "properties" : { "flowIds" : { "type" : "array", "description" : "List of flows' unique identifers", "items" : { "type" : "string" } } }, "title" : "OpenflowFlowSearchById", "description" : "The unique identifiers of the flows to find" }, "OpenflowFlowUpdateEntry" : { "type" : "object", "properties" : { "flowIds" : { "type" : "array", "description" : "The unique identifiers of the flows for which the Instruction needs to be modified.", "items" : { "type" : "string" } }, "openflowInstruction" : { "description" : "The instruction to be updated on the flow", "$ref" : "#/definitions/OpenflowInstruction" } }, "title" : "OpenflowFlowUpdateEntry", "description" : "Openflow flow instruction update" }, "OpenflowInstruction" : { "type" : "object", "properties" : { "actions" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpenflowAction" } }, "instructionType" : { "type" : "string", "description" : "Type of the instruction", "enum" : [ "CLEAR_ACTIONS", "APPLY_ACTIONS", "WRITE_ACTIONS" ] } }, "title" : "OpenflowInstruction", "description" : "The instruction to be performed on the flow" }, "OpenflowMatch" : { "type" : "object", "properties" : { "destIpAddress" : { "description" : "Destination IP address/mask", "$ref" : "#/definitions/IpPrefix" }, "destPort" : { "type" : "integer", "format" : "int64", "description" : "Destination (TCP or UDP) port number" }, "dscp" : { "description" : "The dscp type represents a Differentiated Services Code-Point that may be used for marking packets in a traffic stream", "$ref" : "#/definitions/Dscp" }, "ethernetType" : { "type" : "string", "description" : "Ethernet Type in hexadecimal (for example 0x800 for IPv4)" }, "inPort" : { "type" : "integer", "format" : "int64", "description" : "Input port number" }, "ipProtocolType" : { "type" : "integer", "format" : "int32", "description" : "IP Protocol Type (for example 6 for TCP or 17 for UDP)" }, "outerVlanId" : { "type" : "integer", "format" : "int64", "description" : "Experimenter outer VlanId" }, "sourceIpAddress" : { "description" : "Source IP address/mask", "$ref" : "#/definitions/IpPrefix" }, "sourcePort" : { "type" : "integer", "format" : "int64", "description" : "Source (TCP or UDP) port number" }, "vlanId" : { "type" : "integer", "format" : "int64", "description" : "Dot1Q tag or inner QinQ tag VlanId" } }, "title" : "OpenflowMatch", "description" : "The match criteria for this flow" }, "OpenflowPort" : { "type" : "object", "required" : [ "datapathId", "hardwareAddress", "portId", "portName" ], "properties" : { "datapathId" : { "type" : "string", "description" : "The hexadecimal openflow data-path id for this switch" }, "hardwareAddress" : { "type" : "string", "description" : "The hardware address of the port" }, "portId" : { "type" : "integer", "format" : "int64", "description" : "The port id which identifies the port" }, "portName" : { "type" : "string", "description" : "The name of the port" } }, "title" : "OpenflowPort", "description" : "Openflow port" }, "OpenflowSwitch" : { "type" : "object", "required" : [ "datapathId", "dpDescription", "hwDescription", "maxTables", "mfgDescription", "numberOfBuffers", "openflowVersion", "serialNumber", "status", "swDescription", "switchAddress", "vendorType" ], "properties" : { "datapathId" : { "type" : "string", "description" : "The hexadecimal openflow data-path id for this switch" }, "dpDescription" : { "type" : "string", "description" : "Datapath description" }, "hwDescription" : { "type" : "string", "description" : "Hardware description" }, "maxTables" : { "type" : "integer", "format" : "int64", "description" : "Maximum number of tables supported on this switch" }, "mfgDescription" : { "type" : "string", "description" : "Manufacturer description" }, "numberOfBuffers" : { "type" : "integer", "format" : "int64", "description" : "Maximum number of buffers supported on this switch" }, "openflowVersion" : { "type" : "string", "description" : "The openflow protocol version for this switch", "enum" : [ "V140", "V150", "V10", "V200", "V131", "V130" ] }, "serialNumber" : { "type" : "string", "description" : "Serial number of this switch" }, "status" : { "type" : "string", "description" : "Status of this switch", "enum" : [ "DOWN", "ACTIVE", "UNKNOWN" ] }, "swDescription" : { "type" : "string", "description" : "Software description" }, "switchAddress" : { "description" : "The ip address of this switch", "$ref" : "#/definitions/IpAddress" }, "vendorType" : { "type" : "string", "description" : "Vendor of this switch", "enum" : [ "OTHER", "NOKIA", "ALCATEL" ] } }, "title" : "OpenflowSwitch", "description" : "Openflow switch information" }, "OpenflowTable" : { "type" : "object", "required" : [ "datapathId", "maxEntries", "tableId" ], "properties" : { "datapathId" : { "type" : "string", "description" : "The hexadecimal openflow data-path id for this switch" }, "maxEntries" : { "type" : "integer", "format" : "int64", "description" : "The number of entries the table supports" }, "tableId" : { "type" : "integer", "format" : "int64", "description" : "The table id number within the switch" } }, "title" : "OpenflowTable", "description" : "Openflow table" }, "OpticalConnectivityConstraintTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "connectivityConstraint" : { "description" : "Connectivity service generic parameters", "$ref" : "#/definitions/ConnectivityConstraint" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" } }, "title" : "OpticalConnectivityConstraintTemplate", "description" : "Optical connectivity constraint template" }, "OpticalConnectivityServiceTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "connectivityConstraintTemplateId" : { "type" : "string", "description" : "Connectivity constraint template id" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "resilienceConstraintTemplateIds" : { "type" : "array", "description" : "Resilience constraint template ids", "items" : { "type" : "string" } }, "routingConstraintTemplateId" : { "type" : "string", "description" : "Routing constraint template id" } }, "title" : "OpticalConnectivityServiceTemplate", "description" : "Optical connectivity service template" }, "OpticalDateAndTime" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "OpticalDateAndTime", "description" : "This primitive type defines the date and time according to the following structure: yyyyMMddhhmmss.s[Z|{+|-}HHMm] where: yyyy 0000..9999 year MM 01..12 month dd 01..31 day hh 00..23 hour mm 00..59 minute ss 00..59 second s .0...9 tenth of second (set to .0 if EMS or NE cannot support this granularity) Z Z indicates UTC (rather than local time) {+|-} + or - delta from UTC HH 00..23 time zone difference in hours Mm 00..59 time zone difference in minutes." }, "OpticalResilienceConstraintTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "resilienceConstraint" : { "description" : "Resilience constraints", "$ref" : "#/definitions/ResilienceConstraint" } }, "title" : "OpticalResilienceConstraintTemplate", "description" : "Optical resilience constraint template" }, "OpticalRoutingConstraintTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "routingConstraint" : { "description" : "Routing constraints", "$ref" : "#/definitions/RoutingConstraint" } }, "title" : "OpticalRoutingConstraintTemplate", "description" : "Optical routing constraint template" }, "Optics" : { "type" : "object", "properties" : { "protectionType" : { "type" : "string", "description" : "Specifies the protection type of the port", "enum" : [ "working", "protection" ] } }, "title" : "Optics", "description" : "Contains Optical related configuration" }, "OpticsRequest" : { "type" : "object", "required" : [ "bidirectional", "name", "objective" ], "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4), 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062500 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "destinationTimeslot" : { "type" : "string", "description" : "Applies timeslots to the port represented in a comma seperated value" }, "destinations" : { "type" : "array", "description" : "A list of destination service endpoints", "items" : { "type" : "string" } }, "encryption" : { "type" : "boolean", "description" : "Specifies whether the service should be encrypted or not. The service will be rejected if no path can be found which does not support encryption." }, "excludeRouteObject" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspOpticsExplicitRoute" } }, "facility" : { "type" : "integer", "format" : "int32", "description" : "Specifies the port facility number to be used for the OCH service. The value can be 1, or 2 for 260SCX2 L port in 200G mode" }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "includeRouteObject" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspOpticsExplicitRoute" } }, "lambda" : { "type" : "number", "format" : "double", "description" : "Unsupported - Specifies the lambda to be used for the service" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "modulation" : { "type" : "string", "description" : "Specifies the modulation scheme for the optical signal", "enum" : [ "SYSTEM_ASSIGNED", "MOD_SP_QPSK", "MOD_QPSK", "MOD_8QAM", "MOD_16QAM", "MOD_BPSK" ] }, "name" : { "type" : "string", "description" : "Specifies the name of the service" }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services." }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "phaseEncoding" : { "type" : "string", "description" : "Specifies the encoding type of the optical signal", "enum" : [ "system_assigned", "absolute", "differential" ] }, "protection" : { "type" : "boolean", "description" : "Unsupported - Specifies whether a protection path should be created" }, "protectionExcludeRouteObject" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspOpticsExplicitRoute" } }, "protectionIncludeRouteObject" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspOpticsExplicitRoute" } }, "protectionType" : { "type" : "string", "description" : "Specifies the provisioned protection type of the connection. Only UNPROTECTED/OPSB/YCABLE are supported for ODU service and UNPROTECTED/OPSA are supported for OCH service.", "enum" : [ "SERVER_PROTECTED", "SNC_N", "SNC_N_SERVER_PROTECTED", "SNCP_N_SERVER_PROTECTED", "SNC_I", "OPSA", "YCABLE", "SNCP", "NA", "OPSB", "UNPROTECTED", "SNCP_N", "PROTECTED", "SNC_I_SERVER_PROTECTED", "OMSP" ] }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "regeneration" : { "type" : "boolean", "description" : "Specifies whether the service is permitted over a network element which performs optical regeneration" }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "restoration" : { "type" : "string", "description" : "Specifies the recovery technique of a path after failure.", "enum" : [ "SBR", "GR", "None" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "reversionMode" : { "type" : "string", "description" : "Specifies how the path switches from the recovery to the the working path previously under failure condition.", "enum" : [ "softauto", "auto", "manual" ] }, "servicePlaneType" : { "type" : "string", "description" : "Specifies whether the service is Control Plane or Management Plane.", "enum" : [ "controlPlane", "mixedPlane", "mrn", "managementPlane" ] }, "sourceTimeslot" : { "type" : "string", "description" : "Applies timeslots to the port represented in a comma seperated value" }, "sources" : { "type" : "array", "description" : "A list of source service endpoints", "items" : { "type" : "string" } }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template." }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "waveshape" : { "type" : "string", "description" : "Specifies the shape of the optical signal to be used", "enum" : [ "single", "_super", "system_assigned", "alien" ] }, "workflowProfileId" : { "type" : "string", "description" : "Specifies the Workflow Profile to used for this service" } }, "title" : "OpticsRequest", "description" : "The normalized Optical service request. This object is used to create and modify service entities in the network." }, "OuterTag" : { "type" : "object", "properties" : { "vlanWrite" : { "description" : "A grouping which represents push/pop operations of an 802.1Q VLAN tag.", "$ref" : "#/definitions/VlanWrite" } }, "title" : "OuterTag", "description" : "The outermost VLAN tag to push/swap." }, "Ownership" : { "type" : "object", "properties" : { "consumable" : { "type" : "boolean", "description" : "Whether the system is able to consume this resource" }, "deletable" : { "type" : "boolean", "description" : "Whether the system is able to delete this resource automatically due to a change at a higher or lower layer" }, "modifiable" : { "type" : "boolean", "description" : "Whether the system is able to modify this resource automatically due to a change at a higher or lower layer" } }, "title" : "Ownership" }, "OwnershipState" : { "type" : "object", "properties" : { "ownership" : { "$ref" : "#/definitions/Ownership" } }, "title" : "OwnershipState", "description" : "Path ownership state" }, "ParamsConfig" : { "type" : "object", "properties" : { "pathParams" : { "description" : "LSP path parameters", "$ref" : "#/definitions/PathParams" } }, "title" : "ParamsConfig", "description" : "Path parameters configuration" }, "ParamsState" : { "type" : "object", "properties" : { "pathParams" : { "description" : "LSP path parameters", "$ref" : "#/definitions/PathParams" } }, "title" : "ParamsState", "description" : "Path parameters state" }, "PathHop" : { "type" : "object", "properties" : { "hopId" : { "type" : "integer", "format" : "int32", "description" : "Path hop identifier" }, "hopIndex" : { "type" : "integer", "format" : "int32", "description" : "Path hop index. A counter denoting hop order" }, "hopLinkId" : { "type" : "string", "description" : "ID: Unique identifier of the topology link" }, "hopType" : { "type" : "string", "description" : "Path hop type denoting hop restriction", "enum" : [ "STRICT", "LOOSE", "UNKNOWN" ] }, "ifLinkIndex" : { "type" : "integer", "format" : "int32", "description" : "Path hop link interface index. This value used as local link identifier for unnumbered interface" }, "ipAddress" : { "description" : "Path hop IP address", "$ref" : "#/definitions/IpAddress" }, "postProcessedSourceId" : { "description" : "Path hop source router id", "$ref" : "#/definitions/TeNodeId" }, "postProcessedSourceInterface" : { "description" : "Path hop source interface identifier", "$ref" : "#/definitions/IpAddress" }, "postProcessedSourceTp" : { "type" : "string", "description" : "Path hop source router termination point" }, "routerId" : { "description" : "Path hop router identifier", "$ref" : "#/definitions/TeNodeId" }, "segmentLabel" : { "type" : "integer", "format" : "int64", "description" : "Path hop segment routing label. Segment Identifier (SID)" }, "segmentRouteType" : { "type" : "string", "description" : "Segment route type", "enum" : [ "NODEIPV4", "NODEIPV6", "ADJIPV6", "ADJUNUMIPV4", "ADJIPV4" ] }, "sidHopType" : { "type" : "string", "description" : "SID Hop Type. This value is determined after post-processing the hops in the LSP. For original signalling type see Segment Route Type attribute.", "enum" : [ "ANYCAST_NODE", "NODE", "ADJSET", "ADJSID" ] } }, "title" : "PathHop" }, "PathHops" : { "type" : "object", "properties" : { "pathHop" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/PathHop" } } }, "title" : "PathHops", "description" : "LSP path hops" }, "PathParams" : { "type" : "object", "properties" : { "adminGroupExcludeAny" : { "description" : "all of the admin group must be absent.", "$ref" : "#/definitions/AdminGroups" }, "adminGroupIncludeAll" : { "description" : "All of the admin groups must be present.", "$ref" : "#/definitions/AdminGroups" }, "adminGroupIncludeAny" : { "description" : "One or more of the admin groups must be present.", "$ref" : "#/definitions/AdminGroups" }, "bandwidth" : { "type" : "integer", "description" : "Path bandwidth capacity. Units in Kbps" }, "maxCost" : { "type" : "integer", "format" : "int64", "description" : "Path maximum cost constraint" }, "maxHops" : { "type" : "integer", "format" : "int64", "description" : "Path maximum hops constraint. 0 and 255 means no limit." }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Path maximum latency constraint" }, "maxTeMetric" : { "type" : "integer", "format" : "int64", "description" : "Path maximum TE metric constraint" }, "msd" : { "type" : "integer", "format" : "int64", "description" : "Path maximum SID depth. 0 means no MSD." }, "objective" : { "type" : "string", "description" : "Path metric objective", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "pathProfile" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/PathProfile" } }, "pathProfileOverride" : { "description" : "Path computation profile override", "$ref" : "#/definitions/PathProfileOverride" }, "setupPriority" : { "type" : "integer", "format" : "int32", "description" : "Path setup priority from 0 to 7. Value 0 is the highest priority" }, "templateId" : { "type" : "integer", "format" : "int64", "description" : "MPLS path template ID (PCE Initiated only)" } }, "title" : "PathParams", "description" : "LSP path parameters" }, "PathProfile" : { "type" : "object", "properties" : { "extendedId" : { "type" : "integer", "format" : "int64", "description" : "Path extended identifier. An identifier for profile association/grouping" }, "profileId" : { "type" : "integer", "format" : "int64", "description" : "Path profile identifier. An identifier of a predefined profile. 0 means no path profile assigned." }, "profileIndex" : { "type" : "integer", "format" : "int32", "description" : "Path profile index. A counter denoting profile order" } }, "title" : "PathProfile" }, "PathProfileOverride" : { "type" : "object", "properties" : { "extendedId" : { "type" : "integer", "format" : "int64", "description" : "Path extended identifier. An identifier for profile association/grouping" }, "profileGroupOverrideState" : { "type" : "string", "description" : "Profile group override state", "enum" : [ "ACTIVE_TRANSIT", "ACTIVE", "FAILED", "NOT_CONFIGURED", "NOT_ATTEMPTED" ] }, "profileId" : { "type" : "integer", "format" : "int64", "description" : "Path profile identifier. An identifier of a predefined profile. 0 means no path profile assigned. -1 deletes the path profile override." } }, "title" : "PathProfileOverride", "description" : "Path computation profile override" }, "PathProfileTemplate" : { "type" : "object", "required" : [ "name", "profileId" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "bandwidthStrategy" : { "type" : "string", "description" : "The strategy to use for LSP bandwidth in the path computation", "enum" : [ "TELEMETRY", "STANDARD" ] }, "bidirection" : { "type" : "string", "description" : "The Bidirectional Mode to be used in path computation", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bwSplitMonitoringTime" : { "type" : "integer", "format" : "int32", "description" : "Time in seconds to watch measured bandwidth before sending LSP split trigger" }, "bwSplitSupported" : { "type" : "boolean", "description" : "Indicates if LSP split is allowed if measured bw exceeds a given threshold" }, "bwSplitThreshold" : { "type" : "integer", "description" : "LSP bandwidth split threshold value(in kbps). If the measured bandwidth of LSP is above bwSplitThreshold value then a trigger will be sent to notify that an additional LSP should be created between the same source and destination if bwSplitSupported is set to true" }, "bwSplitWorkflowName" : { "type" : "string", "description" : "The name of workflow for LSP bandwidth split" }, "controlRerouteStrategy" : { "type" : "string", "description" : "The strategy to use when recomputing the path", "enum" : [ "STRICT", "LOOSE", "STANDARD" ] }, "disjoint" : { "type" : "string", "description" : "The Disjoint Mode to be used in path computation", "enum" : [ "NO", "NODE_STRICT_AND_SRLG", "NODE_STRICT", "LINK_LOOSE", "LINK_STRICT_AND_SRLG", "NODE_LOOSE", "SRLG", "LINK_STRICT" ] }, "excludeRouteObjects" : { "type" : "array", "description" : "The hops to be excluded from the path", "items" : { "$ref" : "#/definitions/IpAddress" } }, "explicitRouteStrategy" : { "type" : "string", "description" : "The strategy to use when computing the explicit route objects", "enum" : [ "ECMP", "STANDARD_BSID_PREFERRED", "LOOSE_HOP", "COMPRESSED", "STANDARD", "LOOSE_HOP_ANYCAST_PREFERRED", "LOOSE_HOP_BSID_PREFERRED" ] }, "explicitRouteStrategyEcmpPreference" : { "type" : "string", "description" : "Only applicable to Explicit Route Strategy with a value of ECMP. Determines the preference of SID selection when calculating an ECMP ERO", "enum" : [ "ADJACENCY_SID", "NODE_SID" ] }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "includeRouteObjects" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/IroHop" } }, "latencyThreshold" : { "type" : "number", "format" : "double", "description" : "Specifies the latency threshold (in microseconds) that when exceeded, a resignal path calculation will be triggered to attempt to find a better path. If resignal cannot find a path with latency lower than or equal to this threshold, an alarm will be raised. If it is not set, the default value is -1, which means no resignal will be triggered due to latency, and no alarm will be raised. If it is set to zero, resignal path calcuation will be triggered when latency increases, but no alarm will be raised" }, "maxCost" : { "type" : "integer", "format" : "int64", "description" : "The Max Cost constraint to be used in path computation" }, "maxHops" : { "type" : "integer", "format" : "int64", "description" : "The Max Hops constraint to be used in path computation" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in microseconds) to consider for the path calculation" }, "maxTeMetric" : { "type" : "integer", "format" : "int64", "description" : "The Max TE Metric constraint to be used in the path computation" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "objective" : { "type" : "string", "description" : "The Metric Objective to be used in path computation", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "profileId" : { "type" : "integer", "format" : "int64", "description" : "The Profile ID of the paths to be included in path computation. NOTE: A profile with Profile ID = 0 is a global default profile that applies to ALL paths that have NO specified Profile ID. The global default profile does NOT support BiDirectional or Disjoint properties" }, "sidProtectionStrategy" : { "type" : "string", "description" : "The strategy to use when computing a path in regards to segment ID protection", "enum" : [ "UNPROTECTED_PREFERRED", "UNPROTECTED_ONLY", "STANDARD", "PROTECTED_ONLY" ] } }, "title" : "PathProfileTemplate", "description" : "The path profile template controls computation parameters for creating paths in the network" }, "PathSearchRequest" : { "type" : "object", "required" : [ "uuid" ], "properties" : { "destination" : { "description" : "The destination service endpoint of the path", "$ref" : "#/definitions/Destination" }, "erpInstance" : { "type" : "integer", "format" : "int64", "description" : "The Instance number of ERP " }, "minBandwidth" : { "type" : "integer", "format" : "int64", "description" : "The minimum bandwidth to maintain for the service" }, "source" : { "description" : "The source service endpoint of the path", "$ref" : "#/definitions/Source" }, "uuid" : { "type" : "string", "description" : "The UUID of the service " }, "vlanId" : { "description" : "vlan-id of the service", "$ref" : "#/definitions/Vlanid" } }, "title" : "PathSearchRequest", "description" : "The path calculation request definition" }, "PerformanceMetric" : { "type" : "object", "properties" : { "measurement" : { "description" : "Measured performance metric values. Static configuration and manual overrides of these measurements are also allowed.", "$ref" : "#/definitions/Measurement" }, "normality" : { "description" : "Performance metric normality values.", "$ref" : "#/definitions/Normality" }, "tePerformanceMetric" : { "$ref" : "#/definitions/TePerformanceMetric" } }, "title" : "PerformanceMetric", "description" : "Link performance information in real time." }, "PerformanceMetricAttributes" : { "type" : "object", "properties" : { "unidirectionalAvailableBandwidth" : { "type" : "number", "format" : "double", "description" : "Available bandwidth that is defined to be residual bandwidth minus the measured bandwidth used for the actual forwarding of non-RSVP-TE LSP packets. For a bundled link, available bandwidth is defined to be the sum of the component link available bandwidths." }, "unidirectionalDelay" : { "type" : "integer", "format" : "int64", "description" : "Delay or latency in micro seconds." }, "unidirectionalDelayVariation" : { "type" : "integer", "format" : "int64", "description" : "Delay variation in micro seconds." }, "unidirectionalMaxDelay" : { "type" : "integer", "format" : "int64", "description" : "Maximum delay or latency in micro seconds." }, "unidirectionalMinDelay" : { "type" : "integer", "format" : "int64", "description" : "Minimum delay or latency in micro seconds." }, "unidirectionalPacketLoss" : { "type" : "number", "format" : "double", "description" : "Packet loss as a percentage of the total traffic sent over a configurable interval. The finest precision is 0.000003%." }, "unidirectionalResidualBandwidth" : { "type" : "number", "format" : "double", "description" : "Residual bandwidth that subtracts tunnel reservations from Maximum Bandwidth (or link capacity) [RFC3630] and provides an aggregated remainder across QoS classes." }, "unidirectionalUtilizedBandwidth" : { "type" : "number", "format" : "double", "description" : "Bandwidth utilization that represents the actual utilization of the link (i.e. as measured in the router). For a bundled link, bandwidth utilization is defined to be the sum of the component link bandwidth utilizations." } }, "title" : "PerformanceMetricAttributes", "description" : "Link performance information in real time." }, "PerformanceMetricNormalityAttributes" : { "type" : "object", "properties" : { "unidirectionalAvailableBandwidth" : { "type" : "string", "description" : "Available bandwidth normality.", "enum" : [ "normal", "abnormal", "unknown" ] }, "unidirectionalDelay" : { "type" : "string", "description" : "Delay normality.", "enum" : [ "normal", "abnormal", "unknown" ] }, "unidirectionalDelayVariation" : { "type" : "string", "description" : "Delay variation normality.", "enum" : [ "normal", "abnormal", "unknown" ] }, "unidirectionalMaxDelay" : { "type" : "string", "description" : "Maximum delay or latency normality.", "enum" : [ "normal", "abnormal", "unknown" ] }, "unidirectionalMinDelay" : { "type" : "string", "description" : "Minimum delay or latency normality.", "enum" : [ "normal", "abnormal", "unknown" ] }, "unidirectionalPacketLoss" : { "type" : "string", "description" : "Packet loss normality.", "enum" : [ "normal", "abnormal", "unknown" ] }, "unidirectionalResidualBandwidth" : { "type" : "string", "description" : "Residual bandwidth normality.", "enum" : [ "normal", "abnormal", "unknown" ] }, "unidirectionalUtilizedBandwidth" : { "type" : "string", "description" : "Bandwidth utilization normality.", "enum" : [ "normal", "abnormal", "unknown" ] } }, "title" : "PerformanceMetricNormalityAttributes", "description" : "Link performance metric normality attributes." }, "PerformanceMetricThrottle" : { "type" : "object", "properties" : { "advertisementInterval" : { "type" : "integer", "format" : "int64", "description" : "Interval in seconds to advertise the extended metric values." }, "measureInterval" : { "type" : "integer", "format" : "int64", "description" : "Interval in seconds to measure the extended metric values." }, "suppressionInterval" : { "type" : "integer", "format" : "int64", "description" : "Interval in seconds to suppress advertising the extended metric values." }, "tePerformanceMetric" : { "$ref" : "#/definitions/TePerformanceMetric" }, "thresholdAcceleratedAdvertisement" : { "description" : "When the difference between the last advertised value and current measured value exceed this threshold, anomalous announcement will be triggered.", "$ref" : "#/definitions/ThresholdAcceleratedAdvertisement" }, "thresholdIn" : { "description" : "If the measured parameter falls inside an upper bound for all but the min delay metric (or lower bound for min-delay metric only) and the advertised value is not already inside that bound, normal (anomalous-flag cleared) announcement will be triggered.", "$ref" : "#/definitions/ThresholdIn" }, "thresholdOut" : { "description" : "If the measured parameter falls outside an upper bound for all but the min delay metric (or lower bound for min-delay metric only) and the advertised value is not already outside that bound, anomalous announcement will be triggered.", "$ref" : "#/definitions/ThresholdOut" }, "unidirectionalDelayOffset" : { "type" : "integer", "format" : "int64", "description" : "Offset value to be added to the measured delay value." } }, "title" : "PerformanceMetricThrottle", "description" : "Link performance information in real time." }, "PerformanceMetricThrottleContainer" : { "type" : "object", "properties" : { "performanceMetricThrottle" : { "description" : "Link performance information in real time.", "$ref" : "#/definitions/PerformanceMetricThrottle" } }, "title" : "PerformanceMetricThrottleContainer", "description" : "A container controlling performance metric throttle." }, "PhysicalLink" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "bidirectional" : { "type" : "boolean", "description" : "The direction of the physical link is either BIDIRECTIONAL or UNIDIRECTIONAL" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "destinationId" : { "type" : "string", "description" : "The id of the destination network element" }, "destinationName" : { "type" : "string", "description" : "The name of the destination network element" }, "destinationPortId" : { "type" : "string", "description" : "The id of the destination NNI port" }, "destinationPortName" : { "type" : "string", "description" : "The name of the destination NNI port" }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "linkCost" : { "$ref" : "#/definitions/LinkCost" }, "lxcontainer" : { "$ref" : "#/definitions/LXContainer" }, "lxpresent" : { "type" : "boolean", "description" : "If there is a presence of an 1830 LX" }, "name" : { "type" : "string", "description" : "The name of the physical link" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "sourceId" : { "type" : "string", "description" : "The id of the source network element" }, "sourceName" : { "type" : "string", "description" : "The name of the source network element" }, "sourcePortId" : { "type" : "string", "description" : "The id of the source NNI port" }, "sourcePortName" : { "type" : "string", "description" : "The name of the source NNI port" }, "srlgs" : { "type" : "array", "items" : { "type" : "string" } } }, "title" : "PhysicalLink", "description" : "A physical link represents a link connecting different network elements." }, "Platform" : { "type" : "object", "properties" : { "machine" : { "type" : "string", "description" : "A vendor-specific identifier string representing the hardware in use." }, "osName" : { "type" : "string", "description" : "Unsupported - The name of the operating system in use - for example, 'Linux'." }, "osRelease" : { "type" : "string", "description" : "Unsupported - The current release level of the operating system in use. This string MAY indicate the OS source code revision." }, "osVersion" : { "type" : "string", "description" : "The current version level of the operating system in use. This string MAY indicate the specific OS build date and target variant information." } }, "title" : "Platform", "description" : "Contains vendor-specific information for identifying the system platform and operating system." }, "PolicyIdentifier" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A textual description of the identifier." }, "identifier" : { "type" : "string", "description" : "The identifier of the policy." }, "policyType" : { "type" : "string", "description" : "The type of the policy." } }, "title" : "PolicyIdentifier", "description" : "The parameters of a policy identifier" }, "Port" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "availableEgressBandwidth" : { "type" : "integer", "format" : "int64", "description" : "Specifies the available egress bandwidth associated with a port" }, "availableIngressBandwidth" : { "type" : "integer", "format" : "int64", "description" : "Specifies the available ingress bandwidth associated with a port" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "dc" : { "description" : "Contains DC related configuration", "$ref" : "#/definitions/Dc" }, "description" : { "type" : "string", "description" : "A textual description of the port." }, "ethernet" : { "description" : "Contains all Ethernet interface related configuration", "$ref" : "#/definitions/Ethernet" }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "interfaceId" : { "type" : "integer", "format" : "int64", "description" : "The id of the port/interface" }, "name" : { "type" : "string", "description" : "The name of the port" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "neId" : { "type" : "string", "description" : "The router entity where the port resides" }, "neName" : { "type" : "string", "description" : "The name of the network equipment to which this endpoint belongs" }, "nspDbFdn" : { "type" : "string", "description" : "FDN of the port in the NSP DB" }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "optics" : { "description" : "Contains Optical related configuration", "$ref" : "#/definitions/Optics" }, "portCapability" : { "description" : "Specifies the capabilities on this port", "$ref" : "#/definitions/PortCapabilityType" }, "portSpeed" : { "type" : "integer", "format" : "int64", "description" : "The interface speed of the port" }, "portType" : { "type" : "string", "description" : "The type of port. Supported values are defined in RFC7224" }, "role" : { "type" : "string", "description" : "Whether the port is a UNI or NNI port", "enum" : [ "UNI", "NNI" ] }, "tdm" : { "description" : "Contains TDM DS1/E1 interface related configuration", "$ref" : "#/definitions/Tdm" } }, "title" : "Port", "description" : "The port definition. A port is a physical termination on a network element. The port is provided during a service creation. A port may belong to one or many services if the port type is Dot1Q or QinQ." }, "PortCapabilityType" : { "type" : "object", "properties" : { "cline" : { "type" : "boolean" }, "elan" : { "type" : "boolean" }, "eline" : { "type" : "boolean" }, "ies" : { "type" : "boolean" }, "l2ExtensionNni" : { "type" : "boolean" }, "l2ExtensionUni" : { "type" : "boolean" }, "l2backhaul" : { "type" : "boolean" }, "l2dci" : { "type" : "boolean" }, "l3dci" : { "type" : "boolean" }, "l3vpn" : { "type" : "boolean" }, "lag" : { "type" : "boolean" }, "och" : { "type" : "boolean" }, "odu" : { "type" : "boolean" }, "opsa" : { "type" : "boolean" }, "opsb" : { "type" : "boolean" }, "physicalLink" : { "type" : "boolean" }, "vctypeCesopsn" : { "type" : "boolean" }, "vctypeCesopsnCas" : { "type" : "boolean" }, "vctypeSatopE1" : { "type" : "boolean" }, "vctypeSatopT1" : { "type" : "boolean" }, "vctypeSatopT3" : { "type" : "boolean" }, "ycable" : { "type" : "boolean" } }, "title" : "PortCapabilityType" }, "PortFilter" : { "type" : "object", "properties" : { "condition1" : { "$ref" : "#/definitions/Condition1" }, "condition2" : { "$ref" : "#/definitions/Condition2" }, "connector" : { "type" : "string", "description" : "Specifies operator that connects filter rules" }, "groupNum" : { "type" : "integer", "format" : "int64", "description" : "Specifies the group filter element belongs to" }, "name" : { "type" : "string", "description" : "Specifies port key to filter on" }, "operator" : { "type" : "string", "description" : "Specifies operator between condition1 and condition2" } }, "title" : "PortFilter" }, "PortRequest" : { "type" : "object", "properties" : { "protectionType" : { "type" : "string", "description" : "Specifies the protection type of the port. This only applies to client optical ports.", "enum" : [ "working", "protection" ] } }, "title" : "PortRequest", "description" : "A request object used to modify Port" }, "PrefixSid" : { "type" : "object", "properties" : { "prefixSidsInfo" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/PrefixSidFlags" } } }, "title" : "PrefixSid" }, "PrefixSidFlags" : { "type" : "object", "properties" : { "explicitNullFlag" : { "type" : "boolean" }, "localFlag" : { "type" : "boolean" }, "mappingServerFlag" : { "type" : "boolean" }, "noPHPFlag" : { "type" : "boolean" }, "nodeSIDFlag" : { "type" : "boolean" }, "reAdvertisementFlag" : { "type" : "boolean" }, "valueFlag" : { "type" : "boolean" } }, "title" : "PrefixSidFlags" }, "ProvisionedHops" : { "type" : "object", "properties" : { "pathHops" : { "description" : "LSP path hops", "$ref" : "#/definitions/PathHops" } }, "title" : "ProvisionedHops", "description" : "Path provisioned hops. Include Route Objects (IRO)" }, "PushTags" : { "type" : "object", "properties" : { "outerTag" : { "description" : "The outermost VLAN tag to push/swap.", "$ref" : "#/definitions/OuterTag" }, "secondTag" : { "description" : "The second outermost VLAN tag to push/swap.", "$ref" : "#/definitions/SecondTag" } }, "title" : "PushTags", "description" : "The VLAN tags to push (or swap if used in conjunction with pop-tags)" }, "QosProfile" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "egressCosMappingTable" : { "type" : "array", "items" : { "$ref" : "#/definitions/CosMapping" } }, "egressParam" : { "description" : "Egress QoS related parameters.", "$ref" : "#/definitions/EgressParam" }, "egressPolicyList" : { "type" : "array", "description" : "The list of policy names as discovered from the network element. These policies don't need to be discovered yet.", "items" : { "type" : "string" } }, "egressQueueConfigurationTable" : { "type" : "array", "items" : { "$ref" : "#/definitions/Queue" } }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "ingressCosMappingTable" : { "type" : "array", "items" : { "$ref" : "#/definitions/CosMapping" } }, "ingressParam" : { "description" : "Ingress QoS related parameters.", "$ref" : "#/definitions/IngressParam" }, "ingressPolicyList" : { "type" : "array", "description" : "The list of policy names as discovered from the network element. These policies don't need to be discovered yet.", "items" : { "type" : "string" } }, "ingressQueueConfigurationTable" : { "type" : "array", "items" : { "$ref" : "#/definitions/Queue" } }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" } }, "title" : "QosProfile", "description" : "The Generic QoS Profile (GQP), which applies to L2 and L3 access interfaces." }, "QosTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "egressParam" : { "description" : "Egress QoS override parameters.", "$ref" : "#/definitions/EgressParam" }, "egressQueueOverride" : { "type" : "array", "items" : { "$ref" : "#/definitions/Queue" } }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "ingressParam" : { "description" : "Ingress QoS override parameters.", "$ref" : "#/definitions/IngressParam" }, "ingressQueueOverride" : { "type" : "array", "items" : { "$ref" : "#/definitions/Queue" } }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "qosProfile" : { "type" : "integer", "format" : "int64", "description" : "The ID of the default Generic QoS profile associated with the quality of service template" } }, "title" : "QosTemplate", "description" : "Qos template that defines cir & pir. Also used to template certain endpoint values" }, "Queue" : { "type" : "object", "properties" : { "cbs" : { "type" : "integer", "format" : "int64", "description" : "The Committed Burst Size in KB." }, "cir" : { "type" : "integer", "format" : "int64", "description" : "The Committed Information Rate in either Kbps or percentage (0..100). Default value, no override: set to -2; Max rate available: set to -1" }, "id" : { "type" : "integer", "format" : "int64", "description" : "ID of the queue" }, "mbs" : { "type" : "integer", "format" : "int64", "description" : "The Maximum Burst Size in KB. " }, "pir" : { "type" : "integer", "format" : "int64", "description" : "The Peak Information Rate in either Kbps or percentage (1..100). Default value, no override: set to -2; Max rate available: set to -1" }, "queueType" : { "type" : "string", "description" : "The type of the queue override. Default is Queue.", "enum" : [ "Policer", "Queue" ] }, "rateType" : { "type" : "string", "description" : "The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the queue rate will be a percentage of the port rate. Percent is not supported on Generic Qos Profiles", "enum" : [ "kbps", "percent" ] } }, "title" : "Queue", "description" : "The parameters of a queue" }, "RecordedHops" : { "type" : "object", "properties" : { "pathHops" : { "description" : "LSP path hops", "$ref" : "#/definitions/PathHops" } }, "title" : "RecordedHops", "description" : "Path recorded/actual hops. Recorded Route Objects (RRO)" }, "Recovery" : { "type" : "object", "properties" : { "protectionStatus" : { "type" : "string", "description" : "Protection status.", "enum" : [ "reversion_failed", "normal", "reversion_started", "recovery_unavailable", "recovery_admin", "recovery_succeeded", "recovery_failed", "recovery_started", "wait_to_restore" ] }, "restorationStatus" : { "type" : "string", "description" : "Restoration status.", "enum" : [ "reversion_failed", "normal", "reversion_started", "recovery_unavailable", "recovery_admin", "recovery_succeeded", "recovery_failed", "recovery_started", "wait_to_restore" ] } }, "title" : "Recovery", "description" : "Status of the recovery process." }, "Request«AugmentationMetaJsonFileName»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/AugmentationMetaJsonFileName" } }, "title" : "Request«AugmentationMetaJsonFileName»" }, "Request«AugmentationMeta»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/AugmentationMeta" } }, "title" : "Request«AugmentationMeta»" }, "Request«BackhaulL2RequestData»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/BackhaulL2RequestData" } }, "title" : "Request«BackhaulL2RequestData»" }, "Request«ClineServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ClineServiceCreationTemplate" } }, "title" : "Request«ClineServiceCreationTemplate»" }, "Request«ClineServiceRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ClineServiceRequest" } }, "title" : "Request«ClineServiceRequest»" }, "Request«CustomAttributesTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/CustomAttributesTemplate" } }, "title" : "Request«CustomAttributesTemplate»" }, "Request«EaccessRequestData»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/EaccessRequestData" } }, "title" : "Request«EaccessRequestData»" }, "Request«ElanServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ElanServiceCreationTemplate" } }, "title" : "Request«ElanServiceCreationTemplate»" }, "Request«ElineRequestData»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ElineRequestData" } }, "title" : "Request«ElineRequestData»" }, "Request«ElineServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ElineServiceCreationTemplate" } }, "title" : "Request«ElineServiceCreationTemplate»" }, "Request«ExternalId»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ExternalId" } }, "title" : "Request«ExternalId»" }, "Request«IesServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IesServiceCreationTemplate" } }, "title" : "Request«IesServiceCreationTemplate»" }, "Request«IpElanServiceRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IpElanServiceRequest" } }, "title" : "Request«IpElanServiceRequest»" }, "Request«IpIesServiceRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IpIesServiceRequest" } }, "title" : "Request«IpIesServiceRequest»" }, "Request«IpL3DciServiceRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IpL3DciServiceRequest" } }, "title" : "Request«IpL3DciServiceRequest»" }, "Request«IpL3ServiceNormalizedRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IpL3ServiceNormalizedRequest" } }, "title" : "Request«IpL3ServiceNormalizedRequest»" }, "Request«IpL3ServiceRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IpL3ServiceRequest" } }, "title" : "Request«IpL3ServiceRequest»" }, "Request«IpOpticalCorrelationPolicy»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IpOpticalCorrelationPolicy" } }, "title" : "Request«IpOpticalCorrelationPolicy»" }, "Request«L2DciVpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L2DciVpnServiceCreationTemplate" } }, "title" : "Request«L2DciVpnServiceCreationTemplate»" }, "Request«L2EndpointRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L2EndpointRequest" } }, "title" : "Request«L2EndpointRequest»" }, "Request«L2backhaulServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L2backhaulServiceCreationTemplate" } }, "title" : "Request«L2backhaulServiceCreationTemplate»" }, "Request«L3DciVpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L3DciVpnServiceCreationTemplate" } }, "title" : "Request«L3DciVpnServiceCreationTemplate»" }, "Request«L3EndpointNormalizedRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L3EndpointNormalizedRequest" } }, "title" : "Request«L3EndpointNormalizedRequest»" }, "Request«L3EndpointRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L3EndpointRequest" } }, "title" : "Request«L3EndpointRequest»" }, "Request«L3vpnRdRtPolicy»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L3vpnRdRtPolicy" } }, "title" : "Request«L3vpnRdRtPolicy»" }, "Request«L3vpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L3vpnServiceCreationTemplate" } }, "title" : "Request«L3vpnServiceCreationTemplate»" }, "Request«LagRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/LagRequest" } }, "title" : "Request«LagRequest»" }, "Request«LagServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/LagServiceCreationTemplate" } }, "title" : "Request«LagServiceCreationTemplate»" }, "Request«Latency»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Latency" } }, "title" : "Request«Latency»" }, "Request«LinkParams»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/LinkParams" } }, "title" : "Request«LinkParams»" }, "Request«List«LspPathConfigRequest»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/LspPathConfigRequest" } } }, "title" : "Request«List«LspPathConfigRequest»»" }, "Request«List«OpenflowFlowEntryRequest»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpenflowFlowEntryRequest" } } }, "title" : "Request«List«OpenflowFlowEntryRequest»»" }, "Request«List«OpenflowFlowUpdateEntry»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpenflowFlowUpdateEntry" } } }, "title" : "Request«List«OpenflowFlowUpdateEntry»»" }, "Request«List«string»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "type" : "string" } } }, "title" : "Request«List«string»»" }, "Request«LoopbackEndpointRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/LoopbackEndpointRequest" } }, "title" : "Request«LoopbackEndpointRequest»" }, "Request«LspPathConfigRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/LspPathConfigRequest" } }, "title" : "Request«LspPathConfigRequest»" }, "Request«MediationAugmentationRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/MediationAugmentationRequest" } }, "title" : "Request«MediationAugmentationRequest»" }, "Request«MediationProfileTemplateMapping»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/MediationProfileTemplateMapping" } }, "title" : "Request«MediationProfileTemplateMapping»" }, "Request«NetworkElementRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/NetworkElementRequest" } }, "title" : "Request«NetworkElementRequest»" }, "Request«NspEthtSvcAccessParameters»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/NspEthtSvcAccessParameters" } }, "title" : "Request«NspEthtSvcAccessParameters»" }, "Request«OchServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OchServiceCreationTemplate" } }, "title" : "Request«OchServiceCreationTemplate»" }, "Request«OduServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OduServiceCreationTemplate" } }, "title" : "Request«OduServiceCreationTemplate»" }, "Request«OpenflowFlowSearchById»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpenflowFlowSearchById" } }, "title" : "Request«OpenflowFlowSearchById»" }, "Request«OpenflowFlowSearch»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpenflowFlowSearch" } }, "title" : "Request«OpenflowFlowSearch»" }, "Request«OpticalConnectivityConstraintTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticalConnectivityConstraintTemplate" } }, "title" : "Request«OpticalConnectivityConstraintTemplate»" }, "Request«OpticalConnectivityServiceTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticalConnectivityServiceTemplate" } }, "title" : "Request«OpticalConnectivityServiceTemplate»" }, "Request«OpticalResilienceConstraintTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticalResilienceConstraintTemplate" } }, "title" : "Request«OpticalResilienceConstraintTemplate»" }, "Request«OpticalRoutingConstraintTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticalRoutingConstraintTemplate" } }, "title" : "Request«OpticalRoutingConstraintTemplate»" }, "Request«OpticsRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticsRequest" } }, "title" : "Request«OpticsRequest»" }, "Request«PathProfileTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/PathProfileTemplate" } }, "title" : "Request«PathProfileTemplate»" }, "Request«PathSearchRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/PathSearchRequest" } }, "title" : "Request«PathSearchRequest»" }, "Request«PortRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/PortRequest" } }, "title" : "Request«PortRequest»" }, "Request«QosProfile»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/QosProfile" } }, "title" : "Request«QosProfile»" }, "Request«QosTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/QosTemplate" } }, "title" : "Request«QosTemplate»" }, "Request«RouterIdSystemIdMapping»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/RouterIdSystemIdMapping" } }, "title" : "Request«RouterIdSystemIdMapping»" }, "Request«RouterPortProtectionGroupPolicy»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/RouterPortProtectionGroupPolicy" } }, "title" : "Request«RouterPortProtectionGroupPolicy»" }, "Request«ServiceTunnelRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ServiceTunnelRequest" } }, "title" : "Request«ServiceTunnelRequest»" }, "Request«SnmpTcaPolicyInfo»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/SnmpTcaPolicyInfo" } }, "title" : "Request«SnmpTcaPolicyInfo»" }, "Request«SteeringParameter»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/SteeringParameter" } }, "title" : "Request«SteeringParameter»" }, "Request«SystemIpMplsConfig»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/SystemIpMplsConfig" } }, "title" : "Request«SystemIpMplsConfig»" }, "Request«TdmEndpointRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TdmEndpointRequest" } }, "title" : "Request«TdmEndpointRequest»" }, "Request«TeLinkConfig»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TeLinkConfig" } }, "title" : "Request«TeLinkConfig»" }, "Request«TenantRequest»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TenantRequest" } }, "title" : "Request«TenantRequest»" }, "Request«Tenant»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Tenant" } }, "title" : "Request«Tenant»" }, "Request«TrafficDataCollection»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TrafficDataCollection" } }, "title" : "Request«TrafficDataCollection»" }, "Request«TunnelCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TunnelCreationTemplate" } }, "title" : "Request«TunnelCreationTemplate»" }, "Request«TunnelSelectionTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TunnelSelectionTemplate" } }, "title" : "Request«TunnelSelectionTemplate»" }, "Request«WorkflowProfileTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/WorkflowProfileTemplate" } }, "title" : "Request«WorkflowProfileTemplate»" }, "ResilienceConstraint" : { "type" : "object", "properties" : { "holdOffTime" : { "type" : "integer", "description" : "This attribute indicates the time, in milliseconds, between declaration of signal degrade or signal fail, and the initialization of the protection switching algorithm." }, "isCoordinatedSwitchingBothEnds" : { "type" : "boolean", "description" : "Is operating such that switching at both ends of each flow acorss the FC is coordinated at both ingress and egress ends." }, "isFrozen" : { "type" : "boolean", "description" : "Temporarily prevents any switch action to be taken and, as such, freezes the current state. Until the freeze is cleared, additional near-end external commands are rejected and fault condition changes and received APS messages are ignored. All administrative controls of any aspect of protection are rejected." }, "isLockOut" : { "type" : "boolean", "description" : "The resource is configured to temporarily not be available for use in the protection scheme(s) it is part of. This overrides all other protection control states including forced. If the item is locked out then it cannot be used under any circumstances. Note: Only relevant when part of a protection scheme." }, "maxSwitchTimes" : { "type" : "integer", "description" : "Used to limit the maximum swtich times. When work fault disappears, and traffic returns to the original work path, switch counter reset." }, "resilienceType" : { "description" : "Resilience type", "$ref" : "#/definitions/ResilienceType" }, "restorationCoordinateType" : { "type" : "string", "description" : " The coordination mechanism between multi-layers.", "enum" : [ "HOLD_OFF_TIME", "NO_COORDINATE", "WAIT_FOR_NOTIFICATION" ] }, "restorePriority" : { "type" : "integer", "description" : "none" }, "reversionMode" : { "type" : "string", "description" : "Indcates whether the protection scheme is revertive or non-revertive.", "enum" : [ "NON_REVERTIVE", "REVERTIVE" ] }, "waitToRevertTime" : { "type" : "integer", "description" : "If the protection system is revertive, this attribute specifies the time, in minutes, to wait after a fault clears on a higher priority (preferred) resource before reverting to the preferred resource." } }, "title" : "ResilienceConstraint", "description" : "A list of control parameters to apply to a switch." }, "ResilienceType" : { "type" : "object", "properties" : { "protectionType" : { "type" : "string", "description" : "Protection type", "enum" : [ "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION", "PERMANENT_ONE_PLUS_ONE_PROTECTION", "DYNAMIC_RESTORATION", "ONE_PLUS_ONE_PROTECTION", "ONE_FOR_ONE_PROTECTION", "NO_PROTECTON", "PRE_COMPUTED_RESTORATION" ] }, "restorationPolicy" : { "type" : "string", "description" : "Restoration policy", "enum" : [ "NA", "PER_DOMAIN_RESTORATION", "END_TO_END_RESTORATION" ] } }, "title" : "ResilienceType", "description" : "Resilience type" }, "ResponseData«AugmentationMeta»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«AugmentationMeta»" } }, "title" : "ResponseData«AugmentationMeta»" }, "ResponseData«Authentication»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Authentication»" } }, "title" : "ResponseData«Authentication»" }, "ResponseData«BackhaulPath»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«BackhaulPath»" } }, "title" : "ResponseData«BackhaulPath»" }, "ResponseData«BaseEntity»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«BaseEntity»" } }, "title" : "ResponseData«BaseEntity»" }, "ResponseData«BaseService»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«BaseService»" } }, "title" : "ResponseData«BaseService»" }, "ResponseData«ClineServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«ClineServiceCreationTemplate»" } }, "title" : "ResponseData«ClineServiceCreationTemplate»" }, "ResponseData«CustomAttributesTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«CustomAttributesTemplate»" } }, "title" : "ResponseData«CustomAttributesTemplate»" }, "ResponseData«Customer»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Customer»" } }, "title" : "ResponseData«Customer»" }, "ResponseData«ElanServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«ElanServiceCreationTemplate»" } }, "title" : "ResponseData«ElanServiceCreationTemplate»" }, "ResponseData«ElineServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«ElineServiceCreationTemplate»" } }, "title" : "ResponseData«ElineServiceCreationTemplate»" }, "ResponseData«IesServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«IesServiceCreationTemplate»" } }, "title" : "ResponseData«IesServiceCreationTemplate»" }, "ResponseData«IpOpticalCorrelationPolicy»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«IpOpticalCorrelationPolicy»" } }, "title" : "ResponseData«IpOpticalCorrelationPolicy»" }, "ResponseData«L2DciVpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«L2DciVpnServiceCreationTemplate»" } }, "title" : "ResponseData«L2DciVpnServiceCreationTemplate»" }, "ResponseData«L2backhaulServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«L2backhaulServiceCreationTemplate»" } }, "title" : "ResponseData«L2backhaulServiceCreationTemplate»" }, "ResponseData«L3DciVpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«L3DciVpnServiceCreationTemplate»" } }, "title" : "ResponseData«L3DciVpnServiceCreationTemplate»" }, "ResponseData«L3vpnRdRtPolicy»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«L3vpnRdRtPolicy»" } }, "title" : "ResponseData«L3vpnRdRtPolicy»" }, "ResponseData«L3vpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«L3vpnServiceCreationTemplate»" } }, "title" : "ResponseData«L3vpnServiceCreationTemplate»" }, "ResponseData«LagServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«LagServiceCreationTemplate»" } }, "title" : "ResponseData«LagServiceCreationTemplate»" }, "ResponseData«Latency»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Latency»" } }, "title" : "ResponseData«Latency»" }, "ResponseData«Link»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Link»" } }, "title" : "ResponseData«Link»" }, "ResponseData«List«AmiNameVersionTemplates»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«AmiNameVersionTemplates»»" } }, "title" : "ResponseData«List«AmiNameVersionTemplates»»" }, "ResponseData«List«AmiNameVersions»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«AmiNameVersions»»" } }, "title" : "ResponseData«List«AmiNameVersions»»" }, "ResponseData«List«AugmentationMetaInput»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«AugmentationMetaInput»»" } }, "title" : "ResponseData«List«AugmentationMetaInput»»" }, "ResponseData«List«BaseEntity»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«BaseEntity»»" } }, "title" : "ResponseData«List«BaseEntity»»" }, "ResponseData«List«BaseServiceEndpoint»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«BaseServiceEndpoint»»" } }, "title" : "ResponseData«List«BaseServiceEndpoint»»" }, "ResponseData«List«BaseService»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«BaseService»»" } }, "title" : "ResponseData«List«BaseService»»" }, "ResponseData«List«ClineServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«ClineServiceCreationTemplate»»" } }, "title" : "ResponseData«List«ClineServiceCreationTemplate»»" }, "ResponseData«List«CustomAttributesTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«CustomAttributesTemplate»»" } }, "title" : "ResponseData«List«CustomAttributesTemplate»»" }, "ResponseData«List«Customer»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«Customer»»" } }, "title" : "ResponseData«List«Customer»»" }, "ResponseData«List«ElanServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«ElanServiceCreationTemplate»»" } }, "title" : "ResponseData«List«ElanServiceCreationTemplate»»" }, "ResponseData«List«ElineServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«ElineServiceCreationTemplate»»" } }, "title" : "ResponseData«List«ElineServiceCreationTemplate»»" }, "ResponseData«List«IesServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«IesServiceCreationTemplate»»" } }, "title" : "ResponseData«List«IesServiceCreationTemplate»»" }, "ResponseData«List«IpOpticalCorrelationPolicy»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«IpOpticalCorrelationPolicy»»" } }, "title" : "ResponseData«List«IpOpticalCorrelationPolicy»»" }, "ResponseData«List«L2DciVpnServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«L2DciVpnServiceCreationTemplate»»" } }, "title" : "ResponseData«List«L2DciVpnServiceCreationTemplate»»" }, "ResponseData«List«L2backhaulServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«L2backhaulServiceCreationTemplate»»" } }, "title" : "ResponseData«List«L2backhaulServiceCreationTemplate»»" }, "ResponseData«List«L3DciVpnServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«L3DciVpnServiceCreationTemplate»»" } }, "title" : "ResponseData«List«L3DciVpnServiceCreationTemplate»»" }, "ResponseData«List«L3vpnRdRtPolicy»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«L3vpnRdRtPolicy»»" } }, "title" : "ResponseData«List«L3vpnRdRtPolicy»»" }, "ResponseData«List«L3vpnServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«L3vpnServiceCreationTemplate»»" } }, "title" : "ResponseData«List«L3vpnServiceCreationTemplate»»" }, "ResponseData«List«LagServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«LagServiceCreationTemplate»»" } }, "title" : "ResponseData«List«LagServiceCreationTemplate»»" }, "ResponseData«List«LspPath»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«LspPath»»" } }, "title" : "ResponseData«List«LspPath»»" }, "ResponseData«List«Lsp»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«Lsp»»" } }, "title" : "ResponseData«List«Lsp»»" }, "ResponseData«List«MediationProfileTemplateMapping»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«MediationProfileTemplateMapping»»" } }, "title" : "ResponseData«List«MediationProfileTemplateMapping»»" }, "ResponseData«List«NePolicyIdentifier»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«NePolicyIdentifier»»" } }, "title" : "ResponseData«List«NePolicyIdentifier»»" }, "ResponseData«List«NetworkElement»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«NetworkElement»»" } }, "title" : "ResponseData«List«NetworkElement»»" }, "ResponseData«List«NspNodeWithNetwork»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«NspNodeWithNetwork»»" } }, "title" : "ResponseData«List«NspNodeWithNetwork»»" }, "ResponseData«List«NspTerminationPoint»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«NspTerminationPoint»»" } }, "title" : "ResponseData«List«NspTerminationPoint»»" }, "ResponseData«List«OchServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OchServiceCreationTemplate»»" } }, "title" : "ResponseData«List«OchServiceCreationTemplate»»" }, "ResponseData«List«OduServiceCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OduServiceCreationTemplate»»" } }, "title" : "ResponseData«List«OduServiceCreationTemplate»»" }, "ResponseData«List«OpenflowFlowEntry»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OpenflowFlowEntry»»" } }, "title" : "ResponseData«List«OpenflowFlowEntry»»" }, "ResponseData«List«OpenflowPort»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OpenflowPort»»" } }, "title" : "ResponseData«List«OpenflowPort»»" }, "ResponseData«List«OpenflowSwitch»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OpenflowSwitch»»" } }, "title" : "ResponseData«List«OpenflowSwitch»»" }, "ResponseData«List«OpenflowTable»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OpenflowTable»»" } }, "title" : "ResponseData«List«OpenflowTable»»" }, "ResponseData«List«OpticalConnectivityConstraintTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OpticalConnectivityConstraintTemplate»»" } }, "title" : "ResponseData«List«OpticalConnectivityConstraintTemplate»»" }, "ResponseData«List«OpticalConnectivityServiceTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OpticalConnectivityServiceTemplate»»" } }, "title" : "ResponseData«List«OpticalConnectivityServiceTemplate»»" }, "ResponseData«List«OpticalResilienceConstraintTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OpticalResilienceConstraintTemplate»»" } }, "title" : "ResponseData«List«OpticalResilienceConstraintTemplate»»" }, "ResponseData«List«OpticalRoutingConstraintTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«OpticalRoutingConstraintTemplate»»" } }, "title" : "ResponseData«List«OpticalRoutingConstraintTemplate»»" }, "ResponseData«List«PathProfileTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«PathProfileTemplate»»" } }, "title" : "ResponseData«List«PathProfileTemplate»»" }, "ResponseData«List«PhysicalLink»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«PhysicalLink»»" } }, "title" : "ResponseData«List«PhysicalLink»»" }, "ResponseData«List«PolicyIdentifier»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«PolicyIdentifier»»" } }, "title" : "ResponseData«List«PolicyIdentifier»»" }, "ResponseData«List«Port»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«Port»»" } }, "title" : "ResponseData«List«Port»»" }, "ResponseData«List«QosProfile»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«QosProfile»»" } }, "title" : "ResponseData«List«QosProfile»»" }, "ResponseData«List«QosTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«QosTemplate»»" } }, "title" : "ResponseData«List«QosTemplate»»" }, "ResponseData«List«RouterIdSystemIdMapping»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«RouterIdSystemIdMapping»»" } }, "title" : "ResponseData«List«RouterIdSystemIdMapping»»" }, "ResponseData«List«RouterPortProtectionGroupPolicy»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«RouterPortProtectionGroupPolicy»»" } }, "title" : "ResponseData«List«RouterPortProtectionGroupPolicy»»" }, "ResponseData«List«ServiceTunnel»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«ServiceTunnel»»" } }, "title" : "ResponseData«List«ServiceTunnel»»" }, "ResponseData«List«SteeringParameter»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«SteeringParameter»»" } }, "title" : "ResponseData«List«SteeringParameter»»" }, "ResponseData«List«SystemIpMplsConfig»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«SystemIpMplsConfig»»" } }, "title" : "ResponseData«List«SystemIpMplsConfig»»" }, "ResponseData«List«Tenant»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«Tenant»»" } }, "title" : "ResponseData«List«Tenant»»" }, "ResponseData«List«TunnelCreationTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«TunnelCreationTemplate»»" } }, "title" : "ResponseData«List«TunnelCreationTemplate»»" }, "ResponseData«List«TunnelSelectionTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«TunnelSelectionTemplate»»" } }, "title" : "ResponseData«List«TunnelSelectionTemplate»»" }, "ResponseData«List«Usergroup»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«Usergroup»»" } }, "title" : "ResponseData«List«Usergroup»»" }, "ResponseData«List«WorkflowProfileTemplate»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«WorkflowProfileTemplate»»" } }, "title" : "ResponseData«List«WorkflowProfileTemplate»»" }, "ResponseData«List«string»»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«List«string»»" } }, "title" : "ResponseData«List«string»»" }, "ResponseData«LspPath»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«LspPath»" } }, "title" : "ResponseData«LspPath»" }, "ResponseData«Lsp»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Lsp»" } }, "title" : "ResponseData«Lsp»" }, "ResponseData«MediationProfileTemplateMapping»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«MediationProfileTemplateMapping»" } }, "title" : "ResponseData«MediationProfileTemplateMapping»" }, "ResponseData«NetworkElement»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«NetworkElement»" } }, "title" : "ResponseData«NetworkElement»" }, "ResponseData«Networks»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Networks»" } }, "title" : "ResponseData«Networks»" }, "ResponseData«Network»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Network»" } }, "title" : "ResponseData«Network»" }, "ResponseData«Node»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Node»" } }, "title" : "ResponseData«Node»" }, "ResponseData«OchServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«OchServiceCreationTemplate»" } }, "title" : "ResponseData«OchServiceCreationTemplate»" }, "ResponseData«OduServiceCreationTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«OduServiceCreationTemplate»" } }, "title" : "ResponseData«OduServiceCreationTemplate»" }, "ResponseData«OpticalConnectivityConstraintTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«OpticalConnectivityConstraintTemplate»" } }, "title" : "ResponseData«OpticalConnectivityConstraintTemplate»" }, "ResponseData«OpticalConnectivityServiceTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«OpticalConnectivityServiceTemplate»" } }, "title" : "ResponseData«OpticalConnectivityServiceTemplate»" }, "ResponseData«OpticalResilienceConstraintTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«OpticalResilienceConstraintTemplate»" } }, "title" : "ResponseData«OpticalResilienceConstraintTemplate»" }, "ResponseData«OpticalRoutingConstraintTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«OpticalRoutingConstraintTemplate»" } }, "title" : "ResponseData«OpticalRoutingConstraintTemplate»" }, "ResponseData«PathProfileTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«PathProfileTemplate»" } }, "title" : "ResponseData«PathProfileTemplate»" }, "ResponseData«PhysicalLink»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«PhysicalLink»" } }, "title" : "ResponseData«PhysicalLink»" }, "ResponseData«Port»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Port»" } }, "title" : "ResponseData«Port»" }, "ResponseData«QosProfile»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«QosProfile»" } }, "title" : "ResponseData«QosProfile»" }, "ResponseData«QosTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«QosTemplate»" } }, "title" : "ResponseData«QosTemplate»" }, "ResponseData«RouterIdSystemIdMapping»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«RouterIdSystemIdMapping»" } }, "title" : "ResponseData«RouterIdSystemIdMapping»" }, "ResponseData«RouterPortProtectionGroupPolicy»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«RouterPortProtectionGroupPolicy»" } }, "title" : "ResponseData«RouterPortProtectionGroupPolicy»" }, "ResponseData«ServiceDebugResult»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«ServiceDebugResult»" } }, "title" : "ResponseData«ServiceDebugResult»" }, "ResponseData«ServiceHierarchy»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«ServiceHierarchy»" } }, "title" : "ResponseData«ServiceHierarchy»" }, "ResponseData«ServiceTunnel»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«ServiceTunnel»" } }, "title" : "ResponseData«ServiceTunnel»" }, "ResponseData«SnmpTcaPolicyInfo»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«SnmpTcaPolicyInfo»" } }, "title" : "ResponseData«SnmpTcaPolicyInfo»" }, "ResponseData«SteeringParameter»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«SteeringParameter»" } }, "title" : "ResponseData«SteeringParameter»" }, "ResponseData«Tenant»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Tenant»" } }, "title" : "ResponseData«Tenant»" }, "ResponseData«TerminationPoint»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«TerminationPoint»" } }, "title" : "ResponseData«TerminationPoint»" }, "ResponseData«TrafficDataCollection»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«TrafficDataCollection»" } }, "title" : "ResponseData«TrafficDataCollection»" }, "ResponseData«TunnelSelectionTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«TunnelSelectionTemplate»" } }, "title" : "ResponseData«TunnelSelectionTemplate»" }, "ResponseData«Usergroup»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«Usergroup»" } }, "title" : "ResponseData«Usergroup»" }, "ResponseData«WorkflowProfileTemplate»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«WorkflowProfileTemplate»" } }, "title" : "ResponseData«WorkflowProfileTemplate»" }, "ResponseData«boolean»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«boolean»" } }, "title" : "ResponseData«boolean»" }, "ResponseData«long»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«long»" } }, "title" : "ResponseData«long»" }, "ResponseData«string»" : { "type" : "object", "properties" : { "response" : { "$ref" : "#/definitions/Response«string»" } }, "title" : "ResponseData«string»" }, "Response«AugmentationMeta»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/AugmentationMeta" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«AugmentationMeta»" }, "Response«Authentication»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Authentication" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Authentication»" }, "Response«BackhaulPath»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/BackhaulPath" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«BackhaulPath»" }, "Response«BaseEntity»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/BaseEntity" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«BaseEntity»" }, "Response«BaseService»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/BaseService" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«BaseService»" }, "Response«ClineServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ClineServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«ClineServiceCreationTemplate»" }, "Response«CustomAttributesTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/CustomAttributesTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«CustomAttributesTemplate»" }, "Response«Customer»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Customer" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Customer»" }, "Response«ElanServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ElanServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«ElanServiceCreationTemplate»" }, "Response«ElineServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ElineServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«ElineServiceCreationTemplate»" }, "Response«ErrorMessages»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ErrorMessages" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«ErrorMessages»" }, "Response«IesServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IesServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«IesServiceCreationTemplate»" }, "Response«IpOpticalCorrelationPolicy»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/IpOpticalCorrelationPolicy" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«IpOpticalCorrelationPolicy»" }, "Response«L2DciVpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L2DciVpnServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«L2DciVpnServiceCreationTemplate»" }, "Response«L2backhaulServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L2backhaulServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«L2backhaulServiceCreationTemplate»" }, "Response«L3DciVpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L3DciVpnServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«L3DciVpnServiceCreationTemplate»" }, "Response«L3vpnRdRtPolicy»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L3vpnRdRtPolicy" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«L3vpnRdRtPolicy»" }, "Response«L3vpnServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/L3vpnServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«L3vpnServiceCreationTemplate»" }, "Response«LagServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/LagServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«LagServiceCreationTemplate»" }, "Response«Latency»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Latency" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Latency»" }, "Response«Link»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Link" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Link»" }, "Response«List«AmiNameVersionTemplates»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/AmiNameVersionTemplates" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«AmiNameVersionTemplates»»" }, "Response«List«AmiNameVersions»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/AmiNameVersions" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«AmiNameVersions»»" }, "Response«List«AugmentationMetaInput»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/AugmentationMetaInput" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«AugmentationMetaInput»»" }, "Response«List«BaseEntity»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/BaseEntity" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«BaseEntity»»" }, "Response«List«BaseServiceEndpoint»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/BaseServiceEndpoint" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«BaseServiceEndpoint»»" }, "Response«List«BaseService»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/BaseService" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«BaseService»»" }, "Response«List«ClineServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/ClineServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«ClineServiceCreationTemplate»»" }, "Response«List«CustomAttributesTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttributesTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«CustomAttributesTemplate»»" }, "Response«List«Customer»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Customer" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«Customer»»" }, "Response«List«ElanServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/ElanServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«ElanServiceCreationTemplate»»" }, "Response«List«ElineServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/ElineServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«ElineServiceCreationTemplate»»" }, "Response«List«IesServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/IesServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«IesServiceCreationTemplate»»" }, "Response«List«IpOpticalCorrelationPolicy»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/IpOpticalCorrelationPolicy" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«IpOpticalCorrelationPolicy»»" }, "Response«List«L2DciVpnServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2DciVpnServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«L2DciVpnServiceCreationTemplate»»" }, "Response«List«L2backhaulServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2backhaulServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«L2backhaulServiceCreationTemplate»»" }, "Response«List«L3DciVpnServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3DciVpnServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«L3DciVpnServiceCreationTemplate»»" }, "Response«List«L3vpnRdRtPolicy»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3vpnRdRtPolicy" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«L3vpnRdRtPolicy»»" }, "Response«List«L3vpnServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/L3vpnServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«L3vpnServiceCreationTemplate»»" }, "Response«List«LagServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/LagServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«LagServiceCreationTemplate»»" }, "Response«List«LspPath»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/LspPath" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«LspPath»»" }, "Response«List«Lsp»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Lsp" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«Lsp»»" }, "Response«List«MediationProfileTemplateMapping»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/MediationProfileTemplateMapping" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«MediationProfileTemplateMapping»»" }, "Response«List«NePolicyIdentifier»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/NePolicyIdentifier" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«NePolicyIdentifier»»" }, "Response«List«NetworkElement»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/NetworkElement" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«NetworkElement»»" }, "Response«List«NspNodeWithNetwork»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspNodeWithNetwork" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«NspNodeWithNetwork»»" }, "Response«List«NspTerminationPoint»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/NspTerminationPoint" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«NspTerminationPoint»»" }, "Response«List«OchServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OchServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OchServiceCreationTemplate»»" }, "Response«List«OduServiceCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OduServiceCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OduServiceCreationTemplate»»" }, "Response«List«OpenflowFlowEntry»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpenflowFlowEntry" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OpenflowFlowEntry»»" }, "Response«List«OpenflowPort»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpenflowPort" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OpenflowPort»»" }, "Response«List«OpenflowSwitch»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpenflowSwitch" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OpenflowSwitch»»" }, "Response«List«OpenflowTable»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpenflowTable" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OpenflowTable»»" }, "Response«List«OpticalConnectivityConstraintTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpticalConnectivityConstraintTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OpticalConnectivityConstraintTemplate»»" }, "Response«List«OpticalConnectivityServiceTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpticalConnectivityServiceTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OpticalConnectivityServiceTemplate»»" }, "Response«List«OpticalResilienceConstraintTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpticalResilienceConstraintTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OpticalResilienceConstraintTemplate»»" }, "Response«List«OpticalRoutingConstraintTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/OpticalRoutingConstraintTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«OpticalRoutingConstraintTemplate»»" }, "Response«List«PathProfileTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/PathProfileTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«PathProfileTemplate»»" }, "Response«List«PhysicalLink»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/PhysicalLink" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«PhysicalLink»»" }, "Response«List«PolicyIdentifier»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/PolicyIdentifier" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«PolicyIdentifier»»" }, "Response«List«Port»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Port" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«Port»»" }, "Response«List«QosProfile»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/QosProfile" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«QosProfile»»" }, "Response«List«QosTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/QosTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«QosTemplate»»" }, "Response«List«RouterIdSystemIdMapping»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/RouterIdSystemIdMapping" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«RouterIdSystemIdMapping»»" }, "Response«List«RouterPortProtectionGroupPolicy»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/RouterPortProtectionGroupPolicy" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«RouterPortProtectionGroupPolicy»»" }, "Response«List«ServiceTunnel»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/ServiceTunnel" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«ServiceTunnel»»" }, "Response«List«SteeringParameter»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/SteeringParameter" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«SteeringParameter»»" }, "Response«List«SystemIpMplsConfig»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/SystemIpMplsConfig" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«SystemIpMplsConfig»»" }, "Response«List«Tenant»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Tenant" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«Tenant»»" }, "Response«List«TunnelCreationTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/TunnelCreationTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«TunnelCreationTemplate»»" }, "Response«List«TunnelSelectionTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/TunnelSelectionTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«TunnelSelectionTemplate»»" }, "Response«List«Usergroup»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Usergroup" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«Usergroup»»" }, "Response«List«WorkflowProfileTemplate»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowProfileTemplate" } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«WorkflowProfileTemplate»»" }, "Response«List«string»»" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "OPERATOR", "ADMIN", "USER" ] } }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«List«string»»" }, "Response«LspPath»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/LspPath" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«LspPath»" }, "Response«Lsp»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Lsp" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Lsp»" }, "Response«MediationProfileTemplateMapping»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/MediationProfileTemplateMapping" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«MediationProfileTemplateMapping»" }, "Response«NetworkElement»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/NetworkElement" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«NetworkElement»" }, "Response«Networks»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Networks" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Networks»" }, "Response«Network»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Network" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Network»" }, "Response«Node»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Node" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Node»" }, "Response«OchServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OchServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«OchServiceCreationTemplate»" }, "Response«OduServiceCreationTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OduServiceCreationTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«OduServiceCreationTemplate»" }, "Response«OpticalConnectivityConstraintTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticalConnectivityConstraintTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«OpticalConnectivityConstraintTemplate»" }, "Response«OpticalConnectivityServiceTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticalConnectivityServiceTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«OpticalConnectivityServiceTemplate»" }, "Response«OpticalResilienceConstraintTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticalResilienceConstraintTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«OpticalResilienceConstraintTemplate»" }, "Response«OpticalRoutingConstraintTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpticalRoutingConstraintTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«OpticalRoutingConstraintTemplate»" }, "Response«PathProfileTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/PathProfileTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«PathProfileTemplate»" }, "Response«PhysicalLink»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/PhysicalLink" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«PhysicalLink»" }, "Response«Port»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Port" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Port»" }, "Response«QosProfile»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/QosProfile" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«QosProfile»" }, "Response«QosTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/QosTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«QosTemplate»" }, "Response«RouterIdSystemIdMapping»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/RouterIdSystemIdMapping" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«RouterIdSystemIdMapping»" }, "Response«RouterPortProtectionGroupPolicy»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/RouterPortProtectionGroupPolicy" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«RouterPortProtectionGroupPolicy»" }, "Response«ServiceDebugResult»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ServiceDebugResult" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«ServiceDebugResult»" }, "Response«ServiceHierarchy»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ServiceHierarchy" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«ServiceHierarchy»" }, "Response«ServiceTunnel»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/ServiceTunnel" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«ServiceTunnel»" }, "Response«SnmpTcaPolicyInfo»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/SnmpTcaPolicyInfo" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«SnmpTcaPolicyInfo»" }, "Response«SteeringParameter»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/SteeringParameter" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«SteeringParameter»" }, "Response«Tenant»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Tenant" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Tenant»" }, "Response«TerminationPoint»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TerminationPoint" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«TerminationPoint»" }, "Response«TrafficDataCollection»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TrafficDataCollection" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«TrafficDataCollection»" }, "Response«TunnelSelectionTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/TunnelSelectionTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«TunnelSelectionTemplate»" }, "Response«Usergroup»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/Usergroup" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«Usergroup»" }, "Response«WorkflowProfileTemplate»" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/WorkflowProfileTemplate" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«WorkflowProfileTemplate»" }, "Response«boolean»" : { "type" : "object", "properties" : { "data" : { "type" : "boolean" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«boolean»" }, "Response«long»" : { "type" : "object", "properties" : { "data" : { "type" : "integer", "format" : "int64" }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«long»" }, "Response«string»" : { "type" : "object", "properties" : { "data" : { "type" : "string", "enum" : [ "READY", "INIT" ] }, "endRow" : { "type" : "integer", "format" : "int64" }, "startRow" : { "type" : "integer", "format" : "int64" }, "status" : { "type" : "integer", "format" : "int32" }, "totalRows" : { "type" : "integer", "format" : "int64" } }, "title" : "Response«string»" }, "ReversionPolicy" : { "type" : "object", "properties" : { "reversionMode" : { "type" : "string", "description" : "Reversion mode", "enum" : [ "revertive", "non_revertive" ] }, "waitToRevertTime" : { "description" : "Wait to revert time", "$ref" : "#/definitions/WaitToRevertTime" } }, "title" : "ReversionPolicy", "description" : "Router Port Protection Group reversion policy" }, "RiskCharacteristic" : { "type" : "object", "properties" : { "riskCharacteristicName" : { "type" : "string", "description" : "The name of the risk characteristic. The characteristic may be related to a specific degree of closeness. For example a particular characteristic may apply to failures that are localized (e.g. to one side of a road) where as another characteristic may relate to failures that have a broader impact (e.g. both sides of a road that crosses a bridge). Depending upon the importance of the traffic being routed different risk characteristics will be evaluated." }, "riskIdentifierList" : { "type" : "array", "description" : "A list of the identifiers of each physical/geographic unit (with the specific risk characteristic) that is related to a segment of the TopologicalEntity.", "items" : { "type" : "string" } } }, "title" : "RiskCharacteristic", "description" : "The information for a particular risk characteristic where there is a list of risk identifiers related to that characteristic." }, "RouteTarget" : { "type" : "object", "properties" : { "rt" : { "type" : "string", "description" : "The route target for the service" }, "targetType" : { "type" : "string", "description" : "The type of route target that is defined for the service. Can be either import or export", "enum" : [ "import_export", "exp", "imp" ] } }, "title" : "RouteTarget" }, "RouterIdSystemIdMapping" : { "type" : "object", "required" : [ "name", "systemId" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "pccAddress" : { "description" : "The PCC IP address.", "$ref" : "#/definitions/IpAddress" }, "routerInfos" : { "type" : "array", "items" : { "$ref" : "#/definitions/RouterInfo" } }, "systemId" : { "description" : "The system address.", "$ref" : "#/definitions/IpAddress" }, "systemName" : { "type" : "string", "description" : "The system name." } }, "title" : "RouterIdSystemIdMapping", "description" : "Policy template that defines system ID and router ID mapping." }, "RouterInfo" : { "type" : "object", "required" : [ "asNumber", "bgpLsId", "networkIdentifier", "routerId" ], "properties" : { "asNumber" : { "description" : "Autonomous system number.", "$ref" : "#/definitions/AsNumber" }, "bgpLsId" : { "type" : "integer", "format" : "int64", "description" : "BGP-LS topology identifier." }, "dcIdentifier" : { "type" : "integer", "format" : "int64", "description" : "Identifier used when resources correspond to datacenter entities. Applicable to routers defined and/or discovered with protocol=STATIC. Keep as zero by default if not defining DC entities." }, "networkIdentifier" : { "description" : "Network identifier.", "$ref" : "#/definitions/NetworkIdentifierType" }, "protocol" : { "type" : "string", "description" : "The protocol which IGP router is using", "enum" : [ "OSPFv2", "ISIS", "BGP", "ANY", "STATIC" ] }, "routerId" : { "description" : "The IGP Router ID.", "$ref" : "#/definitions/DottedQuad" } }, "title" : "RouterInfo", "description" : "Object that defines router information." }, "RouterPortProtectionGroupPolicy" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "reversionPolicy" : { "description" : "Reversion policy", "$ref" : "#/definitions/ReversionPolicy" }, "switchPolicy" : { "description" : "Switch policy", "$ref" : "#/definitions/SwitchPolicy" } }, "title" : "RouterPortProtectionGroupPolicy", "description" : "Router Port Protection Group policies" }, "RoutingBgp" : { "type" : "object", "properties" : { "routes" : { "type" : "array", "items" : { "$ref" : "#/definitions/EbgpRoute" } } }, "title" : "RoutingBgp", "description" : "BGP specific configuration." }, "RoutingConstraint" : { "type" : "object", "properties" : { "costCharacteristic" : { "type" : "array", "items" : { "$ref" : "#/definitions/CostCharacteristic" } }, "diversityPolicy" : { "type" : "string", "description" : "Diversity policy", "enum" : [ "NODE", "LINK", "SRLG", "SNG", "SRNG" ] }, "isExclusive" : { "type" : "boolean", "description" : "To distinguish if the resources are to be exclusive to the service" }, "latencyCharacteristic" : { "type" : "array", "items" : { "$ref" : "#/definitions/LatencyCharacteristic" } }, "riskDiversityCharacteristic" : { "type" : "array", "items" : { "$ref" : "#/definitions/RiskCharacteristic" } }, "routeDirection" : { "type" : "string", "description" : "Route direction", "enum" : [ "UNDEFINED_OR_UNKNOWN", "BIDIRECTIONAL", "UNIDIRECTIONAL" ] }, "routeObjectiveFunction" : { "type" : "string", "description" : "Route objective function", "enum" : [ "LOAD_BALANCE_MAX_UNUSED_CAPACITY", "MIN_WORK_ROUTE_COST", "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_COST", "MIN_WORK_ROUTE_HOP", "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_HOP", "MIN_WORK_ROUTE_LATENCY", "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_LATENCY" ] } }, "title" : "RoutingConstraint", "description" : "Routing constraint" }, "RoutingStatic" : { "type" : "object", "properties" : { "routes" : { "type" : "array", "items" : { "$ref" : "#/definitions/StaticRoute" } } }, "title" : "RoutingStatic" }, "Schedule" : { "type" : "object", "properties" : { "timeRange" : { "description" : "Time range", "$ref" : "#/definitions/TimeRange" } }, "title" : "Schedule", "description" : "Schedule" }, "Scheduler" : { "type" : "object", "properties" : { "cir" : { "type" : "integer", "format" : "int64", "description" : "Scheduler CIR override in either Kbps or percentage (0..100), where -3 is sum of CIR, -2 is no override, -1 is maximum" }, "pir" : { "type" : "integer", "format" : "int64", "description" : "Scheduler PIR override in either Kbps or percentage (1..100), where -2 is no override, -1 is maximum" }, "rateType" : { "type" : "string", "description" : "The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the scheduler rate will be a percentage of the port rate. Percent is not supported on Generic Qos Profiles", "enum" : [ "kbps", "percent" ] }, "schedulerType" : { "type" : "string", "description" : "The type of the scheduler override. Default is Scheduler.", "enum" : [ "Scheduler", "Arbiter" ] } }, "title" : "Scheduler", "description" : "The parameters of a scheduler" }, "Schedules" : { "type" : "object", "properties" : { "schedules" : { "description" : "Container of a schedule list defining when a particular configuration takes effect.", "$ref" : "#/definitions/SchedulesMember" } }, "title" : "Schedules", "description" : "A list of schedules defining when a particular configuration takes effect." }, "SchedulesMember" : { "type" : "object", "properties" : { "schedule" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/Schedule" } } }, "title" : "SchedulesMember", "description" : "Container of a schedule list defining when a particular configuration takes effect." }, "SecondTag" : { "type" : "object", "properties" : { "vlanWrite" : { "description" : "A grouping which represents push/pop operations of an 802.1Q VLAN tag.", "$ref" : "#/definitions/VlanWrite" } }, "title" : "SecondTag", "description" : "The second outermost VLAN tag to push/swap." }, "ServiceClassificationType" : { "type" : "object", "title" : "ServiceClassificationType", "description" : "Service classification." }, "ServiceDebugResult" : { "type" : "object", "properties" : { "fileName" : { "type" : "string", "description" : "Name of file in tomcat logs that contains test result" }, "success" : { "type" : "boolean", "description" : "Result of constraint test invocation" } }, "title" : "ServiceDebugResult", "description" : "An object to request a constraint test on a service" }, "ServiceHierarchy" : { "type" : "object", "properties" : { "baseServiceHierarchy" : { "description" : "This object is a read only representation of a service", "$ref" : "#/definitions/BaseServiceHierarchy" } }, "title" : "ServiceHierarchy", "description" : "This object is a read only representation of a service and it's related hierarchy" }, "ServiceTunnel" : { "type" : "object", "required" : [ "bidirectional", "objective" ], "properties" : { "actualEndState" : { "type" : "string", "description" : "Reflects the actual end state for this object, generally Saved, Deployed, etc. This is a read-only attribute.", "enum" : [ "Saved", "Deployed" ] }, "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "availableBw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the available bandwidth on the service" }, "bidirectional" : { "type" : "string", "description" : "Specifies whether a return path is required, and if so, what type of return path will be used. Unsupported for L3 VPN Services", "enum" : [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ] }, "bw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the service. Unsupported for IP Services. Supported values for optical services can be 1244160(1Gbe:ODU0), 2666057(OTU1:ODU1), 9953280(10GbE:ODU2), 10312500(10GbE:ODU2E), 10709000(OTU2:ODU2), 11096000(OTU2:ODU2E), 39813120(40GbE:ODU3), 43108000(OTU3:ODU3), 44583000(OTU3:ODU3e2), 100000000(100GbE:ODU4) and 112000000(OTU4:ODU4), 155520(STM-1:ODU0), 622080(STM-4:ODU0), 2488320(STM-16:ODU1), 9953281(STM-64:ODU2), 39813121(STM-256:ODU3), 1062600 (FC100:ODU0), 2125000 (FC200:ODU1), 4250000 (FC400:ODUflex)" }, "cost" : { "type" : "number", "format" : "double", "description" : "Allocation cost of the tunnel. For RSVP type tunnels, this value is the IGP metric. For VLAN type tunnels, the value is always 1. For tunnel types whose path cannot be determined an large value is returned for metric." }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The ID of a customer associated with service" }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "destinationEndpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/ServiceTunnelEndpoint" } }, "destinationNodeId" : { "description" : "The destination IP address of the tunnel. Only applies to point-to-point service tunnels. For multipoint service tunnels, please use destination-endpoints instead.", "$ref" : "#/definitions/IpAddress" }, "endpointExtensions" : { "type" : "array", "items" : { "$ref" : "#/definitions/L2EndPointExtension" } }, "endpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/BaseServiceEndpoint" } }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "groupId" : { "type" : "string", "description" : "Specifies the identifier of the group to which this service should belong. This only applies to optical services" }, "hops" : { "type" : "integer", "format" : "int32", "description" : "The number of hops of this tunnel. For RSVP type tunnels, this indicates the number of IGP hops. For VLAN type tunnels, the value is always 1. For tunnel types whose path cannot be determined an large value is returned for number of hops." }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "latency" : { "type" : "number", "format" : "double", "description" : "The latency of the tunnel in microseconds. The value of 2147483647 indicates infinite latency on the tunnel." }, "lifeCycle" : { "description" : "The Life Cycle details for a given object.", "$ref" : "#/definitions/LifeCycle" }, "maxCost" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops" : { "type" : "integer", "format" : "int32", "description" : "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services" }, "maxLatency" : { "type" : "number", "format" : "double", "description" : "Specifies the maximum latency (in ms) to consider for the service." }, "name" : { "type" : "string", "description" : "The name of the service" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "nodeServiceId" : { "type" : "integer", "format" : "int64", "description" : "Specifies the node identifier of the service. Populated only when same node service identifier is used across all sites. " }, "objective" : { "type" : "string", "description" : "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services", "enum" : [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ] }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "ownership" : { "description" : "Specifies ownership model of this tunnel", "$ref" : "#/definitions/Ownership" }, "pathProfileId" : { "type" : "string", "description" : "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "physicalLinks" : { "type" : "array", "items" : { "$ref" : "#/definitions/PhysicalLink" } }, "requestedEndState" : { "type" : "string", "description" : "Specifies the desired end state for this request, generally Saved, Deployed, etc", "enum" : [ "Saved", "Deployed" ] }, "reverseBW" : { "type" : "integer", "format" : "int64", "description" : "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services" }, "serviceType" : { "type" : "string", "description" : "The type of the service", "enum" : [ "ODU", "TUNNEL", "EACCESS", "L2_EXTENSION_UNI", "CLINE", "L2_EXTENSION_NNI", "L2_BACKHAUL", "L2_DCI", "PHYSICAL_LINK", "LAG", "ELAN", "OCH", "ELINE", "IES", "L3_VPN", "L3_DCI" ] }, "sourceEndpoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/ServiceTunnelEndpoint" } }, "sourceNodeId" : { "description" : "The source IP address of the tunnel. Only applies to point-to-point service tunnels. For multipoint service tunnels, please use source-endpoints instead.", "$ref" : "#/definitions/IpAddress" }, "steeringParameters" : { "type" : "array", "items" : { "$ref" : "#/definitions/SteeringParameter" } }, "templateId" : { "type" : "string", "description" : "Specifies the identifier of the template to apply to the service." }, "tunnelSelectionId" : { "type" : "string", "description" : "Specifies the identifier of the tunnel selection profile to apply to the service." }, "tunnelType" : { "type" : "string", "description" : "The type of the tunnel", "enum" : [ "sr_pcc_initiated", "sr_isis", "sr_te_strict", "pcc_initiated", "sr_te_loose", "rsvp_strict", "ldp", "rsvp_loose", "bgp", "sr_ospf", "gre" ] }, "underlyingTransport" : { "type" : "string", "description" : "The transport of the tunnel", "enum" : [ "ODU", "VXLAN", "ERP", "L2TPV3", "IPV4", "UNKNOWN", "GRE", "VLAN", "ANY", "MPLS" ] } }, "title" : "ServiceTunnel", "description" : "A tunnel is a logical group that allows the assigning of network resources" }, "ServiceTunnelEndpoint" : { "type" : "object", "properties" : { "nodeId" : { "type" : "string", "description" : "The ID of the NE" }, "portId" : { "type" : "string", "description" : "The ID of the port. Only applicable for ODU, ERP, and VLAN hand-off Service Tunnels." } }, "title" : "ServiceTunnelEndpoint", "description" : "A source and/or destination endpoint of the service-tunnel." }, "ServiceTunnelRequest" : { "type" : "object", "properties" : { "availableBw" : { "type" : "integer", "format" : "int64", "description" : "Specifies the available bandwidth on the service" }, "ownership" : { "description" : "Specifies ownership model of this tunnel", "$ref" : "#/definitions/Ownership" }, "steeringParameters" : { "type" : "array", "items" : { "$ref" : "#/definitions/SteeringParameter" } } }, "title" : "ServiceTunnelRequest", "description" : "A request object used to modify tunnel entities in the network." }, "Servicetype" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "Servicetype", "description" : "Identifies the type of Ethernet service." }, "SiteServiceQosProfile" : { "type" : "object", "properties" : { "egressOverrideQueues" : { "type" : "array", "items" : { "$ref" : "#/definitions/Queue" } }, "egressParam" : { "description" : "Egress Qos policy override parameters associated with an endpoint.", "$ref" : "#/definitions/EgressParam" }, "ingressOverrideQueues" : { "type" : "array", "items" : { "$ref" : "#/definitions/Queue" } }, "ingressParam" : { "description" : "Ingress QoS policy override parameters associated with an endpoint.", "$ref" : "#/definitions/IngressParam" }, "qosProfile" : { "type" : "integer", "format" : "int64", "description" : "The ID reference to the Generic QoS Profile" } }, "title" : "SiteServiceQosProfile", "description" : "The set of QoS parameters for an endpoint. When modifying, these must all be retrieved and submitted together. Changes to qos-profile require the override entries to be set back to no override first." }, "SnmpTcaPolicyInfo" : { "type" : "object", "required" : [ "policyEnabled" ], "properties" : { "ipTcaPolicyFdn" : { "type" : "string", "description" : "Policy fdn of IP interface policy is created from NFMP. Enter null to delete the pre-configured policy fdn" }, "mplsTcaPolicyFdn" : { "type" : "string", "description" : "Policy fdn of MPLS interface policy is created from NFMP. Enter null to delete the pre-configured policy fdn" }, "policyEnabled" : { "type" : "boolean", "description" : "Enable/disable snmp statistic collection" }, "sarIpTcaPolicyFdn" : { "type" : "string", "description" : "Policy fdn of SAR IP interface policy created from NFMP. Enter null value to delete the pre-configured policy fdn" } }, "title" : "SnmpTcaPolicyInfo", "description" : "NSP configuration on SNMP TCA policy for statistic collection" }, "Source" : { "type" : "object", "required" : [ "sourceNode" ], "properties" : { "sourceNode" : { "type" : "string", "description" : "Source node identifier, must be in same topology." }, "sourceTp" : { "type" : "string", "description" : "Termination point within source node that terminates the link." } }, "title" : "Source", "description" : "This container holds the logical source of a particular link." }, "Srlg" : { "type" : "object", "properties" : { "uint32" : { "type" : "integer", "format" : "int64" } }, "title" : "Srlg", "description" : "SRLG type" }, "State" : { "type" : "object", "properties" : { "teLinkConfig" : { "description" : "TE link configuration grouping.", "$ref" : "#/definitions/TeLinkConfig" }, "teLinkStateDerived" : { "description" : "Link state attributes in a TE topology.", "$ref" : "#/definitions/TeLinkStateDerived" } }, "title" : "State", "description" : "Operational state data." }, "StaticRoute" : { "type" : "object", "properties" : { "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "destination" : { "description" : "The prefix for the static route", "$ref" : "#/definitions/IpPrefix" }, "preference" : { "type" : "integer", "format" : "int64", "description" : "The preference of this static route. The default is 5 and the range is from 1 - 255" }, "routeType" : { "type" : "string", "description" : "Specifies the type of static route", "enum" : [ "black_hole", "next_hop" ] }, "targetIpAddress" : { "description" : "The target IP address. This would represent the next-hop address.", "$ref" : "#/definitions/IpAddress" } }, "title" : "StaticRoute" }, "SteeringParameter" : { "type" : "object", "required" : [ "name" ], "properties" : { "name" : { "description" : "The name of the steering paramter", "$ref" : "#/definitions/UrlSafeString" } }, "title" : "SteeringParameter", "description" : "A steering parameter is used to mark tunnels and guide tunnel selection" }, "SupportingLink" : { "type" : "object", "properties" : { "linkRef" : { "type" : "string", "description" : "This leaf identifies a link which is a part of this link's underlay. Reference loops in which a link identifies itself as its underlay, either directly or transitively, are not allowed." }, "networkRef" : { "type" : "string", "description" : "This leaf identifies in which underlay topology the supporting link is present." } }, "title" : "SupportingLink" }, "SupportingNode" : { "type" : "object", "properties" : { "networkRef" : { "type" : "string", "description" : "References the underlay network that the underlay node is part of." }, "nodeRef" : { "type" : "string", "description" : "References the underlay node itself." } }, "title" : "SupportingNode" }, "SupportingTerminationPoint" : { "type" : "object", "properties" : { "networkRef" : { "type" : "string", "description" : "This leaf identifies in which topology the supporting termination point is present." }, "nodeRef" : { "type" : "string", "description" : "This leaf identifies in which node the supporting termination point is present." }, "tpRef" : { "type" : "string", "description" : "Reference to the underlay node, must be in a different topology" } }, "title" : "SupportingTerminationPoint" }, "SwitchPolicy" : { "type" : "object", "properties" : { "waitToSwitchTime" : { "description" : "Wait to switch time", "$ref" : "#/definitions/WaitToSwitchTime" } }, "title" : "SwitchPolicy", "description" : "Router Port Protection Group switch policy" }, "SwitchingCapabilities" : { "type" : "object", "title" : "SwitchingCapabilities", "description" : "Base identity for interface switching capabilities" }, "SymmetricalOperation" : { "type" : "object", "properties" : { "vlanOperations" : { "description" : "A grouping which represents VLAN operations.", "$ref" : "#/definitions/VlanOperations" } }, "title" : "SymmetricalOperation", "description" : "Symmetrical operations. Expressed in the ingress direction, but the reverse operation is applied to egress traffic" }, "SystemIpMplsConfig" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "maintenanceMode" : { "type" : "string", "description" : "The System IP MPLS Configuration", "enum" : [ "AUTOMATIC", "MANUAL" ] }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" } }, "title" : "SystemIpMplsConfig" }, "TargetIpAddressInfo" : { "type" : "object", "properties" : { "associatedTunnelType" : { "type" : "string", "description" : "Tunnel type associated with the termination IP address.", "enum" : [ "sr_pcc_initiated", "sr_isis", "sr_te_strict", "pcc_initiated", "sr_te_loose", "rsvp_strict", "ldp", "rsvp_loose", "bgp", "sr_ospf", "gre" ] }, "primaryAddress" : { "description" : "Termination IP address.", "$ref" : "#/definitions/IpPrefix" } }, "title" : "TargetIpAddressInfo" }, "Tdm" : { "type" : "object", "properties" : { "channelFraming" : { "type" : "string", "description" : "Specifies the channel framing configuration for the DS1/E1 port" }, "ds0ChannelGroups" : { "type" : "array", "items" : { "$ref" : "#/definitions/TdmDs0ChannelGroupInfo" } }, "signalMode" : { "type" : "string", "enum" : [ "SIGNAL_MODE_CAS", "SIGNAL_MODE_NONE" ] } }, "title" : "Tdm", "description" : "Contains TDM DS1/E1 interface related configuration" }, "TdmDs0ChannelGroupInfo" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of this DS0 channel group", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "encapType" : { "type" : "string", "enum" : [ "PPP_AUTO", "WAN_MIRROR", "BCP_NULL", "FRAME_RELAY", "IPCP", "BCP_DOT1Q", "ATM", "CEM", "UNKNOWN", "CISCO_HDLC" ] }, "id" : { "type" : "string", "description" : "The identifier of this DS0 channel group" }, "name" : { "type" : "string", "description" : "The name of this DS0 channel group" }, "operationalState" : { "type" : "string", "description" : "The current operational state of the DS0 channel group", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "timeSlots" : { "type" : "string", "description" : "The time-slots configured on the DS0 channel group" } }, "title" : "TdmDs0ChannelGroupInfo", "description" : "Attributes of the DS0 channel group" }, "TdmEndpointRequest" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" }, "siteServiceQosProfile" : { "description" : "The name of Generic QoS profile applied to the endpoint", "$ref" : "#/definitions/SiteServiceQosProfile" }, "timeSlots" : { "type" : "string", "description" : "The time-slots configured on the DS0 channel group. The expected form is comma separated digits for individual time-slots with hyphen separated digits for a range of time-slots. E.g. \"3\" or \"3,5\" or \"3,5,8-12,20\" are all valid representations of time-slots" } }, "title" : "TdmEndpointRequest", "description" : "The TDM DS0 channel group definition" }, "Te" : { "type" : "object", "properties" : { "config" : { "description" : "Configuration data.", "$ref" : "#/definitions/Config" }, "state" : { "description" : "Operational state data.", "$ref" : "#/definitions/State" } }, "title" : "Te", "description" : "Indicates TE support." }, "TeGlobalId" : { "type" : "object", "properties" : { "uint32" : { "type" : "integer", "format" : "int64" } }, "title" : "TeGlobalId", "description" : "An identifier to uniquely identify an operator, which can be either a provider or a client. The definition of this type is taken from RFC6370 and RFC5003. This attribute type is used solely to provide a globally unique context for TE topologies." }, "TeLinkAttributes" : { "type" : "object", "properties" : { "accessType" : { "type" : "string", "description" : "Link access type, which can be point-to-point or multi-access.", "enum" : [ "point_to_point", "multi_access" ] }, "adminStatus" : { "type" : "string", "description" : "The administrative state of the link.", "enum" : [ "testing", "up", "preparing_maintenance", "down", "maintenance" ] }, "externalDomain" : { "description" : "For an inter-domain link, specify the attributes of the remote end of link, to facilitate the signalling at local end.", "$ref" : "#/definitions/ExternalDomain" }, "isAbstract" : { "type" : "object", "description" : "Present if the link is abstract.", "properties" : { } }, "name" : { "type" : "string", "description" : "Link Name." }, "performanceMetricThrottleContainer" : { "description" : "A container controlling performance metric throttle.", "$ref" : "#/definitions/PerformanceMetricThrottleContainer" }, "schedules" : { "description" : "A list of schedules defining when a particular configuration takes effect.", "$ref" : "#/definitions/Schedules" }, "teLinkInfoAttributes" : { "description" : "Advertised TE information attributes.", "$ref" : "#/definitions/TeLinkInfoAttributes" }, "underlay" : { "description" : "Attributes of the te-link underlay.", "$ref" : "#/definitions/Underlay" } }, "title" : "TeLinkAttributes", "description" : "Link attributes in a TE topology." }, "TeLinkAugment" : { "type" : "object", "properties" : { "te" : { "description" : "Indicates TE support.", "$ref" : "#/definitions/Te" } }, "title" : "TeLinkAugment", "description" : "Augmentation for TE link." }, "TeLinkConfig" : { "type" : "object", "properties" : { "bundledLinks" : { "description" : "A set of bundled links.", "$ref" : "#/definitions/BundledLinks" }, "componentLinks" : { "description" : "A set of component links", "$ref" : "#/definitions/ComponentLinks" }, "teLinkAttributes" : { "description" : "Link attributes in a TE topology.", "$ref" : "#/definitions/TeLinkAttributes" }, "teLinkTemplate" : { "type" : "array", "description" : "The reference to a TE link template.", "items" : { "type" : "string" } }, "template" : { "$ref" : "#/definitions/Template" } }, "title" : "TeLinkConfig", "description" : "TE link configuration grouping." }, "TeLinkConfigAttributes" : { "type" : "object", "properties" : { "teLinkAttributes" : { "description" : "Link attributes in a TE topology.", "$ref" : "#/definitions/TeLinkAttributes" } }, "title" : "TeLinkConfigAttributes", "description" : "Link configuration attributes in a TE topology." }, "TeLinkConnectivityAttributes" : { "type" : "object", "properties" : { "maxLinkBandwidth" : { "type" : "number", "format" : "double", "description" : "Maximum bandwidth that can be seen on this link in this direction. Units in bytes per second." }, "maxResvLinkBandwidth" : { "type" : "number", "format" : "double", "description" : "Maximum amount of bandwidth that can be reserved in this direction in this link. Units in bytes per second." }, "performanceMetric" : { "description" : "Link performance information in real time.", "$ref" : "#/definitions/PerformanceMetric" }, "teDefaultMetric" : { "type" : "integer", "format" : "int64", "description" : "Traffic Engineering Metric." }, "teSrlgs" : { "description" : "A list of SLRGs.", "$ref" : "#/definitions/TeSrlgs" }, "unreservedBandwidth" : { "type" : "object", "additionalProperties" : { "type" : "number", "format" : "double" } } }, "title" : "TeLinkConnectivityAttributes", "description" : "Advertised TE connectivity attributes." }, "TeLinkInfoAttributes" : { "type" : "object", "properties" : { "administrativeGroup" : { "description" : "Administrative group or color of the link. This attribute covers both administrative group (defined in RFC3630, RFC5329, and RFC5305), and extended administrative group (defined in RFC7308).", "$ref" : "#/definitions/AdminGroups" }, "interfaceSwitchingCapabilityList" : { "description" : "List of Interface Switching Capabilities Descriptors (ISCD)", "$ref" : "#/definitions/InterfaceSwitchingCapabilityList" }, "linkIndex" : { "type" : "integer", "description" : "The link identifier. If OSPF is used, this represents an ospfLsdbID. If IS-IS is used, this represents an isisLSPID. If a locally configured link is used, this object represents a unique value, which is locally defined in a router." }, "linkProtectionType" : { "type" : "string", "description" : "Link Protection Type desired for this link.", "enum" : [ "enhanced", "shared", "extra_traffic", "_1_plus_1", "unprotected", "_1_for_1" ] }, "teLinkConnectivityAttributes" : { "description" : "Advertised TE connectivity attributes.", "$ref" : "#/definitions/TeLinkConnectivityAttributes" } }, "title" : "TeLinkInfoAttributes", "description" : "Advertised TE information attributes." }, "TeLinkStateDerived" : { "type" : "object", "properties" : { "informationSource" : { "type" : "string", "description" : "Indicates the source of the information.", "enum" : [ "other", "locally_configured", "ospfv2", "ospfv3", "isis", "system_processed", "unknown" ] }, "informationSourceEntry" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/InformationSourceEntry" } }, "informationSourceState" : { "description" : "The container contains state attributes related to the information source.", "$ref" : "#/definitions/InformationSourceState" }, "isTransitional" : { "type" : "object", "description" : "Present if the link is transitional, used as an alternative approach in lieu of inter-layer-lock-id for path computation in a TE topology covering multiple layers or multiple regions.", "properties" : { } }, "operStatus" : { "type" : "string", "description" : "The current operational state of the link.", "enum" : [ "testing", "up", "preparing_maintenance", "down", "maintenance", "unknown" ] }, "recovery" : { "description" : "Status of the recovery process.", "$ref" : "#/definitions/Recovery" }, "underlay" : { "description" : "State attributes for te-link underlay.", "$ref" : "#/definitions/TeLinkStateDerivedUnderlay" } }, "title" : "TeLinkStateDerived", "description" : "Link state attributes in a TE topology." }, "TeLinkStateDerivedUnderlay" : { "type" : "object", "properties" : { "teLinkStateUnderlayAttributes" : { "description" : "State attributes for te-link underlay.", "$ref" : "#/definitions/TeLinkStateUnderlayAttributes" }, "teTopologyHierarchy" : { "$ref" : "#/definitions/TeTopologyHierarchy" } }, "title" : "TeLinkStateDerivedUnderlay", "description" : "State attributes for te-link underlay." }, "TeLinkStateUnderlayAttributes" : { "type" : "object", "properties" : { "committed" : { "type" : "boolean", "description" : "true if the underlay is committed." }, "dynamic" : { "type" : "boolean", "description" : "true if the underlay is dynamically created." } }, "title" : "TeLinkStateUnderlayAttributes", "description" : "State attributes for te-link underlay." }, "TeLinkUnderlayAttributes" : { "type" : "object", "properties" : { "underlayBackupPath" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/UnderlayBackupPath" } }, "underlayPrimaryPath" : { "description" : "The service path on the underlay topology that supports this link.", "$ref" : "#/definitions/UnderlayPrimaryPath" }, "underlayProtectionType" : { "type" : "integer", "format" : "int32", "description" : "Underlay protection type desired for this link" }, "underlayTrailDes" : { "description" : "Destination TE link of the underlay trail.", "$ref" : "#/definitions/UnderlayTrailDes" }, "underlayTrailSrc" : { "description" : "Source TE link of the underlay trail.", "$ref" : "#/definitions/UnderlayTrailSrc" } }, "title" : "TeLinkUnderlayAttributes", "description" : "Attributes for te-link underlay." }, "TeNodeAttributes" : { "type" : "object", "properties" : { "adminStatus" : { "type" : "string", "description" : "The administrative state of the link.", "enum" : [ "testing", "up", "preparing_maintenance", "down", "maintenance" ] }, "schedules" : { "description" : "A list of schedules defining when a particular configuration takes effect.", "$ref" : "#/definitions/Schedules" }, "teNodeConnectivityMatrix" : { "description" : "Connectivity matrix on a TE node.", "$ref" : "#/definitions/TeNodeConnectivityMatrix" }, "teNodeInfoAttributes" : { "description" : "Advertised TE information attributes.", "$ref" : "#/definitions/TeNodeInfoAttributes" } }, "title" : "TeNodeAttributes", "description" : "Containing node attributes in a TE topology." }, "TeNodeAugment" : { "type" : "object", "properties" : { "te" : { "description" : "Indicates TE support.", "$ref" : "#/definitions/TeNodeAugmentTe" } }, "title" : "TeNodeAugment", "description" : "Augmentation for TE node." }, "TeNodeAugmentTe" : { "type" : "object", "required" : [ "teNodeId" ], "properties" : { "config" : { "description" : "Configuration data.", "$ref" : "#/definitions/TeNodeAugmentTeConfig" }, "state" : { "description" : "Operational state data.", "$ref" : "#/definitions/TeNodeAugmentTeState" }, "teNodeId" : { "description" : "The identifier of a node in the TE topology. A node is specific to a topology to which it belongs.", "$ref" : "#/definitions/TeNodeId" }, "tunnelTerminationPoint" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/TunnelTerminationPoint" } } }, "title" : "TeNodeAugmentTe", "description" : "Indicates TE support." }, "TeNodeAugmentTeConfig" : { "type" : "object", "properties" : { "teNodeConfig" : { "description" : "TE node configuration grouping.", "$ref" : "#/definitions/TeNodeConfig" } }, "title" : "TeNodeAugmentTeConfig", "description" : "Configuration data." }, "TeNodeAugmentTeState" : { "type" : "object", "properties" : { "teNodeConfig" : { "description" : "TE node configuration grouping.", "$ref" : "#/definitions/TeNodeConfig" }, "teNodeStateDerived" : { "description" : "Node state attributes in a TE topology.", "$ref" : "#/definitions/TeNodeStateDerived" } }, "title" : "TeNodeAugmentTeState", "description" : "Operational state data." }, "TeNodeConfig" : { "type" : "object", "properties" : { "teNodeAttributes" : { "description" : "Containing node attributes in a TE topology.", "$ref" : "#/definitions/TeNodeAttributes" }, "teNodeTemplate" : { "type" : "array", "description" : "The reference to a TE node template.", "items" : { "type" : "string" } }, "template" : { "$ref" : "#/definitions/Template" } }, "title" : "TeNodeConfig", "description" : "TE node configuration grouping." }, "TeNodeConfigAttributesTemplate" : { "type" : "object", "properties" : { "teNodeAttributes" : { "description" : "Containing node attributes in a TE topology.", "$ref" : "#/definitions/TeNodeConfigAttributesTemplateTeNodeAttributes" } }, "title" : "TeNodeConfigAttributesTemplate", "description" : "Configuration node attributes for template in a TE topology." }, "TeNodeConfigAttributesTemplateTeNodeAttributes" : { "type" : "object", "properties" : { "adminStatus" : { "type" : "string", "description" : "The administrative state of the link.", "enum" : [ "testing", "up", "preparing_maintenance", "down", "maintenance" ] }, "schedules" : { "description" : "A list of schedules defining when a particular configuration takes effect.", "$ref" : "#/definitions/Schedules" }, "teNodeInfoAttributes" : { "description" : "Advertised TE information attributes.", "$ref" : "#/definitions/TeNodeInfoAttributes" } }, "title" : "TeNodeConfigAttributesTemplateTeNodeAttributes", "description" : "Containing node attributes in a TE topology." }, "TeNodeConnectivityMatrix" : { "type" : "object", "properties" : { "connectivityMatrix" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/ConnectivityMatrix" } } }, "title" : "TeNodeConnectivityMatrix", "description" : "Connectivity matrix on a TE node." }, "TeNodeId" : { "type" : "object", "properties" : { "dottedQuad" : { "$ref" : "#/definitions/DottedQuad" } }, "title" : "TeNodeId", "description" : "An identifier for a node in a topology. The identifier is represented as 32-bit unsigned integer in the dotted-quad notation. This attribute is mapped to Router ID in RFC3630, RFC5329, RFC5305, and RFC6119." }, "TeNodeInfoAttributes" : { "type" : "object", "properties" : { "domainId" : { "type" : "integer", "format" : "int64", "description" : "Identifies the domain that this node belongs. This attribute is used to support inter-domain links." }, "isAbstract" : { "type" : "object", "description" : "Present if the node is abstract, not present if the node is actual.", "properties" : { } }, "name" : { "description" : "Node name.", "$ref" : "#/definitions/DomainName" }, "signalingAddress" : { "type" : "array", "description" : "Node signaling address.", "items" : { "$ref" : "#/definitions/IpAddress" } }, "underlayTopology" : { "description" : "When an abstract node encapsulates a topology, the attributes in this container point to said topology.", "$ref" : "#/definitions/UnderlayTopology" } }, "title" : "TeNodeInfoAttributes", "description" : "Advertised TE information attributes." }, "TeNodeStateDerived" : { "type" : "object", "properties" : { "informationSource" : { "type" : "string", "description" : "Indicates the source of the information.", "enum" : [ "other", "locally_configured", "ospfv2", "ospfv3", "isis", "system_processed", "unknown" ] }, "informationSourceEntry" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/TeNodeStateDerivedInformationSourceEntry" } }, "informationSourceState" : { "description" : "The container contains state attributes related to the information source.", "$ref" : "#/definitions/InformationSourceState" }, "isMultiAccessDr" : { "type" : "object", "description" : "The presence of this attribute indicates that this TE node is a pseudonode elected as a designated router.", "properties" : { } }, "operStatus" : { "type" : "string", "description" : "The current operational state of the node.", "enum" : [ "testing", "up", "preparing_maintenance", "down", "maintenance", "unknown" ] } }, "title" : "TeNodeStateDerived", "description" : "Node state attributes in a TE topology." }, "TeNodeStateDerivedInformationSourceEntry" : { "type" : "object", "properties" : { "informationSourceAttributes" : { "$ref" : "#/definitions/InformationSourceAttributes" }, "teNodeConnectivityMatrix" : { "$ref" : "#/definitions/TeNodeConnectivityMatrix" }, "teNodeInfoAttributes" : { "$ref" : "#/definitions/TeNodeInfoAttributes" } }, "title" : "TeNodeStateDerivedInformationSourceEntry" }, "TeNodeTunnelTerminationCapability" : { "type" : "object", "properties" : { "encoding" : { "description" : "Encoding supported by this interface.", "$ref" : "#/definitions/LspEncodingTypes" }, "interLayerLockId" : { "type" : "integer", "format" : "int64", "description" : "Inter layer lock ID, used for path computation in a TE topology covering multiple layers or multiple regions." }, "protectionType" : { "description" : "The protection type that this tunnel termination point is capable of.", "$ref" : "#/definitions/LspProtType" }, "switchingCapability" : { "description" : "Switching Capability for this interface.", "$ref" : "#/definitions/SwitchingCapabilities" }, "terminationCapability" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/TerminationCapability" } } }, "title" : "TeNodeTunnelTerminationCapability", "description" : "Termination capability of a tunnel termination point on a TE node." }, "TeOptimizationCriterion" : { "type" : "object", "title" : "TeOptimizationCriterion", "description" : "Base identity for TE optimization criterion." }, "TePathElement" : { "type" : "object", "properties" : { "asNumber" : { "type" : "integer", "format" : "int32", "description" : "AS number" }, "interfaceId" : { "type" : "integer", "format" : "int64", "description" : "The interface identifier" }, "routerId" : { "description" : "A router-id address", "$ref" : "#/definitions/IpAddress" }, "v4Address" : { "description" : "An IPv4 address. This address is treated as a prefix based on the prefix length value below. Bits beyond the prefix are ignored on receipt and SHOULD be set to zero on transmission.", "$ref" : "#/definitions/Ipv4Address" }, "v4Loose" : { "type" : "boolean", "description" : "Describes whether the object is loose if set, or otherwise strict" }, "v4PrefixLength" : { "type" : "integer", "format" : "int32", "description" : "Length in bits of the IPv4 prefix" }, "v6Address" : { "description" : "An IPv6 address. This address is treated as a prefix based on the prefix length value below. Bits beyond the prefix are ignored on receipt and SHOULD be set to zero on transmission.", "$ref" : "#/definitions/Ipv6Address" }, "v6Loose" : { "type" : "boolean", "description" : "Describes whether the object is loose if set, or otherwise strict" }, "v6PrefixLength" : { "type" : "integer", "format" : "int32", "description" : "Length in bits of the IPv4 prefix" }, "value" : { "type" : "integer", "format" : "int64", "description" : "the label value" } }, "title" : "TePathElement", "description" : "A group of attributes defining an element in a TE path such as TE node, TE link, TE atomic resource or label." }, "TePerformanceMetric" : { "type" : "object", "title" : "TePerformanceMetric", "description" : "This feature indicates that the system supports TE performance metric." }, "TeSrlgs" : { "type" : "object", "properties" : { "value" : { "type" : "array", "description" : "SRLG value.", "items" : { "$ref" : "#/definitions/Srlg" } } }, "title" : "TeSrlgs", "description" : "A list of SLRGs." }, "TeTemplateName" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "TeTemplateName", "description" : "A type for the name of a TE node template or TE link template." }, "TeTerminationPointAugment" : { "type" : "object", "properties" : { "te" : { "description" : "Indicates TE support.", "$ref" : "#/definitions/TeTerminationPointAugmentTe" } }, "title" : "TeTerminationPointAugment", "description" : "Augmentation for TE termination point." }, "TeTerminationPointAugmentTe" : { "type" : "object", "required" : [ "teTpId" ], "properties" : { "config" : { "description" : "Configuration data.", "$ref" : "#/definitions/TeTerminationPointAugmentTeConfig" }, "state" : { "description" : "Operational state data.", "$ref" : "#/definitions/TeTerminationPointAugmentTeState" }, "teTpId" : { "description" : "An identifier to uniquely identify a TE termination point.", "$ref" : "#/definitions/TeTpId" } }, "title" : "TeTerminationPointAugmentTe", "description" : "Indicates TE support." }, "TeTerminationPointAugmentTeConfig" : { "type" : "object", "properties" : { "teTerminationPointConfig" : { "description" : "TE termination point configuration grouping.", "$ref" : "#/definitions/TeTerminationPointConfig" } }, "title" : "TeTerminationPointAugmentTeConfig", "description" : "Configuration data." }, "TeTerminationPointAugmentTeState" : { "type" : "object", "properties" : { "teTerminationPointConfig" : { "description" : "TE termination point configuration grouping.", "$ref" : "#/definitions/TeTerminationPointConfig" } }, "title" : "TeTerminationPointAugmentTeState", "description" : "Operational state data." }, "TeTerminationPointConfig" : { "type" : "object", "properties" : { "interLayerLockId" : { "type" : "integer", "format" : "int64", "description" : "Inter layer lock ID, used for path computation in a TE topology covering multiple layers or multiple regions." }, "interfaceSwitchingCapabilityList" : { "description" : "List of Interface Switching Capabilities Descriptors (ISCD)", "$ref" : "#/definitions/InterfaceSwitchingCapabilityList" }, "schedules" : { "description" : "A list of schedules defining when a particular configuration takes effect.", "$ref" : "#/definitions/Schedules" } }, "title" : "TeTerminationPointConfig", "description" : "TE termination point configuration grouping." }, "TeTopologiesAugment" : { "type" : "object", "properties" : { "te" : { "description" : "Indicates TE support.", "$ref" : "#/definitions/TeTopologiesAugmentTe" } }, "title" : "TeTopologiesAugment", "description" : "Augmentation for TE topologies." }, "TeTopologiesAugmentTe" : { "type" : "object", "properties" : { "templates" : { "description" : "Configuration parameters for templates used for TE topology.", "$ref" : "#/definitions/Templates" } }, "title" : "TeTopologiesAugmentTe", "description" : "Indicates TE support." }, "TeTopologyAugment" : { "type" : "object", "properties" : { "te" : { "description" : "Indicates TE support.", "$ref" : "#/definitions/TeTopologyAugmentTe" } }, "title" : "TeTopologyAugment", "description" : "Augmentation for TE topology." }, "TeTopologyAugmentTe" : { "type" : "object", "required" : [ "clientId", "providerId", "teTopologyId" ], "properties" : { "clientId" : { "description" : "An identifier to uniquely identify a client.", "$ref" : "#/definitions/TeGlobalId" }, "config" : { "description" : "Configuration data.", "$ref" : "#/definitions/TeTopologyAugmentTeConfig" }, "providerId" : { "description" : "An identifier to uniquely identify a provider.", "$ref" : "#/definitions/TeGlobalId" }, "state" : { "description" : "Operational state data.", "$ref" : "#/definitions/TeTopologyAugmentTeState" }, "teTopologyId" : { "description" : "It is presumed that a datastore will contain many topologies. To distinguish between topologies it is vital to have UNIQUE topology identifiers.", "$ref" : "#/definitions/TeTopologyId" } }, "title" : "TeTopologyAugmentTe", "description" : "Indicates TE support." }, "TeTopologyAugmentTeConfig" : { "type" : "object", "properties" : { "teTopologyConfig" : { "description" : "TE topology configuration grouping.", "$ref" : "#/definitions/TeTopologyConfig" } }, "title" : "TeTopologyAugmentTeConfig", "description" : "Configuration data." }, "TeTopologyAugmentTeState" : { "type" : "object", "properties" : { "teTopologyConfig" : { "description" : "TE topology configuration grouping.", "$ref" : "#/definitions/TeTopologyConfig" } }, "title" : "TeTopologyAugmentTeState", "description" : "Operational state data." }, "TeTopologyConfig" : { "type" : "object", "properties" : { "optimizationCriterion" : { "description" : "Optimization criterion applied to this topology.", "$ref" : "#/definitions/TeOptimizationCriterion" }, "preference" : { "type" : "integer", "format" : "int32", "description" : "Specifies a preference for this topology. A lower number indicates a higher preference." }, "schedules" : { "description" : "Container of a schedule list defining when a particular configuration takes effect.", "$ref" : "#/definitions/SchedulesMember" } }, "title" : "TeTopologyConfig", "description" : "TE topology configuration grouping." }, "TeTopologyHierarchy" : { "type" : "object", "title" : "TeTopologyHierarchy", "description" : "This feature indicates that the system allows underlay and/or overlay TE topology hierarchy." }, "TeTopologyId" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "TeTopologyId", "description" : "An identifier for a topology." }, "TeTopologyRef" : { "type" : "object", "properties" : { "clientIdRef" : { "type" : "string", "description" : "A reference to a client-id." }, "networkIdRef" : { "type" : "string", "description" : "A reference to a network-id in base ietf-network module." }, "providerIdRef" : { "type" : "string", "description" : "A reference to a provider-id." }, "teTopologyIdRef" : { "type" : "string", "description" : "A reference to a te-topology-id." } }, "title" : "TeTopologyRef", "description" : "References a TE topology." }, "TeTpId" : { "type" : "object", "properties" : { "ipAddress" : { "$ref" : "#/definitions/IpAddress" }, "uint32" : { "type" : "integer", "format" : "int64" } }, "title" : "TeTpId", "description" : "An identifier for a TE link endpoint on a node. This attribute is mapped to local or remote link identifier in RFC3630 and RFC5305." }, "Template" : { "type" : "object", "title" : "Template", "description" : "This feature indicates that the system supports template configuration." }, "TemplateAttributes" : { "type" : "object", "properties" : { "priority" : { "type" : "integer", "format" : "int32", "description" : "The preference value to resolve conflicts between different templates. When two or more templates specify values for one configuration attribute, the value from the template with the highest priority is used." }, "referenceChangePolicy" : { "type" : "string", "description" : "This attribute specifies the action taken to a configuration node that has a reference to this template.", "enum" : [ "no_action", "cascade", "not_allowed" ] } }, "title" : "TemplateAttributes", "description" : "Common attributes for all templates." }, "Templates" : { "type" : "object", "properties" : { "linkTemplate" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/LinkTemplate" } }, "nodeTemplate" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/NodeTemplate" } } }, "title" : "Templates", "description" : "Configuration parameters for templates used for TE topology." }, "Tenant" : { "type" : "object", "required" : [ "tenantName" ], "properties" : { "address" : { "type" : "string", "description" : "The mailing address for the tenant" }, "contactName" : { "type" : "string", "description" : "The contact name for the tenant" }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The customer-id associated with the tenant. This is optional and default value is 1" }, "id" : { "type" : "string", "description" : "The unique identifier for the tenant" }, "phoneNumber" : { "type" : "string", "description" : "The phone number for the tenant" }, "tenantName" : { "type" : "string", "description" : "The name of the tenant" } }, "title" : "Tenant", "description" : "A tenant is a logical group that allows the assigning of network resources" }, "TenantRequest" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "The mailing address for the tenant" }, "contactName" : { "type" : "string", "description" : "The contact name for the tenant" }, "customerId" : { "type" : "integer", "format" : "int64", "description" : "The customer-id associated with the tenant" }, "phoneNumber" : { "type" : "string", "description" : "The phone number for the tenant" } }, "title" : "TenantRequest", "description" : "A request object used to modify Tenant" }, "TerminationCapability" : { "type" : "object", "properties" : { "labelRestriction" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/LabelRestriction" } }, "linkTp" : { "type" : "string", "description" : "Link termination point." }, "maxLspBandwidth" : { "type" : "object", "additionalProperties" : { "type" : "number", "format" : "double" } } }, "title" : "TerminationCapability" }, "TerminationPoint" : { "type" : "object", "properties" : { "nspTerminationPoint" : { "description" : "Augmentation for NSP termination point", "$ref" : "#/definitions/NspTerminationPoint" }, "supportingTerminationPoint" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/SupportingTerminationPoint" } }, "tpId" : { "description" : "Termination point identifier.", "$ref" : "#/definitions/TpId" } }, "title" : "TerminationPoint" }, "TerminationPointConfig" : { "type" : "object", "properties" : { "terminationPointParams" : { "description" : "NSP termination point parameters grouping", "$ref" : "#/definitions/TerminationPointParams" } }, "title" : "TerminationPointConfig", "description" : "Configuration data" }, "TerminationPointParams" : { "type" : "object", "properties" : { "adjacencySegmentId" : { "description" : "Deprecated. Use AdjacencySegmentIdData as this only returns one entry. A list of segment ids and its destination router, flags and weight", "$ref" : "#/definitions/AdjacencySegmentId" }, "adjacencySegmentIdData" : { "description" : "A list of segment ids and its neighbor router, flags and weight", "$ref" : "#/definitions/AdjacencySegmentIdData" }, "areaIds" : { "type" : "array", "description" : "Identify the area in the network", "items" : { "type" : "string" } }, "isisLevel" : { "type" : "string", "description" : "The level attribute for ISIS", "enum" : [ "L1", "L2", "L1L2" ] }, "prefixSid" : { "$ref" : "#/definitions/PrefixSid" }, "tpId" : { "description" : "An identifier to uniquely identify a NSP termination point", "$ref" : "#/definitions/TeTpId" } }, "title" : "TerminationPointParams", "description" : "NSP termination point parameters grouping" }, "TerminationPointState" : { "type" : "object", "properties" : { "terminationPointParams" : { "description" : "NSP termination point parameters grouping", "$ref" : "#/definitions/TerminationPointParams" } }, "title" : "TerminationPointState", "description" : "Operational state data" }, "ThresholdAcceleratedAdvertisement" : { "type" : "object", "properties" : { "performanceMetricAttributes" : { "description" : "Link performance information in real time.", "$ref" : "#/definitions/PerformanceMetricAttributes" } }, "title" : "ThresholdAcceleratedAdvertisement", "description" : "When the difference between the last advertised value and current measured value exceed this threshold, anomalous announcement will be triggered." }, "ThresholdIn" : { "type" : "object", "properties" : { "performanceMetricAttributes" : { "description" : "Link performance information in real time.", "$ref" : "#/definitions/PerformanceMetricAttributes" } }, "title" : "ThresholdIn", "description" : "If the measured parameter falls inside an upper bound for all but the min delay metric (or lower bound for min-delay metric only) and the advertised value is not already inside that bound, normal (anomalous-flag cleared) announcement will be triggered." }, "ThresholdOut" : { "type" : "object", "properties" : { "performanceMetricAttributes" : { "description" : "Link performance information in real time.", "$ref" : "#/definitions/PerformanceMetricAttributes" } }, "title" : "ThresholdOut", "description" : "If the measured parameter falls outside an upper bound for all but the min delay metric (or lower bound for min-delay metric only) and the advertised value is not already outside that bound, anomalous announcement will be triggered." }, "Tier1Scheduler" : { "type" : "object", "properties" : { "scheduler" : { "description" : "The parameters of a scheduler", "$ref" : "#/definitions/Scheduler" } }, "title" : "Tier1Scheduler", "description" : "Tier1 Ingress QoS scheduler parameters" }, "Time" : { "type" : "object", "properties" : { "timeUnit" : { "type" : "string", "description" : "Unit", "enum" : [ "milliseconds", "seconds", "hours", "minutes" ] }, "value" : { "type" : "integer", "format" : "int64", "description" : "Value" } }, "title" : "Time" }, "TimeDivisionMultiplexCapable" : { "type" : "object", "properties" : { "indication" : { "type" : "string", "description" : "Indication whether the interface supports Standard or Arbitrary SONET/SDH", "enum" : [ "standard", "arbitrary" ] }, "minimumLspBandwidth" : { "type" : "number", "format" : "double", "description" : "Minimum LSP Bandwidth. Units in bytes per second." } }, "title" : "TimeDivisionMultiplexCapable", "description" : "Interface has time-division multiplex capabilities." }, "TimeRange" : { "type" : "object", "properties" : { "endTime" : { "description" : "End time", "$ref" : "#/definitions/OpticalDateAndTime" }, "startTime" : { "description" : "Start time", "$ref" : "#/definitions/OpticalDateAndTime" } }, "title" : "TimeRange", "description" : "Time range" }, "To" : { "type" : "object", "properties" : { "tpRef" : { "type" : "string", "description" : "Relative reference to destination termination point." } }, "title" : "To", "description" : "Reference to destination NTP." }, "Topology" : { "type" : "object", "properties" : { "teTopologyRef" : { "description" : "References a TE topology.", "$ref" : "#/definitions/TeTopologyRef" } }, "title" : "Topology", "description" : "When the information is processed by the system, the attributes in this container indicate which topology is used to process to generate the result information." }, "TpId" : { "type" : "object", "properties" : { "uri" : { "$ref" : "#/definitions/Uri" } }, "title" : "TpId", "description" : "An identifier for termination points (TPs) on a node. The precise structure of the tp-id will be up to the implementation. The identifier SHOULD be chosen such that the same termination point in a real network topology will always be identified through the same identifier, even if the model is instantiated in separate datastores. An implementation MAY choose to capture semantics in the identifier, for example to indicate the type of termination point and/or the type of node that contains the termination point." }, "TpRef" : { "type" : "object", "properties" : { "networkRef" : { "type" : "string", "description" : "Used to reference a network, for example an underlay network." }, "nodeRef" : { "type" : "string", "description" : "Used to reference a node. Nodes are identified relative to the network they are contained in." }, "tpRef" : { "type" : "string", "description" : "A type for an absolute reference to a termination point. (This type should not be used for relative references. In such a case, a relative path should be used instead.)" } }, "title" : "TpRef", "description" : "References a termination point in a specific node." }, "TrafficDataCollection" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "description" : "Toggle whether NSP traffic collection is enabled or not." }, "flowCollection" : { "description" : "NSP configuration for flow-collection telemetry parameters.", "$ref" : "#/definitions/FlowCollection" }, "linkBwTargetThreshold" : { "type" : "integer", "format" : "int32", "description" : "The target value of link bandwidth utilization in percentage to achieve after optimization. Default is 80. It can be dropped to produce more significant swings in bandwidth but there is more risk of flip-flopping between two fairly congested links. The target threshold must be less than or equal to linkBwTriggerThreshold." }, "linkBwTriggerThreshold" : { "type" : "integer", "format" : "int32", "description" : "Bandwidth threshold (in percentage) for a link to trigger re-route of LSPs. Range from 0 to 100. Default is 80. The trigger threshold must be greater than or equal to linkBwTargetThreshold." }, "source" : { "type" : "string", "description" : "The source of the traffic collection data. Options are: mdm, nfmp.", "enum" : [ "mdm", "nfmp" ] } }, "title" : "TrafficDataCollection", "description" : "Grouping of all traffic collection parameters" }, "TunnelCreationTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "consumable" : { "type" : "boolean", "description" : "Specifies whether or not the tunnel is consumable" }, "deletable" : { "type" : "boolean", "description" : "Specifies whether or not the tunnel is deletable" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "modifiable" : { "type" : "boolean", "description" : "Specifies whether or not the tunnel is modifiable" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "protection" : { "type" : "boolean", "description" : "Specifies whether or not the tunnel has a protection path. Protection path is only signalled after the primary path fails." }, "protectionType" : { "type" : "string", "description" : "Specifies path protection type. Protection path is pre-signalled and available for immediate recovery after a primary path failure.", "enum" : [ "SECONDARY", "STANDBY", "PRIMARY", "UNKNOWN" ] } }, "title" : "TunnelCreationTemplate", "description" : "The tunnel creation template controls system behaviour when automatically creating tunnels in the network. Deprecated: Please use tunnel-creation-template instead." }, "TunnelSelectionTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "bgpPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting/creating BGP tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude BGP tunnels from selection, [-1..13]" }, "canBookBwInCoreForEline" : { "type" : "boolean", "description" : "Specifies whether or not bandwidth is booked in the core for ELINE service type" }, "canCreateNewTunnel" : { "type" : "boolean", "description" : "Specifies whether or not the policy can create new tunnel" }, "canRebindTunnel" : { "type" : "boolean", "description" : "Specifies whether or not the policy can rebind tunnel" }, "canResizeExistingTunnel" : { "type" : "boolean", "description" : "Specifies whether or not the policy can resize an existing tunnel" }, "canUseExistingTunnel" : { "type" : "boolean", "description" : "Specifies whether or not the policy can use an existing tunnel" }, "consumable" : { "type" : "boolean", "description" : "Specifies whether or not the tunnel created with consumable enabled" }, "deletable" : { "type" : "boolean", "description" : "Specifies whether or not the tunnel created with deletable enabled" }, "erpPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting ERPs. A lower value indicates a higher priority. A value of -1 indicates to exclude ERPs from selection, [-1..13]" }, "frrEnabled" : { "type" : "boolean", "description" : "Specifies whether or not to enable FRR when creating the LSP. Currently, true is the only supported value" }, "grePriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting/creating GRE tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude GRE tunnels from selection, [-1..13]" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "igpConnectivityRequiredDuringPathSelection" : { "type" : "boolean", "description" : "Specifies whether or not IGP connectivity is required during path selection" }, "ldpPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting/creating LDP tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude LDP tunnels from selection, [-1..13]" }, "looseRsvpPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting loose RSVP tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude loose RSVP tunnels from selection, [-1..13]" }, "looseSrTePriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting loose SR-TE tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude loose SR-TE tunnels from selection, [-1..13]" }, "modifiable" : { "type" : "boolean", "description" : "Specifies whether or not the tunnel is created with modifiable enabled" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "oduPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting ODU tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude ODU tunnels from selection, [-1..13]" }, "pccInitiatedLspEnabled" : { "type" : "boolean", "description" : "Specifies whether or not the policy can create PCC initiated tunnel. Deprecated: Use pcc-initiated-rsvp-priority instead" }, "pccInitiatedRsvpPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting/creating PCC initiated RSVP tunnels. A lower value indicates a nhigher priority. A value of -1 indicates to exclude PCC initiated RSVP tunnels from selection, [-1..13]" }, "pccInitiatedSrTePriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting PCC initiated SR-TE tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude PCC initiated SR-TE tunnels from selection, [-1..13]" }, "protection" : { "type" : "boolean", "description" : "Specifies whether or not the tunnel has a protection path. Only applicable when creating a new LSP" }, "protectionType" : { "type" : "string", "description" : "Secondary is used when the protection path is not pre-signalled. Standby is used when the protection path is re-signalled. Primary is used when protection is disabled. Only applicable when creating a new LSP", "enum" : [ "SECONDARY", "STANDBY", "PRIMARY", "UNKNOWN" ] }, "shouldAvoidOperStateDown" : { "type" : "boolean", "description" : "Specifies whether or not the policy should avoid resource which their operational state is down" }, "srIsisPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting/creating strict SR-ISIS tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude strict SR-ISIS tunnels from selection, [-1..13]" }, "srOspfPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting/creating strict SR-OSPF tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude strict SR-OSPF tunnels from selection, [-1..13]" }, "steeringParametersExcluded" : { "type" : "array", "items" : { "$ref" : "#/definitions/SteeringParameter" } }, "steeringParametersIncluded" : { "type" : "array", "items" : { "$ref" : "#/definitions/SteeringParameter" } }, "strictRsvpPriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting/creating strict RSVP tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude strict RSVP tunnels from selection, [-1..13]" }, "strictSrTePriority" : { "type" : "integer", "format" : "int32", "description" : "Specifies the priority for selecting strict SR-TE tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude strict SR-TE tunnels from selection, [-1..13]" }, "targetIpAddressInfoList" : { "type" : "array", "items" : { "$ref" : "#/definitions/TargetIpAddressInfo" } } }, "title" : "TunnelSelectionTemplate", "description" : "The tunnel selection template controls system behaviour when selecting/creating tunnels in the network." }, "TunnelTerminationPoint" : { "type" : "object", "properties" : { "config" : { "description" : "Configuration data.", "$ref" : "#/definitions/TunnelTerminationPointConfig" }, "state" : { "description" : "Operational state data.", "$ref" : "#/definitions/TunnelTerminationPointState" }, "tunnelTpId" : { "type" : "string", "format" : "byte", "description" : "Tunnel termination point identifier." } }, "title" : "TunnelTerminationPoint" }, "TunnelTerminationPointConfig" : { "type" : "object", "properties" : { "teNodeTunnelTerminationCapability" : { "description" : "Termination capability of a tunnel termination point on a TE node.", "$ref" : "#/definitions/TeNodeTunnelTerminationCapability" } }, "title" : "TunnelTerminationPointConfig", "description" : "Configuration data." }, "TunnelTerminationPointState" : { "type" : "object", "properties" : { "teNodeTunnelTerminationCapability" : { "description" : "Termination capability of a tunnel termination point on a TE node.", "$ref" : "#/definitions/TeNodeTunnelTerminationCapability" } }, "title" : "TunnelTerminationPointState", "description" : "Operational state data." }, "TwampTest" : { "type" : "object", "properties" : { "destination" : { "type" : "string", "description" : "Destination IP address for twamp test" }, "session" : { "type" : "string", "description" : "Session name of twamp test on the node" }, "source" : { "type" : "string", "description" : "Source IP address for twamp test" } }, "title" : "TwampTest", "description" : "Object representing a single TWAMP test" }, "Underlay" : { "type" : "object", "properties" : { "teLinkStateUnderlayAttributes" : { "description" : "State attributes for te-link underlay.", "$ref" : "#/definitions/TeLinkStateUnderlayAttributes" }, "teLinkUnderlayAttributes" : { "description" : "Attributes for te-link underlay.", "$ref" : "#/definitions/TeLinkUnderlayAttributes" }, "teTopologyHierarchy" : { "$ref" : "#/definitions/TeTopologyHierarchy" } }, "title" : "Underlay", "description" : "Attributes of the te-link underlay." }, "UnderlayBackupPath" : { "type" : "object", "properties" : { "clientIdRef" : { "type" : "string", "description" : "A reference to a client-id." }, "index" : { "type" : "integer", "format" : "int64", "description" : "A sequence number to identify a backup path." }, "networkIdRef" : { "type" : "string", "description" : "A reference to a network-id in base ietf-network module." }, "pathElement" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/TePathElement" } }, "providerIdRef" : { "type" : "string", "description" : "A reference to a provider-id." }, "teTopologyIdRef" : { "type" : "string", "description" : "A reference to a te-topology-id." } }, "title" : "UnderlayBackupPath" }, "UnderlayPrimaryPath" : { "type" : "object", "properties" : { "pathElement" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/TePathElement" } }, "teTopologyRef" : { "description" : "References a TE topology.", "$ref" : "#/definitions/TeTopologyRef" } }, "title" : "UnderlayPrimaryPath", "description" : "The service path on the underlay topology that supports this link." }, "UnderlayTopology" : { "type" : "object", "properties" : { "teTopologyHierarchy" : { "$ref" : "#/definitions/TeTopologyHierarchy" }, "teTopologyRef" : { "description" : "References a TE topology.", "$ref" : "#/definitions/TeTopologyRef" } }, "title" : "UnderlayTopology", "description" : "When an abstract node encapsulates a topology, the attributes in this container point to said topology." }, "UnderlayTrailDes" : { "type" : "object", "properties" : { "tpRef" : { "description" : "References a termination point in a specific node.", "$ref" : "#/definitions/TpRef" } }, "title" : "UnderlayTrailDes", "description" : "Destination TE link of the underlay trail." }, "UnderlayTrailSrc" : { "type" : "object", "properties" : { "tpRef" : { "description" : "References a termination point in a specific node.", "$ref" : "#/definitions/TpRef" } }, "title" : "UnderlayTrailSrc", "description" : "Source TE link of the underlay trail." }, "UniPort" : { "type" : "object", "properties" : { "actualEndState" : { "type" : "string", "description" : "The current end state of this endpoint (whether it is Saved, Deployed, etc)", "enum" : [ "Saved", "Deployed" ] }, "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the service." }, "externalIds" : { "type" : "array", "items" : { "$ref" : "#/definitions/ExternalId" } }, "id" : { "type" : "string", "description" : "The unique identifier of the entity" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "name" : { "type" : "string", "description" : "The name of the service endpoint" }, "neDeploymentState" : { "type" : "string", "description" : "The current deployment state of the entity", "enum" : [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ] }, "neId" : { "type" : "string", "description" : "The identifier of the network element where the service endpoint resides" }, "neName" : { "type" : "string", "description" : "The name of the network element to which this endpoint belongs" }, "operationalState" : { "type" : "string", "description" : "The current operational state of the entity", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "portAdminState" : { "type" : "string", "description" : "The administrative state of port used by endpoint", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "portId" : { "type" : "string", "description" : "The identifier of the port upon which the service endpoint resides" }, "portName" : { "type" : "string", "description" : "The name of the port upon which the service endpoint resides" }, "portOperationalState" : { "type" : "string", "description" : "The operational state of port used by endpoint", "enum" : [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ] }, "portSpeed" : { "type" : "integer", "format" : "int64", "description" : "The bandwidth of port used by endpoint" }, "serviceId" : { "type" : "string", "description" : "The identifier of the service that uses this endpoint" } }, "title" : "UniPort" }, "UniPortConfig" : { "type" : "object", "properties" : { "adminState" : { "type" : "string", "description" : "The current administrative state of the entity", "enum" : [ "MAINTENANCE", "DOWN", "UP" ] }, "appId" : { "type" : "string", "description" : "The client-defined, custom Application ID for the entity" }, "customAttributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomAttribute" } }, "customAttributesTemplateId" : { "type" : "string", "description" : "Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template." }, "description" : { "type" : "string", "description" : "A textual description of the endpoint." }, "id" : { "type" : "string", "description" : "The UUID of the port" }, "innerTag" : { "type" : "integer", "format" : "int32", "description" : "The inner tag. Applicable to Dot1Q or QinQ ports." }, "name" : { "type" : "string", "description" : "The name of the endpoint" }, "outerTag" : { "type" : "integer", "format" : "int32", "description" : "The outer tag. Applicable to Dot1Q or QinQ ports." }, "readOnly" : { "type" : "boolean", "description" : "Specifies whether or not this request is read-only" } }, "title" : "UniPortConfig", "description" : "The UNI Port endpoint definition" }, "Uri" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "Uri", "description" : "The uri type represents a Uniform Resource Identifier (URI) as defined by STD 66. Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitive characters are set to lowercase except for hexadecimal digits, which are normalized to uppercase as described in Section 6.2.2.1. The purpose of this normalization is to help provide unique URIs. Note that this normalization is not sufficient to provide uniqueness. Two URIs that are textually distinct after this normalization may still be equivalent. Objects using the uri type may restrict the schemes that they permit. For example, 'data:' and 'urn:' schemes might not be appropriate. A zero-length URI is not a valid URI. This can be used to express 'URI absent' where required. In the value set and its semantics, this type is equivalent to the Uri SMIv2 textual convention defined in RFC 5017." }, "UrlSafeString" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "UrlSafeString" }, "User" : { "type" : "object", "required" : [ "id", "name" ], "properties" : { "id" : { "type" : "string", "description" : "The user unique identifier" }, "name" : { "type" : "string", "description" : "The user name" } }, "title" : "User", "description" : "The user defined in the system" }, "Usergroup" : { "type" : "object", "required" : [ "name" ], "properties" : { "name" : { "type" : "string", "description" : "The usergroup name" } }, "title" : "Usergroup", "description" : "The usergroup defined in the system" }, "VidRangeType" : { "type" : "object", "properties" : { "string" : { "type" : "string" } }, "title" : "VidRangeType", "description" : "A list of VLAN Ids, or non overlapping VLAN ranges, in ascending order, between 1 and 4094. This type is used to match an ordered list of VLAN Ids, or contiguous ranges of VLAN Ids. Valid VLAN Ids must be in the range 1 to 4094, and included in the list in non overlapping ascending order. For example: 1,10-100,50,500-1000" }, "VlanClassification" : { "type" : "object", "properties" : { "tagType" : { "description" : "The tag type used for VLAN classification.", "$ref" : "#/definitions/EthTagClassify" }, "vlanRange" : { "description" : "List of VLAN ID values.", "$ref" : "#/definitions/VidRangeType" }, "vlanValue" : { "description" : "VLAN ID value.", "$ref" : "#/definitions/Vlanid" } }, "title" : "VlanClassification", "description" : "A grouping which represents classification on an 802.1Q VLAN tag." }, "VlanClassificationOuterTag" : { "type" : "object", "properties" : { "vlanClassification" : { "description" : "A grouping which represents classification on an 802.1Q VLAN tag.", "$ref" : "#/definitions/VlanClassification" } }, "title" : "VlanClassificationOuterTag", "description" : "Classifies traffic using the outermost VLAN tag." }, "VlanClassificationSecondTag" : { "type" : "object", "properties" : { "vlanClassification" : { "description" : "A grouping which represents classification on an 802.1Q VLAN tag.", "$ref" : "#/definitions/VlanClassification" } }, "title" : "VlanClassificationSecondTag", "description" : "Classifies traffic using the second outermost VLAN tag." }, "VlanOperations" : { "type" : "object", "properties" : { "popTags" : { "type" : "integer", "format" : "int32", "description" : "The number of VLAN tags to pop (or swap if used in conjunction with push-tags)" }, "pushTags" : { "description" : "The VLAN tags to push (or swap if used in conjunction with pop-tags)", "$ref" : "#/definitions/PushTags" } }, "title" : "VlanOperations", "description" : "A grouping which represents VLAN operations." }, "VlanWrite" : { "type" : "object", "properties" : { "tagType" : { "description" : "The VLAN tag type to push/swap.", "$ref" : "#/definitions/EthTagType" }, "vlanValue" : { "description" : "The VLAN ID value to push/swap.", "$ref" : "#/definitions/Vlanid" } }, "title" : "VlanWrite", "description" : "A grouping which represents push/pop operations of an 802.1Q VLAN tag." }, "Vlanid" : { "type" : "object", "properties" : { "uint16" : { "type" : "integer", "format" : "int32" } }, "title" : "Vlanid", "description" : "The 12-bit VLAN-ID used in the VLAN Tag header." }, "WaitToRevertTime" : { "type" : "object", "properties" : { "time" : { "$ref" : "#/definitions/Time" } }, "title" : "WaitToRevertTime", "description" : "Wait to revert time" }, "WaitToSwitchTime" : { "type" : "object", "properties" : { "time" : { "$ref" : "#/definitions/Time" } }, "title" : "WaitToSwitchTime", "description" : "Wait to switch time" }, "WorkflowProfileInfo" : { "type" : "object", "properties" : { "blockServiceDeployment" : { "type" : "boolean", "description" : "Describes if subsequent service deployment should be blocked until workflow execution is done. True by default for workflows which are executed pre deployment. Not applicable for workflows executed post deployment." }, "continueServiceDeploymentOnError" : { "type" : "boolean", "description" : "For blocking workflow executions, describes if subsequent service deployment should continue if workflow execution fails. Only applicable for workflows which are executed pre deployment. Not applicable for workflows executed pre deletion." }, "serviceStep" : { "type" : "string", "description" : "The service action step for which Workflow profile has to be applied.", "enum" : [ "preupdate", "postupdate_success", "postupdate_failure", "postcreate_success", "postcreate_failure", "predelete", "postdelete_failure", "precreate", "postdelete_success" ] }, "workflowExecutionTimeout" : { "type" : "integer", "format" : "int32", "description" : "For blocking workflow executions, describes the max timeout in sec, within which workflow is expected to finish. Defaults to 60 sec when not provided." }, "workflowId" : { "type" : "string", "description" : "The workflow which needs to be executed" }, "workflowInputs" : { "type" : "string", "description" : "The inputs, in json string which need to be passed for the workflow execution" }, "workflowParams" : { "type" : "string", "description" : "The parameters, in json string, which need to be passed for the workflow execution" } }, "title" : "WorkflowProfileInfo", "description" : "Workflow Profile information" }, "WorkflowProfileTemplate" : { "type" : "object", "required" : [ "name" ], "properties" : { "appId" : { "type" : "string", "description" : "The client-defined custom Application ID for this object" }, "id" : { "type" : "string", "description" : "The unique identifier of the template" }, "name" : { "type" : "string", "description" : "The name of the template" }, "objectDescription" : { "type" : "string", "description" : "The description for this object" }, "workflowProfileInfo" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowProfileInfo" } } }, "title" : "WorkflowProfileTemplate", "description" : "workflow profile template" } } }