{ "openapi": "3.0.0", "info": { "title": "Network Services Platform REST API - v4", "description": "This API describes the REST interface to interact with the Network Services Platform", "contact": {}, "version": "1.0" }, "servers": [ { "url": "http://10.0.0.67:8543/sdn/api", "variables": {} } ], "paths": { "/v4/nsp/configuration/latency": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getLatency", "description": "Get NSP latency parameters", "operationId": "getLatency", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchLatency", "description": "Patch NSP latency parameters", "operationId": "patchLatency", "parameters": [], "requestBody": { "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.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLatency" }, { "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 }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/latency/{session}": { "delete": { "tags": [ "sdn-nrcp-configuration" ], "summary": "deleteLatency", "description": "API used to delete twamp tests.", "operationId": "deleteLatency", "parameters": [ { "name": "session", "in": "path", "description": "Session name for test to be removed. If session is \"all\" it will remove all tests.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/tca-config-policy": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getTcaConfigPolicy", "description": "Get TCA Policy configuration. Policies configuration include list of policies and collection enable flag", "operationId": "getTcaConfigPolicy", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchTcaConfigPolicy", "description": "Patch a TCA configuration policy by updating the parameters", "operationId": "patchTcaConfigPolicy", "parameters": [], "requestBody": { "description": "NSP configuration on SNMP TCA policy for statistic collection", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestSnmpTcaPolicyInfo" }, { "description": "NSP configuration on SNMP TCA policy for statistic collection" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/traffic-data-collection": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getTrafficDataCollection", "description": "Get NSP traffic collection parameters.", "operationId": "getTrafficDataCollection", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchTrafficDataCollection", "description": "Patch NSP traffic-collection parameters.", "operationId": "patchTrafficDataCollection", "parameters": [], "requestBody": { "description": "Grouping of all traffic collection parameters", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTrafficDataCollection" }, { "description": "Grouping of all traffic collection parameters" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/assoc-group-config": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getAssocGroupConfig", "description": "Get association group configuration parameters.", "operationId": "getAssocGroupConfig", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchAssocGroupConfig", "description": "Patch association group configuration parameters.", "operationId": "patchAssocGroupConfig", "parameters": [], "requestBody": { "description": "Grouping of all association group related parameters for IP/MPLS optimization.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestAssocGroupConfig" }, { "description": "Grouping of all association group related parameters for IP/MPLS optimization." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/bsid-generation-config": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getBsidGenerationConfig", "description": "Get BSID generation configuration parameters.", "operationId": "getBsidGenerationConfig", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchBsidGenerationConfig", "description": "Patch BSID generation configuration parameters.", "operationId": "patchBsidGenerationConfig", "parameters": [], "requestBody": { "description": "bsidGenerationConfig", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestBsidGenerationConfig" }, { "description": "bsidGenerationConfig" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/device-name-ip-service": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getDeviceNameIpService", "description": "Get NSP device name mapping parameters", "operationId": "getDeviceNameIpService", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchDeviceNameIpService", "description": "Patch NSP device name mapping parameters", "operationId": "patchDeviceNameIpService", "parameters": [], "requestBody": { "description": "Group of all device and name mapping related parameters for IP/MPLS optimization.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestDeviceNameMappingConfig" }, { "description": "Group of all device and name mapping related parameters for IP/MPLS optimization." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/lsp-bsid-generation-config": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getLspBsidGenerationConfig", "description": "Get LSP BSID generation configuration parameters.", "operationId": "getLspBsidGenerationConfig", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchLspBsidGenerationConfig", "description": "Patch LSP BSID generation configuration parameters.", "operationId": "patchLspBsidGenerationConfig", "parameters": [], "requestBody": { "description": "Define LSP related configuration.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLspBsidGenerationConfig" }, { "description": "Define LSP related configuration." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/nrcp-historical": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getNrcpHistorical", "description": "Get NSP NRCP historical parameters.", "operationId": "getNrcpHistorical", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchNrcpHistorical", "description": "Patch NSP NRCP historical parameters.", "operationId": "patchNrcpHistorical", "parameters": [], "requestBody": { "description": "Grouping of all historical related parameters for IP/MPLS optimization.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestNrcpHistorical" }, { "description": "Grouping of all historical related parameters for IP/MPLS optimization." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/configuration/sr-policy-config": { "get": { "tags": [ "sdn-nrcp-configuration" ], "summary": "getSrPolicyConfig", "description": "Get SR policy configuration parameters.", "operationId": "getSrPolicyConfig", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-nrcp-configuration" ], "summary": "patchSrPolicyConfig", "description": "Patch SR policy configuration parameters.", "operationId": "patchSrPolicyConfig", "parameters": [], "requestBody": { "description": "Grouping of all SR policy related parameters for IP/MPLS optimization.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestSrPolicyConfig" }, { "description": "Grouping of all SR policy related parameters for IP/MPLS optimization." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/generic/application-id/{id}": { "get": { "tags": [ "sdn-generic" ], "summary": "getApplicationId", "description": "Find an object by Application ID", "operationId": "getApplicationId", "parameters": [ { "name": "id", "in": "path", "description": "The Application ID of the object", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/generic/application-id/{id}/{appId}": { "put": { "tags": [ "sdn-generic" ], "summary": "setApplicationId", "description": "Set an object Application ID", "operationId": "setApplicationId", "parameters": [ { "name": "appId", "in": "path", "description": "The Application ID to be set", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier of the object", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/generic/consumed/{uuid}": { "get": { "tags": [ "sdn-generic" ], "summary": "getConsumed", "description": "Find all objects being consumed by an object", "operationId": "getConsumed", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier of the object", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/generic/find-by-external-id": { "post": { "tags": [ "sdn-generic" ], "summary": "findByExternalId", "description": "Find the unique identifier of an object given an external identifier", "operationId": "findByExternalId", "parameters": [], "requestBody": { "description": "An external identifier to the NSP.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestExternalId" }, { "description": "An external identifier to the NSP." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDatastring" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/generic/tenants/{uuid}": { "get": { "tags": [ "sdn-generic" ], "summary": "getTenants", "description": "Find all tenants assigned to an object", "operationId": "getTenants", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifiers for the object", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/generic/{uuid}": { "get": { "tags": [ "sdn-generic" ], "summary": "get", "description": "Find an object by a unique identifier", "operationId": "get", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addL2BackhaulEndpoint1", "description": "Add an endpoint to a L2 Backhaul Service", "operationId": "addL2BackhaulEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "ETH transport services access parameters", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestNspEthtSvcAccessParameters" }, { "description": "ETH transport services access parameters" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint/{endpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateL2BackhaulEndpoint1", "description": "Update endpoint of a L2 Backhaul service", "operationId": "updateL2BackhaulEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be modified", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "ETH transport services access parameters", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestNspEthtSvcAccessParameters" }, { "description": "ETH transport services access parameters" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchL2BackhaulEndpoint1", "description": "Patch endpoint of an L3 VPN service", "operationId": "patchL2BackhaulEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "ETH transport services access parameters", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestNspEthtSvcAccessParameters" }, { "description": "ETH transport services access parameters" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/ethtsvc/l2backhaul/{autoPath}": { "post": { "tags": [ "sdn-services" ], "summary": "createL2backhaul1", "description": "Create L2 Backhaul Service", "operationId": "createL2backhaul1", "parameters": [ { "name": "autoPath", "in": "path", "description": "If True SF will automatically compuate the best path and use it for service provisioning", "required": true, "style": "simple", "schema": { "type": "boolean" } } ], "requestBody": { "description": "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestBackhaulL2RequestData" }, { "description": "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/ethtsvc/l2backhaul/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateL2backhaul1", "description": "Modify L2 Backhaul service", "operationId": "updateL2backhaul1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestBackhaulL2RequestData" }, { "description": "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchL2backhaul1", "description": "Patch L2 Backhaul service", "operationId": "patchL2backhaul1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being patched", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestBackhaulL2RequestData" }, { "description": "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services": { "get": { "tags": [ "sdn-services" ], "summary": "gets1", "description": "Query all service objects", "operationId": "gets1", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/clines": { "post": { "tags": [ "sdn-services" ], "summary": "createClines1", "description": "Create a C-Line service", "operationId": "createClines1", "parameters": [], "requestBody": { "description": "The normalized IP C-Line service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestClineServiceRequest" }, { "description": "The normalized IP C-Line service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/clines/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateClines1", "description": "Modify a C-Line service", "operationId": "updateClines1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized IP C-Line service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestClineServiceRequest" }, { "description": "The normalized IP C-Line service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchClines1", "description": "Patch a C-Line service", "operationId": "patchClines1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being patched", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized IP C-Line service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestClineServiceRequest" }, { "description": "The normalized IP C-Line service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/clines/{serviceUuid}/endpoint/{endpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateClineEndpoint1", "description": "Update the endpoint of a C-Line service", "operationId": "updateClineEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be updated", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The TDM DS0 channel group definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTdmEndpointRequest" }, { "description": "The TDM DS0 channel group definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchClineEndpoint1", "description": "Patch the endpoint of a C-Line service", "operationId": "patchClineEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The TDM DS0 channel group definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTdmEndpointRequest" }, { "description": "The TDM DS0 channel group definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/components/{uuid}": { "get": { "tags": [ "sdn-services" ], "summary": "getComponents1", "description": "Retrieve inventory of service endpoints, tunnels, and physical links for the requested service UUID", "operationId": "getComponents1", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier of service", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/eaccess": { "post": { "tags": [ "sdn-services" ], "summary": "createEaccess1", "description": "Create an IP E-Access service", "operationId": "createEaccess1", "parameters": [], "requestBody": { "description": "The normalized E-Access service request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestEaccessRequestData" }, { "description": "The normalized E-Access service request" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/eaccess/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateEaccess1", "description": "Modify an IP E-Access service", "operationId": "updateEaccess1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized E-Access service request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestEaccessRequestData" }, { "description": "The normalized E-Access service request" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchEaccess1", "description": "Patch an IP E-Access service", "operationId": "patchEaccess1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being patched", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized E-Access service request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestEaccessRequestData" }, { "description": "The normalized E-Access service request" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/elans": { "post": { "tags": [ "sdn-services" ], "summary": "createElans1", "description": "Create an E-LAN VPN service", "operationId": "createElans1", "parameters": [], "requestBody": { "description": "The normalized E-LAN service request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpElanServiceRequest" }, { "description": "The normalized E-LAN service request" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/elans/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateElans1", "description": "Modify an E-LAN service", "operationId": "updateElans1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized E-LAN service request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpElanServiceRequest" }, { "description": "The normalized E-LAN service request" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchElans1", "description": "Patch an E-LAN service", "operationId": "patchElans1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized E-LAN service request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpElanServiceRequest" }, { "description": "The normalized E-LAN service request" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/elans/{serviceUuid}/endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addElanEndpoint1", "description": "Add an endpoint to an E-LAN service", "operationId": "addElanEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The Layer 2 endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL2EndpointRequest" }, { "description": "The Layer 2 endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/elans/{serviceUuid}/endpoint/{endpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateElanEndpoint1", "description": "Update the endpoint of an E-LAN service", "operationId": "updateElanEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be modified", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The Layer 2 endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL2EndpointRequest" }, { "description": "The Layer 2 endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchElanEndpoint1", "description": "Patch the endpoint of an E-LAN service", "operationId": "patchElanEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The Layer 2 endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL2EndpointRequest" }, { "description": "The Layer 2 endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/elines": { "post": { "tags": [ "sdn-services" ], "summary": "createElines1", "description": "Create an IP or optical E-Line service", "operationId": "createElines1", "parameters": [], "requestBody": { "description": "The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestElineRequestData" }, { "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 }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/elines/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateElines1", "description": "Modify an IP or optical E-Line service", "operationId": "updateElines1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestElineRequestData" }, { "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 }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchElines1", "description": "Patch an IP or optical E-Line service", "operationId": "patchElines1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being patched", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestElineRequestData" }, { "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 }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/elines/{serviceUuid}/endpoint/{endpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateElineEndpoint1", "description": "Update the endpoint of an E-Line service", "operationId": "updateElineEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be updated", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The Layer 2 endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL2EndpointRequest" }, { "description": "The Layer 2 endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchElineEndpoint1", "description": "Patch the endpoint of an E-Line service", "operationId": "patchElineEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The Layer 2 endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL2EndpointRequest" }, { "description": "The Layer 2 endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/fix-l3-vpn-vrf-membership/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateFixL3VpnVrfMembership1", "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": "updateFixL3VpnVrfMembership1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the L3-VPN service that is being corrected", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/ies": { "post": { "tags": [ "sdn-services" ], "summary": "createIes1", "description": "Create an IP IES service", "operationId": "createIes1", "parameters": [], "requestBody": { "description": "The IES service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpIesServiceRequest" }, { "description": "The IES service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateIes1", "description": "Modify an IP IES service", "operationId": "updateIes1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The IES service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpIesServiceRequest" }, { "description": "The IES service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchIes1", "description": "Patch an IP IES service", "operationId": "patchIes1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being patched", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The IES service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpIesServiceRequest" }, { "description": "The IES service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}/endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addIesEndpoint1", "description": "Add an endpoint to a IES service", "operationId": "addIesEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointRequest" }, { "description": "l3EndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}/endpoint/{endpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateIesEndpoint1", "description": "Update the endpoint of an IES service", "operationId": "updateIesEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be updated", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointRequest" }, { "description": "l3EndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchIesEndpoint1", "description": "Patch the endpoint of an IES service", "operationId": "patchIesEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointRequest" }, { "description": "l3EndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}/loopback-endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addIesLoopbackEndpoint1", "description": "Add a loop back endpoint to an IES service", "operationId": "addIesLoopbackEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The LoopBack endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLoopbackEndpointRequest" }, { "description": "The LoopBack endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/ies/{serviceUuid}/loopback-endpoint/{endpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateIesLoopbackEndpoint1", "description": "Update loop back endpoint of an IES service", "operationId": "updateIesLoopbackEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be modified", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The LoopBack endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLoopbackEndpointRequest" }, { "description": "The LoopBack endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchIesLoopbackEndpoint1", "description": "Patch loop back endpoint of an IES service", "operationId": "patchIesLoopbackEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The LoopBack endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLoopbackEndpointRequest" }, { "description": "The LoopBack endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-dci-vpns": { "post": { "tags": [ "sdn-services" ], "summary": "createL3DciVpns1", "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": "createL3DciVpns1", "parameters": [], "requestBody": { "description": "The L3 DCI service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpL3DciServiceRequest" }, { "description": "The L3 DCI service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-dcis/{serviceUuid}/endpoint/{endpointUuid}": { "patch": { "tags": [ "sdn-services" ], "summary": "patchL3DciL3Endpoint1", "description": "Patch L3 endpoint of an L3 DCI service", "operationId": "patchL3DciL3Endpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the L3 endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the L3 DCI Service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointRequest" }, { "description": "l3EndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-vpn-rt-audit": { "get": { "tags": [ "sdn-services" ], "summary": "getL3VpnRtAudit1", "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": "getL3VpnRtAudit1", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-vpns": { "post": { "tags": [ "sdn-services" ], "summary": "createL3Vpns1", "description": "Create an L3 VPN service", "operationId": "createL3Vpns1", "parameters": [], "requestBody": { "description": "The L3 VPN service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpL3ServiceRequest" }, { "description": "The L3 VPN service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateL3Vpns1", "description": "Modify an L3 VPN service", "operationId": "updateL3Vpns1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The L3 VPN service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpL3ServiceRequest" }, { "description": "The L3 VPN service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchL3Vpns1", "description": "Patch an L3 VPN service", "operationId": "patchL3Vpns1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being patched", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The L3 VPN service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpL3ServiceRequest" }, { "description": "The L3 VPN service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}/endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addL3VpnEndpoint1", "description": "Add an endpoint to an L3 VPN service", "operationId": "addL3VpnEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointRequest" }, { "description": "l3EndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateL3VpnEndpoint1", "description": "Update endpoint of an L3 VPN service", "operationId": "updateL3VpnEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be modified", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointRequest" }, { "description": "l3EndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchL3VpnEndpoint1", "description": "Patch endpoint of an L3 VPN service", "operationId": "patchL3VpnEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointRequest" }, { "description": "l3EndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}/loopback-endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addL3VpnLoopbackEndpoint1", "description": "Add a loop back endpoint to an L3 VPN service", "operationId": "addL3VpnLoopbackEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The LoopBack endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLoopbackEndpointRequest" }, { "description": "The LoopBack endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateL3VpnLoopbackEndpoint1", "description": "Update loop back endpoint of an L3 VPN service", "operationId": "updateL3VpnLoopbackEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be modified", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The LoopBack endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLoopbackEndpointRequest" }, { "description": "The LoopBack endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchL3VpnLoopbackEndpoint1", "description": "Patch loop back endpoint of an L3 VPN service", "operationId": "patchL3VpnLoopbackEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The LoopBack endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLoopbackEndpointRequest" }, { "description": "The LoopBack endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/lags": { "post": { "tags": [ "sdn-services" ], "summary": "createLags1", "description": "Create a LAG service", "operationId": "createLags1", "parameters": [], "requestBody": { "description": "The normalized LAG service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLagRequest" }, { "description": "The normalized LAG service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/lags/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateLags1", "description": "Modify an LAG service", "operationId": "updateLags1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized LAG service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLagRequest" }, { "description": "The normalized LAG service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/normalized-l3-vpns": { "post": { "tags": [ "sdn-services" ], "summary": "createNormalizedL3Vpns1", "description": "Create a normalized L3 VPN service", "operationId": "createNormalizedL3Vpns1", "parameters": [], "requestBody": { "description": "The normalized L3 VPN service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpL3ServiceNormalizedRequest" }, { "description": "The normalized L3 VPN service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/normalized-l3-vpns/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateNormalizedL3Vpns1", "description": "Modify a normalized L3 VPN service", "operationId": "updateNormalizedL3Vpns1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized L3 VPN service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpL3ServiceNormalizedRequest" }, { "description": "The normalized L3 VPN service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchNormalizedL3Vpns1", "description": "Patch a normalized L3 VPN service", "operationId": "patchNormalizedL3Vpns1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being patched", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized L3 VPN service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpL3ServiceNormalizedRequest" }, { "description": "The normalized L3 VPN service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/normalized-l3-vpns/{serviceUuid}/endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addL3VpnNormalizedEndpoint1", "description": "Add an endpoint to a normalized L3 VPN service", "operationId": "addL3VpnNormalizedEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointNormalizedRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointNormalizedRequest" }, { "description": "l3EndpointNormalizedRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/optical": { "post": { "tags": [ "sdn-services" ], "summary": "createOptical1", "description": "Create or modify an optical service", "operationId": "createOptical1", "parameters": [], "requestBody": { "description": "The normalized Optical service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticsRequest" }, { "description": "The normalized Optical service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/optical/{serviceUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateOptical1", "description": "Modify an optical service", "operationId": "updateOptical1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized Optical service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticsRequest" }, { "description": "The normalized Optical service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-services" ], "summary": "patchOptical1", "description": "Patch an optical service", "operationId": "patchOptical1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The normalized Optical service request. This object is used to create and modify service entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticsRequest" }, { "description": "The normalized Optical service request. This object is used to create and modify service entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/physical-links-on-service/{serviceUuid}": { "get": { "tags": [ "sdn-services" ], "summary": "getPhysicalLinksOnService1", "description": "Query physical links used by service", "operationId": "getPhysicalLinksOnService1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of service", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/resource-count/{tenantUuid}/{resourceType}": { "get": { "tags": [ "sdn-services" ], "summary": "getResourceCount1", "description": "getResourceCount", "operationId": "getResourceCount1", "parameters": [ { "name": "resourceType", "in": "path", "description": "The resource type to be queried", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/resourceType1" }, { "description": "The resource type to be queried" } ] } }, { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/services-on-tunnel/{tunnelUuid}": { "get": { "tags": [ "sdn-services" ], "summary": "getServicesOnTunnel1", "description": "Query services using a tunnel", "operationId": "getServicesOnTunnel1", "parameters": [ { "name": "tunnelUuid", "in": "path", "description": "The unique identifier of tunnel to query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/tenant/{uuid}": { "get": { "tags": [ "sdn-services" ], "summary": "getTenant1", "description": "getTenant", "operationId": "getTenant1", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier for the tenant to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/tunnel/{tunnelUuid}": { "get": { "tags": [ "sdn-services" ], "summary": "getTunnel1", "description": "Find a Tunnel", "operationId": "getTunnel1", "parameters": [ { "name": "tunnelUuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-services" ], "summary": "updateTunnel1", "description": "Modify a tunnel", "operationId": "updateTunnel1", "parameters": [ { "name": "tunnelUuid", "in": "path", "description": "The unique identifier of the tunnel that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "A request object used to modify tunnel entities in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestServiceTunnelRequest" }, { "description": "A request object used to modify tunnel entities in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/tunnels": { "get": { "tags": [ "sdn-services" ], "summary": "getTunnels1", "description": "Query all Tunnels", "operationId": "getTunnels1", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/tunnels-on-service/{serviceUuid}": { "get": { "tags": [ "sdn-services" ], "summary": "getTunnelsOnService1", "description": "Query service tunnels used by service", "operationId": "getTunnelsOnService1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of service", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/{serviceUuid}/endpoint/{endpointUuid}": { "delete": { "tags": [ "sdn-services" ], "summary": "deleteServiceEndpoint1", "description": "Delete a service endpoint from a service", "operationId": "deleteServiceEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/{serviceUuid}/endpoints": { "get": { "tags": [ "sdn-services" ], "summary": "getEndpoints1", "description": "Query all endpoints associated to a service object", "operationId": "getEndpoints1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier for the service to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/{uuid}": { "get": { "tags": [ "sdn-services" ], "summary": "Getget1", "description": "Find a service by a unique identifier", "operationId": "Getget1", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-services" ], "summary": "delete1", "description": "Delete a service", "operationId": "delete1", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier of the service to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/elines/{serviceUuid}/endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addElineEndpoint1", "description": "Add an endpoint to an E-Line service", "operationId": "addElineEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "elineEndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestElineEndpointRequest" }, { "description": "elineEndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-dcis/{serviceUuid}/endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addL3DciL3Endpoint1", "description": "Add an L3 endpoint to an L3 DCI service", "operationId": "addL3DciL3Endpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "l3EndpointRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3EndpointRequest" }, { "description": "l3EndpointRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-dcis/{serviceUuid}/loopback-endpoint": { "post": { "tags": [ "sdn-services" ], "summary": "addL3DciL3LoopbackEndpoint1", "description": "Add a L3 loop back endpoint to an L3 DCI service", "operationId": "addL3DciL3LoopbackEndpoint1", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the service to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The LoopBack endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLoopbackEndpointRequest" }, { "description": "The LoopBack endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/l3-dcis/{serviceUuid}/loopback-endpoint/{endpointUuid}": { "patch": { "tags": [ "sdn-services" ], "summary": "patchL3DciL3LoopbackEndpoint1", "description": "Patch loop back endpoint of an L3 DCI service", "operationId": "patchL3DciL3LoopbackEndpoint1", "parameters": [ { "name": "endpointUuid", "in": "path", "description": "The unique identifier of the service endpoint to be patched", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the L3 DCI Service to which the endpoint belongs", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The LoopBack endpoint definition", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLoopbackEndpointRequest" }, { "description": "The LoopBack endpoint definition" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataBaseService" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/services/stitch-l2-ext/{serviceUuid}/{l2extServiceUuid}/{serviceEndpointUuid}": { "put": { "tags": [ "sdn-services" ], "summary": "updateStitchL2Ext1", "description": "Stitch a L2 Extension Service to a ELine or ELAN Service", "operationId": "updateStitchL2Ext1", "parameters": [ { "name": "l2extServiceUuid", "in": "path", "description": "The unique identifier of the L2 Extension Service", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceEndpointUuid", "in": "path", "description": "The unique identifier of the connected service endpoint", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceUuid", "in": "path", "description": "The unique identifier of the L2 Service to stitch to", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/te/link/{linkId}": { "get": { "tags": [ "sdn-ietf" ], "summary": "getLink", "description": "Get TE link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point).", "operationId": "getLink", "parameters": [ { "name": "linkId", "in": "path", "description": "UUID: Identifier for a link", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/te/link/{linkUuid}": { "patch": { "tags": [ "sdn-ietf" ], "summary": "patchLink", "description": "Patch TE link by updating the configuration parameters. Supported configuration parameter(s): SRLG, Latency, AdminStatus", "operationId": "patchLink", "parameters": [ { "name": "linkUuid", "in": "path", "description": "The unique identifier of the TE link", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "TE link configuration grouping.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTeLinkConfig" }, { "description": "TE link configuration grouping." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataLink" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/te/network/{networkId}": { "get": { "tags": [ "sdn-ietf" ], "summary": "getNetwork", "description": "Get TE network. A network has a UUID, attributes, a list of nodes and a list of links.", "operationId": "getNetwork", "parameters": [ { "name": "networkId", "in": "path", "description": "UUID: Identifier for a network", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/te/networks": { "get": { "tags": [ "sdn-ietf" ], "summary": "getNetworks", "description": "Get TE networks. A list of networks where each network has a UUID.", "operationId": "getNetworks", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/te/node/{nodeId}": { "get": { "tags": [ "sdn-ietf" ], "summary": "getNode", "description": "Get TE node. A node has a UUID, attributes and a list of termination-points.", "operationId": "getNode", "parameters": [ { "name": "nodeId", "in": "path", "description": "UUID: Identifier for a node", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ietf/te/termination-point/{tpId}": { "get": { "tags": [ "sdn-ietf" ], "summary": "getTerminationPoint", "description": "Get TE termination-point. A termination-point has a UUID and attributes.", "operationId": "getTerminationPoint", "parameters": [ { "name": "tpId", "in": "path", "description": "UUID: Identifier for a termination-point", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/l2/backhaul/paths/l2-paths": { "get": { "tags": [ "sdn-backhaul-paths" ], "summary": "getL2Paths", "description": "Get L2 Path", "operationId": "getL2Paths", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mediation/ami-version-templates": { "get": { "tags": [ "sdn-mediation" ], "summary": "getAmiVersionTemplates", "description": "Fetch the template global names for all AMIs, grouped by AMI", "operationId": "getAmiVersionTemplates", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mediation/amis-versions": { "get": { "tags": [ "sdn-mediation" ], "summary": "getAmisVersions", "description": "Fetch the AMIs and the versions.", "operationId": "getAmisVersions", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mediation/augmentation-meta": { "get": { "tags": [ "sdn-mediation" ], "summary": "getAllAugmentationMeta", "description": "Query all Augmentation Meta Infos", "operationId": "getAllAugmentationMeta", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-mediation" ], "summary": "createAugmentationMeta", "description": "Create an Augmentation Meta", "operationId": "createAugmentationMeta", "parameters": [], "requestBody": { "description": "Request to update the JSON augmentation meta information for a given hierarchy and template.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestAugmentationMeta" }, { "description": "Request to update the JSON augmentation meta information for a given hierarchy and template." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataAugmentationMeta" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mediation/augmentation-meta/{id}": { "put": { "tags": [ "sdn-mediation" ], "summary": "updateAugmentationMeta", "description": "Modify an Augmentation Meta", "operationId": "updateAugmentationMeta", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the augmentation-meta that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Json file name to read the json from the file for Augmentation Meta.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestAugmentationMetaJsonFileName" }, { "description": "Json file name to read the json from the file for Augmentation Meta." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataAugmentationMeta" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-mediation" ], "summary": "deleteAugmentationMeta", "description": "Delete an Augmentation meta", "operationId": "deleteAugmentationMeta", "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the augmentation-meta that is being deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mediation/mediation-augmentation": { "post": { "tags": [ "sdn-mediation" ], "summary": "getMediationAugmentation", "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", "parameters": [], "requestBody": { "description": "Mediation Augmentation Request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestMediationAugmentationRequest" }, { "description": "Mediation Augmentation Request" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDatastring" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-list": { "post": { "tags": [ "sdn-mpls" ], "summary": "fetchLspList", "description": "Fetch RSVP or SR-TE LSP list which discovered by SDN through device management NFMP or MDM", "operationId": "fetchLspList", "parameters": [], "requestBody": { "description": "IDs: List of unique LSP identifiers", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "IDs: List of unique LSP identifiers" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataListLsp" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-path": { "post": { "tags": [ "sdn-mpls" ], "summary": "createLspPath", "description": "Asynchronous API to create MPLS LSP path (PCE Initiated only)", "operationId": "createLspPath", "parameters": [], "requestBody": { "description": "lspPathConfigRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLspPathConfigRequest" }, { "description": "lspPathConfigRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDatastring" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-path-list": { "post": { "tags": [ "sdn-mpls" ], "summary": "fetchLspPathList", "description": "Fetch MPLS LSP path list", "operationId": "fetchLspPathList", "parameters": [], "requestBody": { "description": "IDs: List of unique LSP path identifiers", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "IDs: List of unique LSP path identifiers" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataListLspPath" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-path/{pathId}": { "get": { "tags": [ "sdn-mpls" ], "summary": "getLspPath", "description": "Get MPLS LSP path", "operationId": "getLspPath", "parameters": [ { "name": "pathId", "in": "path", "description": "ID: Unique LSP path identifier", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-mpls" ], "summary": "deleteLspPath", "description": "Asynchronous API to delete MPLS LSP path(PCE Initiated only)", "operationId": "deleteLspPath", "parameters": [ { "name": "pathId", "in": "path", "description": "ID: Unique LSP path identifier", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-mpls" ], "summary": "patchLspPath", "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", "parameters": [ { "name": "pathId", "in": "path", "description": "ID: Unique LSP path identifier", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "lspPathConfigRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLspPathConfigRequest" }, { "description": "lspPathConfigRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-paths": { "get": { "tags": [ "sdn-mpls" ], "summary": "getLspPaths", "description": "Get MPLS LSP paths", "operationId": "getLspPaths", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-mpls" ], "summary": "createLspPaths", "description": "Asynchronous API to create MPLS LSP paths(PCE Initiated only)", "operationId": "createLspPaths", "parameters": [], "requestBody": { "description": "lspPathConfigRequests", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListLspPathConfigRequest" }, { "description": "lspPathConfigRequests" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataListstring" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-mpls" ], "summary": "deleteLspPaths", "description": "Asynchronous API to delete MPLS LSP paths(PCE Initiated only). List maximum size is 500.", "operationId": "deleteLspPaths", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-paths-paginated/{limit}/{page}": { "get": { "tags": [ "sdn-mpls" ], "summary": "getLspPathsPaginated", "description": "Get MPLS LSP paths", "operationId": "getLspPathsPaginated", "parameters": [ { "name": "limit", "in": "path", "description": "Size of results per page. Greater than or equal to 0", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "path", "description": "Zero-based index of result set", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp/{lspId}": { "get": { "tags": [ "sdn-mpls" ], "summary": "getLsp", "description": "Get RSVP or SR-TE LSP which discovered by SDN through device management NFMP or MDM", "operationId": "getLsp", "parameters": [ { "name": "lspId", "in": "path", "description": "ID: Unique LSP identifier", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsps": { "get": { "tags": [ "sdn-mpls" ], "summary": "getLsps", "description": "Get RSVP or SR-TE LSPs which discovered by SDN through device management NFMP or MDM", "operationId": "getLsps", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/optimization": { "post": { "tags": [ "sdn-mpls" ], "summary": "createOptimization", "description": "Trigger global concurrent optimization on PCEP LSP paths", "operationId": "createOptimization", "parameters": [], "requestBody": { "description": "IDs: List of unique LSP paths identifiers", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "IDs: List of unique LSP paths identifiers" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/resignal": { "post": { "tags": [ "sdn-mpls" ], "summary": "createResignal", "description": "Trigger resignal on a list of PCEP LSP paths", "operationId": "createResignal", "parameters": [], "requestBody": { "description": "IDs: List of unique LSP paths identifiers", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "IDs: List of unique LSP paths identifiers" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/assoc-groups": { "get": { "tags": [ "sdn-mpls" ], "summary": "getAssocGroups", "description": "Return list of PCE association groups used by the LSP paths in the system", "operationId": "getAssocGroups", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/assoc-groups-by-type/{associationGroupType}": { "get": { "tags": [ "sdn-mpls" ], "summary": "getAssocGroupsByType", "description": "Return list of PCE association groups of provided type used by the LSP paths in the system", "operationId": "getAssocGroupsByType", "parameters": [ { "name": "associationGroupType", "in": "path", "description": "Association group type", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/associationGroupType1" }, { "description": "Association group type" } ] } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-path-profile-override": { "post": { "tags": [ "sdn-mpls" ], "summary": "lspPathProfileOverride", "description": "Override path profile for both PCE and PCC initiated LSPs, note that the path profile will not be overridden if a path ID doesn't exist or the corresponding LSP configuration is invalid", "operationId": "lspPathProfileOverride", "parameters": [], "requestBody": { "description": "pathProfileOverrideRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestPathProfileOverrideRequest" }, { "description": "pathProfileOverrideRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-paths-by-tunnel-id": { "post": { "tags": [ "sdn-mpls" ], "summary": "fetchLspPathsByTunnelId", "description": "Fetch MPLS LSP paths by source-address, tunnel-id and path-type", "operationId": "fetchLspPathsByTunnelId", "parameters": [], "requestBody": { "description": "Group of attributes to identify LSP paths by source-address, tunnel-id and path-type", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLspPathsFetchRequestParameters" }, { "description": "Group of attributes to identify LSP paths by source-address, tunnel-id and path-type" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataListLspPath" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp-paths-paginated/{limit}/{index}": { "get": { "tags": [ "sdn-mpls" ], "summary": "getLspPathsPaginated", "description": "Get MPLS LSP paths", "operationId": "GetgetLspPathsPaginated", "parameters": [ { "name": "index", "in": "path", "description": "Zero-based index of result set", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "path", "description": "Size of results per page. Greater than or equal to 0", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp/paths/on-link/{linkId}/{requestType}": { "get": { "tags": [ "sdn-mpls-lsp-path" ], "summary": "getOnLink", "description": "Get MPLS LSP paths on link", "operationId": "getOnLink", "parameters": [ { "name": "linkId", "in": "path", "description": "UUID: Identifier for a link", "required": true, "style": "simple", "schema": { "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": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/requestType1" }, { "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." } ] } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp/paths/on-assoc-group/{associationGroupType}/{associationGroupId}/{associationGroupSource}": { "get": { "tags": [ "sdn-mpls-lsp-path" ], "summary": "getOnAssocGroup", "description": "Get a list of MPLS LSP paths associated with the provided association group", "operationId": "getOnAssocGroup", "parameters": [ { "name": "associationGroupId", "in": "path", "description": "Association group ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "associationGroupSource", "in": "path", "description": "Association group source", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "associationGroupType", "in": "path", "description": "Association group type", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/associationGroupType1" }, { "description": "Association group type" } ] } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp/paths/on-bsid/{bsidId}": { "get": { "tags": [ "sdn-mpls-lsp-path" ], "summary": "getOnBsid", "description": "Get MPLS LSP paths riding on a BSID", "operationId": "getOnBsid", "parameters": [ { "name": "bsidId", "in": "path", "description": "UUID: Identifier for a BSID LSP path or a candidate path", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/mpls/lsp/paths/profile-group/{profileId}/{extendedId}": { "get": { "tags": [ "sdn-mpls-lsp-path" ], "summary": "getProfileGroup", "description": "Get MPLS LSP paths assigned with the provided profile and group ID pair", "operationId": "getProfileGroup", "parameters": [ { "name": "extendedId", "in": "path", "description": "Path extended identifier. An identifier for profile association/grouping. -1 is used to ignore the extended-id, which therefore will return all LSP Path assigned with a profile regardless of group value. 0 represents no grouping assigned, which therefore will return all LSP Path not assigned to a group. This property is ignored if provided profile ID is 0.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } }, { "name": "profileId", "in": "path", "description": "Path profile identifier. An identifier of the assigned profile. Value of 0 represents no profile assigned.", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ne": { "get": { "tags": [ "sdn-ne" ], "summary": "Getgets", "description": "Query all Network Elements", "operationId": "Getgets", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ne/system/{systemId}": { "get": { "tags": [ "sdn-ne" ], "summary": "getSystem", "description": "Query a unique identifier for a Network Element by System ID", "operationId": "getSystem", "parameters": [ { "name": "systemId", "in": "path", "description": "The System ID for the Network Element to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ne/{id}": { "put": { "tags": [ "sdn-ne" ], "summary": "update", "description": "Update Network Element capabilities", "operationId": "update", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the network element", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "A request object used to modify Network Element", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestNetworkElementRequest" }, { "description": "A request object used to modify Network Element" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ne/{uuid}": { "get": { "tags": [ "sdn-ne" ], "summary": "Getget1", "description": "Find a network element by a unique identifier", "operationId": "Getget12", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/link/tp/{tpId}": { "get": { "tags": [ "sdn-nsp" ], "summary": "getLinkTp", "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", "parameters": [ { "name": "tpId", "in": "path", "description": "UUID: Identifier for a termination point", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/link/{linkId}": { "get": { "tags": [ "sdn-nsp" ], "summary": "GetgetLink", "description": "Get link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point)", "operationId": "GetgetLink", "parameters": [ { "name": "linkId", "in": "path", "description": "UUID: Identifier for a link", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/link/{linkUuid}": { "patch": { "tags": [ "sdn-nsp" ], "summary": "PatchpatchLink", "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": "PatchpatchLink", "parameters": [ { "name": "linkUuid", "in": "path", "description": "The unique identifier of the link", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "NSP link parameters grouping", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLinkParams" }, { "description": "NSP link parameters grouping" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataLink" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/network/{networkId}": { "get": { "tags": [ "sdn-nsp" ], "summary": "GetgetNetwork", "description": "Get NSP network. A network has a UUID, attributes, a list of nodes and a list of links", "operationId": "GetgetNetwork", "parameters": [ { "name": "networkId", "in": "path", "description": "UUID: Identifier for a network", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/networks": { "get": { "tags": [ "sdn-nsp" ], "summary": "GetgetNetworks", "description": "Get NSP networks. A list of networks where each network has a UUID", "operationId": "GetgetNetworks", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/node/{nodeId}": { "get": { "tags": [ "sdn-nsp" ], "summary": "GetgetNode", "description": "Get NSP node. A node has a UUID, attributes and a list of termination-points", "operationId": "GetgetNode", "parameters": [ { "name": "nodeId", "in": "path", "description": "UUID: Identifier for a node", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/nodes/router/{routerId}": { "get": { "tags": [ "sdn-nsp" ], "summary": "getNodesRouter", "description": "Get NSP nodes by IGP Router ID. A node has a UUID, attributes and a list of termination-points", "operationId": "getNodesRouter", "parameters": [ { "name": "routerId", "in": "path", "description": "IPv4 IGP Router ID of the node", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/nodes/site/{siteIp}": { "get": { "tags": [ "sdn-nsp" ], "summary": "getNodesSite", "description": "Get NSP nodes by Site IP. A node has a UUID, attributes and a list of termination-points", "operationId": "getNodesSite", "parameters": [ { "name": "siteIp", "in": "path", "description": "IPv4 Site ID of the node", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/termination-point/{tpId}": { "get": { "tags": [ "sdn-nsp" ], "summary": "GetgetTerminationPoint", "description": "Get NSP termination-point. A termination-point has a UUID and attributes", "operationId": "GetgetTerminationPoint", "parameters": [ { "name": "tpId", "in": "path", "description": "UUID: Identifier for a termination-point", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/termination-point/{tpId}/reverse": { "get": { "tags": [ "sdn-nsp" ], "summary": "getTerminationPointReverse", "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", "parameters": [ { "name": "tpId", "in": "path", "description": "UUID: Identifier for a termination-point", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/termination-points/{nodeId}/{ipAddress}": { "get": { "tags": [ "sdn-nsp" ], "summary": "getTerminationPointsNodeip", "description": "Get NSP termination-point for a given node ID and IP Address", "operationId": "getTerminationPointsNodeip", "parameters": [ { "name": "ipAddress", "in": "path", "description": "The IP Address of the termination point", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "nodeId", "in": "path", "description": "UUID: Identifier for a node", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/links": { "post": { "tags": [ "sdn-nsp" ], "summary": "fetchLinks", "description": "Fetch link list, note that invalid input link uuids will be ignored", "operationId": "fetchLinks", "parameters": [], "requestBody": { "description": "UUIDs: List of unique identifiers for links", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "UUIDs: List of unique identifiers for links" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataListLink" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/topology-references/domain/{networkId}": { "delete": { "tags": [ "sdn-nsp" ], "summary": "deleteTopologyReferencesByDomain", "description": "Clean up topology references of all IP domains, or a specific IP domain (set networkId to -1 for all IP domains)", "operationId": "deleteTopologyReferencesByDomain", "parameters": [ { "name": "networkId", "in": "path", "description": "UUID: An identifier for an IP domain/network, set to -1 for all IP domains", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/net/l3/topology-references/link/{linkId}": { "delete": { "tags": [ "sdn-nsp" ], "summary": "deleteTopologyReferencesByLink", "description": "Clean up topology references for a specific link identifier", "operationId": "deleteTopologyReferencesByLink", "parameters": [ { "name": "linkId", "in": "path", "description": "UUID: An identifier for a link", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/openflow/flows": { "post": { "tags": [ "sdn-openflow" ], "summary": "createFlows", "description": "Create flows", "operationId": "createFlows", "parameters": [], "requestBody": { "description": "flows", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListOpenflowFlowEntryRequest" }, { "description": "flows" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeferredResultResponseDataListOpenflowFlowEntry" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-openflow" ], "summary": "deleteFlows", "description": "Delete flows", "operationId": "deleteFlows", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "patch": { "tags": [ "sdn-openflow" ], "summary": "patchFlows", "description": "Update flow instruction", "operationId": "patchFlows", "parameters": [], "requestBody": { "description": "flows", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListOpenflowFlowUpdateEntry" }, { "description": "flows" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeferredResultResponseDataListOpenflowFlowEntry" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/openflow/flows/search": { "post": { "tags": [ "sdn-openflow" ], "summary": "getFlowsearch", "description": "Query flows based on search criteria", "operationId": "getFlowsearch", "parameters": [], "requestBody": { "description": "Search criteria", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpenflowFlowSearch" }, { "description": "Search criteria" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeferredResultResponseDataListOpenflowFlowEntry" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/openflow/flows/search-by-id": { "post": { "tags": [ "sdn-openflow" ], "summary": "getFlowsearchById", "description": "Query flows based on unique identifier", "operationId": "getFlowsearchById", "parameters": [], "requestBody": { "description": "The unique identifiers of the flows to find", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpenflowFlowSearchById" }, { "description": "The unique identifiers of the flows to find" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataListOpenflowFlowEntry" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/openflow/ports/{datapathId}": { "get": { "tags": [ "sdn-openflow" ], "summary": "getPorts", "description": "Query all ports of an openflow switch", "operationId": "getPorts", "parameters": [ { "name": "datapathId", "in": "path", "description": "The hexadecimal openflow data-path id for this switch", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/openflow/switches": { "get": { "tags": [ "sdn-openflow" ], "summary": "getSwitches", "description": "Query all openflow switches", "operationId": "getSwitches", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/openflow/switches/{neId}": { "get": { "tags": [ "sdn-openflow" ], "summary": "getSwitchesInRouter", "description": "Query all openflow switches in a router", "operationId": "getSwitchesInRouter", "parameters": [ { "name": "neId", "in": "path", "description": "The unique identifier for the selected network element router", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/openflow/tables/{datapathId}": { "get": { "tags": [ "sdn-openflow" ], "summary": "getTables", "description": "Query all tables in an openflow switch", "operationId": "getTables", "parameters": [ { "name": "datapathId", "in": "path", "description": "The hexadecimal openflow data-path id for this switch", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks": { "get": { "tags": [ "sdn-physicallinks" ], "summary": "Getgets1", "description": "Query all physical links", "operationId": "Getgets11", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks/{linkId}": { "delete": { "tags": [ "sdn-physicallinks" ], "summary": "Deletedelete", "description": "Delete an undiscovered physical link that was defined in NSP", "operationId": "Deletedelete", "parameters": [ { "name": "linkId", "in": "path", "description": "The unique identifier for the link to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks/{srcId}/{destId}": { "post": { "tags": [ "sdn-physicallinks" ], "summary": "create", "description": "Define an undicovered physical link in NSP", "operationId": "create", "parameters": [ { "name": "destId", "in": "path", "description": "The unique identifier for the destination port", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "srcId", "in": "path", "description": "The unique identifier for the source port", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks/{uuid}": { "get": { "tags": [ "sdn-physicallinks" ], "summary": "Getget2", "description": "Find a physical link by a unique identifier", "operationId": "Getget2", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks/multipoint-port/{multipointLinkId}/{portId}": { "post": { "tags": [ "sdn-physicallinks" ], "summary": "addMultipointPort", "description": "Add a port to a multipoint link", "operationId": "addMultipointPort", "parameters": [ { "name": "multipointLinkId", "in": "path", "description": "The unique identifier of the multipoint link to be modified", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "portId", "in": "path", "description": "The unique identifier of the port to add", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-physicallinks" ], "summary": "removeMultipointPort", "description": "Remove a port to a multipoint link", "operationId": "removeMultipointPort", "parameters": [ { "name": "multipointLinkId", "in": "path", "description": "The unique identifier of the multipoint link to be modified", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "portId", "in": "path", "description": "The unique identifier of the port to remove", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks/multipoint/{linkId}": { "delete": { "tags": [ "sdn-physicallinks" ], "summary": "deleteMultipoint", "description": "Delete a multipoint link that was defined in NSP", "operationId": "deleteMultipoint", "parameters": [ { "name": "linkId", "in": "path", "description": "The unique identifier for the link to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks/multipoint/{name}": { "post": { "tags": [ "sdn-physicallinks" ], "summary": "createMultipoint", "description": "Define a multipoint link in NSP between multiple ports", "operationId": "createMultipoint", "parameters": [ { "name": "name", "in": "path", "description": "The name of the multipoint link", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The unique identifiers for the connected ports", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "The unique identifiers for the connected ports" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataMultipointLink" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks/multipoint/{uuid}": { "get": { "tags": [ "sdn-physicallinks" ], "summary": "getMultipoint", "description": "Find a multipoint link by a unique identifier", "operationId": "getMultipoint", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/physicallinks/multipoints": { "get": { "tags": [ "sdn-physicallinks" ], "summary": "getMultipoints", "description": "Query all multipoint links", "operationId": "getMultipoints", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/ip-optical-correlation-policiy": { "get": { "tags": [ "sdn-policy" ], "summary": "getAllIpOpticalCorrelationPolicy", "description": "Query all IP Optical correlation policies", "operationId": "getAllIpOpticalCorrelationPolicy", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/ip-optical-correlation-policy": { "post": { "tags": [ "sdn-policy" ], "summary": "createIpOpticalCorrelationPolicy", "description": "Create an IP Optical correlation policy", "operationId": "createIpOpticalCorrelationPolicy", "parameters": [], "requestBody": { "description": "IP Optical correlation policies", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpOpticalCorrelationPolicy" }, { "description": "IP Optical correlation policies" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataIpOpticalCorrelationPolicy" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/ip-optical-correlation-policy/{policyId}": { "get": { "tags": [ "sdn-policy" ], "summary": "getIpOpticalCorrelationPolicy", "description": "Query an IP Optical correlation policy", "operationId": "getIpOpticalCorrelationPolicy", "parameters": [ { "name": "policyId", "in": "path", "description": "Policy id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-policy" ], "summary": "updateIpOpticalCorrelationPolicy", "description": "Update an IP Optical correlation policy", "operationId": "updateIpOpticalCorrelationPolicy", "parameters": [ { "name": "policyId", "in": "path", "description": "The unique ID of the policy that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "IP Optical correlation policies", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIpOpticalCorrelationPolicy" }, { "description": "IP Optical correlation policies" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-policy" ], "summary": "deleteIpOpticalCorrelationPolicy", "description": "Delete an IP Optical correlation policy", "operationId": "deleteIpOpticalCorrelationPolicy", "parameters": [ { "name": "policyId", "in": "path", "description": "Policy id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/rd-rt-ranges": { "get": { "tags": [ "sdn-policy" ], "summary": "getAllRdRtRanges", "description": "Query all L3VPN RT/RD policies", "operationId": "getAllRdRtRanges", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-policy" ], "summary": "createRdRtRanges", "description": "Create a L3VPN RT/RD policy", "operationId": "createRdRtRanges", "parameters": [], "requestBody": { "description": "L3VPN RT/RD policy", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3vpnRdRtPolicy" }, { "description": "L3VPN RT/RD policy" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataL3vpnRdRtPolicy" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/rd-rt-ranges/{policyId}": { "put": { "tags": [ "sdn-policy" ], "summary": "updateRdRtRanges", "description": "Update a L3VPN RT/RD policy", "operationId": "updateRdRtRanges", "parameters": [ { "name": "policyId", "in": "path", "description": "The unique ID of the policy that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "L3VPN RT/RD policy", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3vpnRdRtPolicy" }, { "description": "L3VPN RT/RD policy" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-policy" ], "summary": "deleteRdRtRanges", "description": "Delete an existing L3VPN RT/RD policy.", "operationId": "deleteRdRtRanges", "parameters": [ { "name": "policyId", "in": "path", "description": "policyId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/router-port-protection-group-policy": { "get": { "tags": [ "sdn-policy" ], "summary": "getAllRouterPortProtectionGroupPolicy", "description": "Query all router port protection group policies", "operationId": "getAllRouterPortProtectionGroupPolicy", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-policy" ], "summary": "createRouterPortProtectionGroupPolicy", "description": "Create a router port protection group policy", "operationId": "createRouterPortProtectionGroupPolicy", "parameters": [], "requestBody": { "description": "Router Port Protection Group policies", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestRouterPortProtectionGroupPolicy" }, { "description": "Router Port Protection Group policies" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataRouterPortProtectionGroupPolicy" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/router-port-protection-group-policy/{policyId}": { "get": { "tags": [ "sdn-policy" ], "summary": "getRouterPortProtectionGroupPolicy", "description": "Query a router port protection group policy", "operationId": "getRouterPortProtectionGroupPolicy", "parameters": [ { "name": "policyId", "in": "path", "description": "Policy id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-policy" ], "summary": "updateRouterPortProtectionGroupPolicy", "description": "Update a router port protection group policy", "operationId": "updateRouterPortProtectionGroupPolicy", "parameters": [ { "name": "policyId", "in": "path", "description": "The unique ID of the policy that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Router Port Protection Group policies", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestRouterPortProtectionGroupPolicy" }, { "description": "Router Port Protection Group policies" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-policy" ], "summary": "deleteRouterPortProtectionGroupPolicy", "description": "Delete a router port protection group policy", "operationId": "deleteRouterPortProtectionGroupPolicy", "parameters": [ { "name": "policyId", "in": "path", "description": "Policy id", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/steering-parameter": { "post": { "tags": [ "sdn-policy" ], "summary": "createSteeringParameter", "description": "Create a Steering Parameter", "operationId": "createSteeringParameter", "parameters": [], "requestBody": { "description": "A steering parameter is used to mark tunnels and guide tunnel selection", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestSteeringParameter" }, { "description": "A steering parameter is used to mark tunnels and guide tunnel selection" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataSteeringParameter" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/steering-parameter/{steeringParameterName}": { "delete": { "tags": [ "sdn-policy" ], "summary": "deleteSteeringParameter", "description": "Delete a Steering Parameter", "operationId": "deleteSteeringParameter", "parameters": [ { "name": "steeringParameterName", "in": "path", "description": "The name of the Steering Parameter to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/steering-parameters": { "get": { "tags": [ "sdn-policy" ], "summary": "getSteeringParameters", "description": "Query all Steering Paramters", "operationId": "getSteeringParameters", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/tunnel-selections": { "get": { "tags": [ "sdn-policy" ], "summary": "getAllTunnelSelections", "description": "Query all tunnel selection policies.", "operationId": "getAllTunnelSelections", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-policy" ], "summary": "createTunnelSelections", "description": "Create a tunnel selection policy.", "operationId": "createTunnelSelections", "parameters": [], "requestBody": { "description": "The tunnel selection template controls system behaviour when selecting/creating tunnels in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTunnelSelectionTemplate" }, { "description": "The tunnel selection template controls system behaviour when selecting/creating tunnels in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataTunnelSelectionTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/tunnel-selections/{policyId}": { "get": { "tags": [ "sdn-policy" ], "summary": "getTunnelSelections", "description": "Query a tunnel selections policy by its unique identifier.", "operationId": "getTunnelSelections", "parameters": [ { "name": "policyId", "in": "path", "description": "policyId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-policy" ], "summary": "updateTunnelSelections", "description": "Update a tunnel selection policy.", "operationId": "updateTunnelSelections", "parameters": [ { "name": "policyId", "in": "path", "description": "The unique ID of the policy that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The tunnel selection template controls system behaviour when selecting/creating tunnels in the network.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTunnelSelectionTemplate" }, { "description": "The tunnel selection template controls system behaviour when selecting/creating tunnels in the network." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-policy" ], "summary": "deleteTunnelSelections", "description": "Delete an existing tunnel selections policy.", "operationId": "deleteTunnelSelections", "parameters": [ { "name": "policyId", "in": "path", "description": "policyId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/policy/all-connection-profile/{neId}": { "get": { "tags": [ "sdn-policy" ], "summary": "getAllConnectionProfile", "description": "Query all connection profile objects", "operationId": "getAllConnectionProfile", "parameters": [ { "name": "neId", "in": "path", "description": "The unique identifier of the network element to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports": { "get": { "tags": [ "sdn-ports" ], "summary": "Getgets2", "description": "Find all ports in the network", "operationId": "Getgets2", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/ne-all-by-tenant/{neId}/tenant/{tenantUuid}": { "get": { "tags": [ "sdn-ports" ], "summary": "getNeAllByTenant", "description": "getNeAllByTenant", "operationId": "getNeAllByTenant", "parameters": [ { "name": "neId", "in": "path", "description": "The unique identifier of the network element to be queried", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/ne-all/{neId}": { "get": { "tags": [ "sdn-ports" ], "summary": "getNeAll", "description": "Query all ports of the provided network element", "operationId": "getNeAll", "parameters": [ { "name": "neId", "in": "path", "description": "The unique identifier of the network element to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/ne-by-tenant/{neId}/servicetype/{serviceType}/tenant/{tenantUuid}": { "get": { "tags": [ "sdn-ports" ], "summary": "getNeByTenant", "description": "getNeByTenant", "operationId": "getNeByTenant", "parameters": [ { "name": "neId", "in": "path", "description": "The unique identifier of the network element to be queried", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceType", "in": "path", "description": "The service type for the port to be queried", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/serviceType51" }, { "description": "The service type for the port to be queried" } ] } }, { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/ne/{neUuid}/servicetype/{serviceType}": { "get": { "tags": [ "sdn-ports" ], "summary": "getNe", "description": "Query all ports of the provided network element of a service type", "operationId": "getNe", "parameters": [ { "name": "neUuid", "in": "path", "description": "The unique identifier of the network element to be queried", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceType", "in": "path", "description": "The service type for the port to be queried", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/serviceType51" }, { "description": "The service type for the port to be queried" } ] } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/service-count-on-port/{portUuid}": { "get": { "tags": [ "sdn-ports" ], "summary": "getServiceCountOnPort", "description": "Find number of services on a specified port", "operationId": "getServiceCountOnPort", "parameters": [ { "name": "portUuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/services-on-port/{portUuid}": { "get": { "tags": [ "sdn-ports" ], "summary": "getServicesOnPort", "description": "Query all services using a port", "operationId": "getServicesOnPort", "parameters": [ { "name": "portUuid", "in": "path", "description": "The unique identifier of the port to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/servicetype/{serviceType}": { "get": { "tags": [ "sdn-ports" ], "summary": "getServicetype", "description": "Find all ports in the network that support a given service type", "operationId": "getServicetype", "parameters": [ { "name": "serviceType", "in": "path", "description": "The service type for the port to be queried", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/serviceType51" }, { "description": "The service type for the port to be queried" } ] } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/servicetype/{serviceType}/tenant/{tenantUuid}": { "get": { "tags": [ "sdn-ports" ], "summary": "getServicetypeByTenant", "description": "getServicetypeByTenant", "operationId": "getServicetypeByTenant", "parameters": [ { "name": "serviceType", "in": "path", "description": "The service type for the port to be queried", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/serviceType51" }, { "description": "The service type for the port to be queried" } ] } }, { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/tenant/{tenantUuid}": { "get": { "tags": [ "sdn-ports" ], "summary": "GetgetTenant", "description": "getTenant", "operationId": "GetgetTenant", "parameters": [ { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/{id}": { "put": { "tags": [ "sdn-ports" ], "summary": "Putupdate", "description": "Update the port", "operationId": "Putupdate", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the port to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "A request object used to modify Port", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestPortRequest" }, { "description": "A request object used to modify Port" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataPort" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/ports/{portUuid}": { "get": { "tags": [ "sdn-ports" ], "summary": "Getget3", "description": "Find a port by unique identifier", "operationId": "Getget3", "parameters": [ { "name": "portUuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/security/authentication": { "get": { "tags": [ "sdn-security" ], "summary": "getAuthentication", "description": "Retrieve information about the currently-authenticated user from the perspective of the system", "operationId": "getAuthentication", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/servicedebug/constraint-test/{serviceUuid}": { "post": { "tags": [ "sdn-service-debug" ], "summary": "createConstraintTest", "description": "BETA - Run service constraint test", "operationId": "createConstraintTest", "parameters": [ { "name": "serviceUuid", "in": "path", "description": "The UUID of service to run constraint test on", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/servicedebug/dci-recompute/{serviceUuid}": { "post": { "tags": [ "sdn-service-debug" ], "summary": "createDciRecompute", "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", "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": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/servicedebug/trigger-ttz-algorithm": { "post": { "tags": [ "sdn-service-debug" ], "summary": "createTriggerTtzAlgorithm", "description": "Trigger the Transport Tech Zone Topology computation", "operationId": "createTriggerTtzAlgorithm", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/system/isMaster": { "get": { "tags": [ "sdn-system" ], "summary": "isMaster", "description": "NSP server is master", "operationId": "isMaster", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/system/plugin-connect/{pluginName}/{pluginVId}/{pluginKey}": { "put": { "tags": [ "sdn-system" ], "summary": "setPluginConnect", "description": "BETA: Forces NSP Plugin to form a specific connection", "operationId": "setPluginConnect", "parameters": [ { "name": "pluginKey", "in": "path", "description": "The key for the target plugin for example IP Address", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "pluginName", "in": "path", "description": "The name of the plugin", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/pluginName1" }, { "description": "The name of the plugin" } ] } }, { "name": "pluginVId", "in": "path", "description": "The virtual identifier for the target plugin", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/system/resync-nms": { "get": { "tags": [ "sdn-system" ], "summary": "resyncNms", "description": "Triggers a data synchronization with the connected NMS", "operationId": "resyncNms", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/system/resync-object/{uuid}": { "get": { "tags": [ "sdn-system" ], "summary": "resyncObject", "description": "Triggers a data synchronization with the connected NMS on a specific object", "operationId": "resyncObject", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier of the object to be synchronized", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/system/state": { "get": { "tags": [ "sdn-system" ], "summary": "getState", "description": "Retrieves the state of the system", "operationId": "getState", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/system/version": { "get": { "tags": [ "sdn-system" ], "summary": "getVersion", "description": "Retrieves the version of the system", "operationId": "getVersion", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/cline-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllClineServices", "description": "Query all C-Line service creation templates", "operationId": "getAllClineServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createClineServices", "description": "Create a C-Line service creation template", "operationId": "createClineServices", "parameters": [], "requestBody": { "description": "This template is used during C-Line service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestClineServiceCreationTemplate" }, { "description": "This template is used during C-Line service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataClineServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/cline-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getClineServices", "description": "Find a C-Line service creation template by its unique identifier", "operationId": "getClineServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateClineServices", "description": "Modify a C-Line service creation template", "operationId": "updateClineServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during C-Line service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestClineServiceCreationTemplate" }, { "description": "This template is used during C-Line service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteClineServices", "description": "Delete a C-Line service creation template", "operationId": "deleteClineServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/custom-attributes": { "get": { "tags": [ "sdn-template" ], "summary": "getAllCustomAttributes", "description": "Query all Custom Attributes templates", "operationId": "getAllCustomAttributes", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createCustomAttributes", "description": "Create a Custom Attributes template", "operationId": "createCustomAttributes", "parameters": [], "requestBody": { "description": "custom attributes template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestCustomAttributesTemplate" }, { "description": "custom attributes template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataCustomAttributesTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/custom-attributes/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getCustomAttributes", "description": "Find a Custom Attributes template by its unique identifier", "operationId": "getCustomAttributes", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateCustomAttributes", "description": "Modify a Custom Attributes template", "operationId": "updateCustomAttributes", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique identifier of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "custom attributes template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestCustomAttributesTemplate" }, { "description": "custom attributes template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteCustomAttributes", "description": "Delete a Custom Attributes template", "operationId": "deleteCustomAttributes", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/elan-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllElanServices", "description": "Query all E-LAN service creation templates", "operationId": "getAllElanServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createElanServices", "description": "Create an E-LAN service creation template", "operationId": "createElanServices", "parameters": [], "requestBody": { "description": "This template is used during E-LAN service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestElanServiceCreationTemplate" }, { "description": "This template is used during E-LAN service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataElanServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/elan-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getElanServices", "description": "Find an E-LAN service creation template by its unique identifier", "operationId": "getElanServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateElanServices", "description": "Modify an E-LAN service creation template", "operationId": "updateElanServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during E-LAN service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestElanServiceCreationTemplate" }, { "description": "This template is used during E-LAN service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteElanServices", "description": "Delete an E-LAN service creation template", "operationId": "deleteElanServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/eline-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllElineServices", "description": "Query all E-Line service creation templates", "operationId": "getAllElineServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createElineServices", "description": "Create an E-Line service creation template", "operationId": "createElineServices", "parameters": [], "requestBody": { "description": "This template is used during E-Line service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestElineServiceCreationTemplate" }, { "description": "This template is used during E-Line service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataElineServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/eline-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getElineServices", "description": "Find an E-Line service creation template by its unique identifier", "operationId": "getElineServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateElineServices", "description": "Modify an E-Line service creation template", "operationId": "updateElineServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during E-Line service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestElineServiceCreationTemplate" }, { "description": "This template is used during E-Line service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteElineServices", "description": "Delete an E-Line service creation template", "operationId": "deleteElineServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/generic-qos": { "get": { "tags": [ "sdn-template" ], "summary": "getAllGenericQos", "description": "Query all generic QoS profiles.", "operationId": "getAllGenericQos", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createGenericQos", "description": "Create a Generic QoS Profile", "operationId": "createGenericQos", "parameters": [], "requestBody": { "description": "The Generic QoS Profile (GQP), which applies to L2 and L3 access interfaces.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestQosProfile" }, { "description": "The Generic QoS Profile (GQP), which applies to L2 and L3 access interfaces." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataQosProfile" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/generic-qos-profiles/{neId}": { "get": { "tags": [ "sdn-template" ], "summary": "getGenericQosProfiles", "description": "Query all generic QoS profiles of the provided network element", "operationId": "getGenericQosProfiles", "parameters": [ { "name": "neId", "in": "path", "description": "The unique identifier of the network element to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/generic-qos/{gqpId}": { "get": { "tags": [ "sdn-template" ], "summary": "getGenericQos", "description": "Find a generic QoS profile by its unique ID", "operationId": "getGenericQos", "parameters": [ { "name": "gqpId", "in": "path", "description": "gqpId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateGenericQos", "description": "Update a Generic QoS Profile", "operationId": "updateGenericQos", "parameters": [ { "name": "gqpId", "in": "path", "description": "The unique ID of the policy that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The Generic QoS Profile (GQP), which applies to L2 and L3 access interfaces.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestQosProfile" }, { "description": "The Generic QoS Profile (GQP), which applies to L2 and L3 access interfaces." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteGenericQos", "description": "Delete a Generic QoS Profile", "operationId": "deleteGenericQos", "parameters": [ { "name": "gqpId", "in": "path", "description": "gqpId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/ies-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllIesServices", "description": "Query all IES service creation templates", "operationId": "getAllIesServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createIesServices", "description": "Create an IES service creation template", "operationId": "createIesServices", "parameters": [], "requestBody": { "description": "This template is used during IES service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIesServiceCreationTemplate" }, { "description": "This template is used during IES service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataIesServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/ies-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getIesServices", "description": "Find an IES service creation template by its unique identifier", "operationId": "getIesServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateIesServices", "description": "Modify an IES service creation template", "operationId": "updateIesServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during IES service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestIesServiceCreationTemplate" }, { "description": "This template is used during IES service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteIesServices", "description": "Delete an IES service creation template", "operationId": "deleteIesServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/l2-dci-vpn-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllL2DciVpnServices", "description": "Query all L2 DCI VPN service creation templates", "operationId": "getAllL2DciVpnServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/l2-dci-vpn-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getL2DciVpnServices", "description": "Find an L2 DCI VPN service creation template by its unique identifier", "operationId": "getL2DciVpnServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateL2DciVpnServices", "description": "Modify an L2 DCI VPN service creation template", "operationId": "updateL2DciVpnServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during L2 DCI VPN service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL2DciVpnServiceCreationTemplate" }, { "description": "This template is used during L2 DCI VPN service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/l2backhaul-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllL2backhaulServices", "description": "Query all L2 Backhaul service creation templates", "operationId": "getAllL2backhaulServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createL2backhaulServices", "description": "Create an L2 backhaul service creation template", "operationId": "createL2backhaulServices", "parameters": [], "requestBody": { "description": "This template is used during L2 Backhaul service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL2backhaulServiceCreationTemplate" }, { "description": "This template is used during L2 Backhaul service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataL2backhaulServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/l2backhaul-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getL2backhaulServices", "description": "Find an L2 Backhaul service creation template by its unique identifier", "operationId": "getL2backhaulServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateL2backhaulServices", "description": "Modify an L2 Backhaul service creation template", "operationId": "updateL2backhaulServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during L2 Backhaul service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL2backhaulServiceCreationTemplate" }, { "description": "This template is used during L2 Backhaul service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteL2backhaulServices", "description": "Delete an L2 Backhaul service creation template", "operationId": "deleteL2backhaulServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/l3-dci-vpn-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllL3DciVpnServices", "description": "Query all L3 DCI VPN service creation templates", "operationId": "getAllL3DciVpnServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createL3DciVpnServices", "description": "Create an L3 DCI VPN service creation template", "operationId": "createL3DciVpnServices", "parameters": [], "requestBody": { "description": "This template is used during L3 DCI VPN service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3DciVpnServiceCreationTemplate" }, { "description": "This template is used during L3 DCI VPN service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataL3DciVpnServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/l3-dci-vpn-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getL3DciVpnServices", "description": "Find an L3 DCI VPN service creation template by its unique identifier", "operationId": "getL3DciVpnServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateL3DciVpnServices", "description": "Modify an L3 DCI VPN service creation template", "operationId": "updateL3DciVpnServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during L3 DCI VPN service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3DciVpnServiceCreationTemplate" }, { "description": "This template is used during L3 DCI VPN service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteL3DciVpnServices", "description": "Delete an L3 DCI VPN service creation template", "operationId": "deleteL3DciVpnServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/l3-vpn-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllL3VpnServices", "description": "Query all L3 VPN service creation templates", "operationId": "getAllL3VpnServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createL3VpnServices", "description": "Create an L3 VPN service creation template", "operationId": "createL3VpnServices", "parameters": [], "requestBody": { "description": "This template is used during L3 VPN service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3vpnServiceCreationTemplate" }, { "description": "This template is used during L3 VPN service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataL3vpnServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/l3-vpn-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getL3VpnServices", "description": "Find an L3 VPN service creation template by its unique identifier", "operationId": "getL3VpnServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateL3VpnServices", "description": "Modify an L3 VPN service creation template", "operationId": "updateL3VpnServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during L3 VPN service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestL3vpnServiceCreationTemplate" }, { "description": "This template is used during L3 VPN service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteL3VpnServices", "description": "Delete an L3 VPN service creation template", "operationId": "deleteL3VpnServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/lag-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllLagServices", "description": "Query all LAG service creation templates", "operationId": "getAllLagServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createLagServices", "description": "Create a LAG service creation template", "operationId": "createLagServices", "parameters": [], "requestBody": { "description": "This template is used during LAG service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLagServiceCreationTemplate" }, { "description": "This template is used during LAG service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataLagServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/lag-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getLagServices", "description": "Find a LAG service creation template by its unique identifier", "operationId": "getLagServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateLagServices", "description": "Modify a LAG service creation template", "operationId": "updateLagServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during LAG service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestLagServiceCreationTemplate" }, { "description": "This template is used during LAG service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteLagServices", "description": "Delete a LAG service creation template", "operationId": "deleteLagServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/mediation-profile-mapping": { "post": { "tags": [ "sdn-template" ], "summary": "createMediationProfileMapping", "description": "Create an Mediation profile Mapping", "operationId": "createMediationProfileMapping", "parameters": [], "requestBody": { "description": "Mediation profile that defines the Mediation and their template associations.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestMediationProfileTemplateMapping" }, { "description": "Mediation profile that defines the Mediation and their template associations." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataMediationProfileTemplateMapping" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/mediation-profile-mapping/{profileId}": { "get": { "tags": [ "sdn-template" ], "summary": "getMediationProfileMapping", "description": "Find a mediation profile mapping by its unique identifier", "operationId": "getMediationProfileMapping", "parameters": [ { "name": "profileId", "in": "path", "description": "profileId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateMediationProfileMapping", "description": "Update a mediation profile mapping", "operationId": "updateMediationProfileMapping", "parameters": [ { "name": "profileId", "in": "path", "description": "Update a mediation profile mapping", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Mediation profile that defines the Mediation and their template associations.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestMediationProfileTemplateMapping" }, { "description": "Mediation profile that defines the Mediation and their template associations." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteMediationProfileMapping", "description": "Delete an Mediation profile mapping", "operationId": "deleteMediationProfileMapping", "parameters": [ { "name": "profileId", "in": "path", "description": "profileId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/mediation-profile-mappings": { "get": { "tags": [ "sdn-template" ], "summary": "getAllMediationProfileMappings", "description": "Query all mediation profile mappings", "operationId": "getAllMediationProfileMappings", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/nfmp-template": { "get": { "tags": [ "sdn-template" ], "summary": "getNfmpTemplate", "description": "Query NFM-P system scripts. Some of these scripts may be used for service creation or modification.", "operationId": "getNfmpTemplate", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/och-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllOchServices", "description": "Query all OCH service creation templates", "operationId": "getAllOchServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createOchServices", "description": "Create an OCH service creation template", "operationId": "createOchServices", "parameters": [], "requestBody": { "description": "This template is used during OCH service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOchServiceCreationTemplate" }, { "description": "This template is used during OCH service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataOchServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/och-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getOchServices", "description": "Find an OCH service creation template by its unique identifier", "operationId": "getOchServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateOchServices", "description": "Modify an OCH service creation template", "operationId": "updateOchServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique identifier of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during OCH service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOchServiceCreationTemplate" }, { "description": "This template is used during OCH service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteOchServices", "description": "Delete an OCH service creation template", "operationId": "deleteOchServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/odu-services": { "get": { "tags": [ "sdn-template" ], "summary": "getAllOduServices", "description": "Query all ODU service creation templates", "operationId": "getAllOduServices", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createOduServices", "description": "Create an ODU service creation template", "operationId": "createOduServices", "parameters": [], "requestBody": { "description": "This template is used during ODU service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOduServiceCreationTemplate" }, { "description": "This template is used during ODU service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataOduServiceCreationTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/odu-services/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getOduServices", "description": "Find an ODU service creation template by its unique identifier", "operationId": "getOduServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateOduServices", "description": "Modify an ODU service creation template", "operationId": "updateOduServices", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "This template is used during ODU service creation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOduServiceCreationTemplate" }, { "description": "This template is used during ODU service creation" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteOduServices", "description": "Delete an ODU service creation template", "operationId": "deleteOduServices", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/optical-connectivity-constraint": { "get": { "tags": [ "sdn-template" ], "summary": "getAllOpticalConnectivityConstraint", "description": "Query all optical connectivity constraint templates", "operationId": "getAllOpticalConnectivityConstraint", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createOpticalConnectivityConstraint", "description": "Create an optical connectivity constraint creation template", "operationId": "createOpticalConnectivityConstraint", "parameters": [], "requestBody": { "description": "Optical connectivity constraint template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticalConnectivityConstraintTemplate" }, { "description": "Optical connectivity constraint template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataOpticalConnectivityConstraintTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/optical-connectivity-constraint/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getOpticalConnectivityConstraint", "description": "Find an optical connectivity constraint creation template by its unique identifier", "operationId": "getOpticalConnectivityConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateOpticalConnectivityConstraint", "description": "Modify an optical connectivity constraint creation template", "operationId": "updateOpticalConnectivityConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Optical connectivity constraint template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticalConnectivityConstraintTemplate" }, { "description": "Optical connectivity constraint template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteOpticalConnectivityConstraint", "description": "Delete an optical connectivity constraint creation template", "operationId": "deleteOpticalConnectivityConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/optical-connectivity-service": { "get": { "tags": [ "sdn-template" ], "summary": "getAllOpticalConnectivityService", "description": "Query all optical connectivity service templates", "operationId": "getAllOpticalConnectivityService", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createOpticalConnectivityService", "description": "Create an optical connectivity service creation template", "operationId": "createOpticalConnectivityService", "parameters": [], "requestBody": { "description": "Optical connectivity service template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticalConnectivityServiceTemplate" }, { "description": "Optical connectivity service template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataOpticalConnectivityServiceTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/optical-connectivity-service/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getOpticalConnectivityService", "description": "Find an optical connectivity service creation template by its unique identifier", "operationId": "getOpticalConnectivityService", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateOpticalConnectivityService", "description": "Modify an optical connectivity service creation template", "operationId": "updateOpticalConnectivityService", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Optical connectivity service template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticalConnectivityServiceTemplate" }, { "description": "Optical connectivity service template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteOpticalConnectivityService", "description": "Delete an optical connectivity service creation template", "operationId": "deleteOpticalConnectivityService", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/optical-resilience-constraint": { "get": { "tags": [ "sdn-template" ], "summary": "getAllOpticalResilienceConstraint", "description": "Query all optical resilience constraint templates", "operationId": "getAllOpticalResilienceConstraint", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createOpticalResilienceConstraint", "description": "Create an optical resilience constraint creation template", "operationId": "createOpticalResilienceConstraint", "parameters": [], "requestBody": { "description": "Optical resilience constraint template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticalResilienceConstraintTemplate" }, { "description": "Optical resilience constraint template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataOpticalResilienceConstraintTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/optical-resilience-constraint/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getOpticalResilienceConstraint", "description": "Find an optical resilience constraint creation template by its unique identifier", "operationId": "getOpticalResilienceConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateOpticalResilienceConstraint", "description": "Modify an optical resilience constraint creation template", "operationId": "updateOpticalResilienceConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Optical resilience constraint template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticalResilienceConstraintTemplate" }, { "description": "Optical resilience constraint template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteOpticalResilienceConstraint", "description": "Delete an optical resilience constraint creation template", "operationId": "deleteOpticalResilienceConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/optical-routing-constraint": { "get": { "tags": [ "sdn-template" ], "summary": "getAllOpticalRoutingConstraint", "description": "Query all optical routing constraint templates", "operationId": "getAllOpticalRoutingConstraint", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createOpticalRoutingConstraint", "description": "Create an optical routing constraint creation template", "operationId": "createOpticalRoutingConstraint", "parameters": [], "requestBody": { "description": "Optical routing constraint template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticalRoutingConstraintTemplate" }, { "description": "Optical routing constraint template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataOpticalRoutingConstraintTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/optical-routing-constraint/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getOpticalRoutingConstraint", "description": "Find an optical routing constraint creation template by its unique identifier", "operationId": "getOpticalRoutingConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateOpticalRoutingConstraint", "description": "Modify an optical routing constraint creation template", "operationId": "updateOpticalRoutingConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Optical routing constraint template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestOpticalRoutingConstraintTemplate" }, { "description": "Optical routing constraint template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteOpticalRoutingConstraint", "description": "Delete an optical routing constraint creation template", "operationId": "deleteOpticalRoutingConstraint", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/path-profiles": { "get": { "tags": [ "sdn-template" ], "summary": "getAllPathProfiles", "description": "Query all path profile templates", "operationId": "getAllPathProfiles", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createPathProfiles", "description": "Create a path profile template", "operationId": "createPathProfiles", "parameters": [], "requestBody": { "description": "The path profile template controls computation parameters for creating paths in the network", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestPathProfileTemplate" }, { "description": "The path profile template controls computation parameters for creating paths in the network" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataPathProfileTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/path-profiles/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getPathProfiles", "description": "Find a path profile template by its unique identifier", "operationId": "getPathProfiles", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updatePathProfiles", "description": "Update a path profile template", "operationId": "updatePathProfiles", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The path profile template controls computation parameters for creating paths in the network", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestPathProfileTemplate" }, { "description": "The path profile template controls computation parameters for creating paths in the network" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deletePathProfiles", "description": "Delete an existing path profile template", "operationId": "deletePathProfiles", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/qos": { "get": { "tags": [ "sdn-template" ], "summary": "getAllQos", "description": "Query all QoS templates", "operationId": "getAllQos", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createQos", "description": "Create a QoS template", "operationId": "createQos", "parameters": [], "requestBody": { "description": "Qos template that defines cir & pir. Also used to template certain endpoint values", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestQosTemplate" }, { "description": "Qos template that defines cir & pir. Also used to template certain endpoint values" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataQosTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/qos-policies": { "get": { "tags": [ "sdn-template" ], "summary": "getAllQosPolicies", "description": "Query all QoS policies", "operationId": "getAllQosPolicies", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/qos-policies/{neId}": { "get": { "tags": [ "sdn-template" ], "summary": "getQosPolicies", "description": "Query all QoS policies of the provided network element", "operationId": "getQosPolicies", "parameters": [ { "name": "neId", "in": "path", "description": "The unique identifier of the network element to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/qos/{templateId}": { "get": { "tags": [ "sdn-template" ], "summary": "getQos", "description": "Find a QoS template by its unique identifier", "operationId": "getQos", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateQos", "description": "Modify a QoS template", "operationId": "updateQos", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique identifier of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Qos template that defines cir & pir. Also used to template certain endpoint values", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestQosTemplate" }, { "description": "Qos template that defines cir & pir. Also used to template certain endpoint values" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteQos", "description": "Delete a QoS template", "operationId": "deleteQos", "parameters": [ { "name": "templateId", "in": "path", "description": "templateId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/router-id-system-id-mapping": { "get": { "tags": [ "sdn-template" ], "summary": "getAllRouterIdSystemIdMappings", "description": "Query all router ID system ID mapping policy", "operationId": "getAllRouterIdSystemIdMappings", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createRouterIdSystemIdMapping", "description": "Create a router ID system ID mapping policy", "operationId": "createRouterIdSystemIdMapping", "parameters": [], "requestBody": { "description": "Policy template that defines system ID and router ID mapping.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestRouterIdSystemIdMapping" }, { "description": "Policy template that defines system ID and router ID mapping." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataRouterIdSystemIdMapping" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/router-id-system-id-mapping/{policyId}": { "get": { "tags": [ "sdn-template" ], "summary": "getRouterIdSystemIdMapping", "description": "Find a router-id-system-id-mapping by its unique identifier", "operationId": "getRouterIdSystemIdMapping", "parameters": [ { "name": "policyId", "in": "path", "description": "policyId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateRouterIdSystemIdMapping", "description": "Modify a router-id-system-id-mapping policy", "operationId": "updateRouterIdSystemIdMapping", "parameters": [ { "name": "policyId", "in": "path", "description": "The unique ID of the policy that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Policy template that defines system ID and router ID mapping.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestRouterIdSystemIdMapping" }, { "description": "Policy template that defines system ID and router ID mapping." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteRouterIdSystemIdMapping", "description": "Delete a router-id-mapping policy", "operationId": "deleteRouterIdSystemIdMapping", "parameters": [ { "name": "policyId", "in": "path", "description": "policyId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/system-ip-mpls-config": { "get": { "tags": [ "sdn-template" ], "summary": "getAllSystemIpMplsConfig", "description": "Query all system IP MPLS Configuration", "operationId": "getAllSystemIpMplsConfig", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/system-ip-mpls-config/{templateId}": { "put": { "tags": [ "sdn-template" ], "summary": "updateSystemIpMplsConfig", "description": "Update a system ip mpls configuration", "operationId": "updateSystemIpMplsConfig", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the configuration that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "systemIpMplsConfig", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestSystemIpMplsConfig" }, { "description": "systemIpMplsConfig" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/tunnel-creations": { "get": { "tags": [ "sdn-template" ], "summary": "getAllTunnelCreations", "description": "Query all tunnel creation templates. Deprecated: Use get-all-tunnel-selections instead.", "operationId": "getAllTunnelCreations", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/tunnel-creations/{templateId}": { "put": { "tags": [ "sdn-template" ], "summary": "updateTunnelCreations", "description": "Modify a tunnel creation template. Deprecated: update-tunnel-selections instead.", "operationId": "updateTunnelCreations", "parameters": [ { "name": "templateId", "in": "path", "description": "The unique ID of the template that is being modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The tunnel creation template controls system behaviour when automatically creating tunnels in the network. Deprecated: Please use tunnel-creation-template instead.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTunnelCreationTemplate" }, { "description": "The tunnel creation template controls system behaviour when automatically creating tunnels in the network. Deprecated: Please use tunnel-creation-template instead." } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/workflow-profile": { "get": { "tags": [ "sdn-template" ], "summary": "getAllWorkflowProfileMappings", "description": "Query all workflow profiles", "operationId": "getAllWorkflowProfileMappings", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-template" ], "summary": "createWorkflowProfile", "description": "Create a workflow profile mapping", "operationId": "createWorkflowProfile", "parameters": [], "requestBody": { "description": "workflow profile template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestWorkflowProfileTemplate" }, { "description": "workflow profile template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataWorkflowProfileTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/template/workflow-profile/{profileId}": { "get": { "tags": [ "sdn-template" ], "summary": "getWorkflowProfile", "description": "Find a workflow profile mapping by its unique identifier", "operationId": "getWorkflowProfile", "parameters": [ { "name": "profileId", "in": "path", "description": "profileId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-template" ], "summary": "updateWorkflowProfile", "description": "Update a workflow profile mapping", "operationId": "updateWorkflowProfile", "parameters": [ { "name": "profileId", "in": "path", "description": "Update a workflow profile", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "workflow profile template", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestWorkflowProfileTemplate" }, { "description": "workflow profile template" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataWorkflowProfileTemplate" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-template" ], "summary": "deleteWorkflowProfile", "description": "Delete a workflow profile", "operationId": "deleteWorkflowProfile", "parameters": [ { "name": "profileId", "in": "path", "description": "profileId", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/tenants": { "get": { "tags": [ "sdn-tenants" ], "summary": "Getgets4", "description": "gets", "operationId": "Getgets4", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-tenants" ], "summary": "Postcreate", "description": "create", "operationId": "Postcreate", "parameters": [], "requestBody": { "description": "A tenant is a logical group that allows the assigning of network resources", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTenant" }, { "description": "A tenant is a logical group that allows the assigning of network resources" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataTenant" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/tenants/customer-all": { "get": { "tags": [ "sdn-tenants" ], "summary": "getCustomerAll", "description": "Query all Customers", "operationId": "getCustomerAll", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/tenants/customer/{customerId}": { "get": { "tags": [ "sdn-tenants" ], "summary": "getCustomer", "description": "Find a customer by customer-Id", "operationId": "getCustomer", "parameters": [ { "name": "customerId", "in": "path", "description": "The Customer-Id of the Customer", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/tenants/resync/{provider}": { "get": { "tags": [ "sdn-tenants" ], "summary": "resync", "description": "resync", "operationId": "resync", "parameters": [ { "name": "provider", "in": "path", "description": "The Identity Provider in which to resynchronize data", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/provider1" }, { "description": "The Identity Provider in which to resynchronize data" } ] } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/tenants/{tenantUuid}": { "get": { "tags": [ "sdn-tenants" ], "summary": "Getget5", "description": "get", "operationId": "Getget5", "parameters": [ { "name": "tenantUuid", "in": "path", "description": "The unique identifier for the query", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] }, "put": { "tags": [ "sdn-tenants" ], "summary": "Putupdate1", "description": "update", "operationId": "Putupdate1", "parameters": [ { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "A request object used to modify Tenant", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestTenantRequest" }, { "description": "A request object used to modify Tenant" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-tenants" ], "summary": "Deletedelete2", "description": "delete", "operationId": "Deletedelete2", "parameters": [ { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the Tenant to be deleted", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/tenants/{tenantUuid}/resources": { "get": { "tags": [ "sdn-tenants" ], "summary": "getResources", "description": "getResources", "operationId": "getResources", "parameters": [ { "name": "tenantUuid", "in": "path", "description": "The unique identifier for the tenant", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-tenants" ], "summary": "addResources", "description": "addResources", "operationId": "addResources", "parameters": [ { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "The resource unique identifier(s) to be assigned to the tenant", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "The resource unique identifier(s) to be assigned to the tenant" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-tenants" ], "summary": "deleteResources", "description": "deleteResources", "operationId": "deleteResources", "parameters": [ { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to be modified", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/tenants/{tenantUuid}/usergroup/{groupName}": { "get": { "tags": [ "sdn-tenants" ], "summary": "getUsergroup", "description": "getUsergroup", "operationId": "getUsergroup", "parameters": [ { "name": "groupName", "in": "path", "description": "The unique name of the Usergroup to be found", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to which the user is assigned", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] }, "delete": { "tags": [ "sdn-tenants" ], "summary": "deleteUsergroup", "description": "deleteUsergroup", "operationId": "deleteUsergroup", "parameters": [ { "name": "groupName", "in": "path", "description": "The unique name of the Usergroup to be removed", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to which the user is assigned", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/tenants/{tenantUuid}/usergroup/{groupName}/role/{roleType}": { "post": { "tags": [ "sdn-tenants" ], "summary": "createUsergroup", "description": "createUsergroup", "operationId": "createUsergroup", "parameters": [ { "name": "groupName", "in": "path", "description": "The unique name of the Usergroup to be assigned", "required": true, "style": "simple", "schema": { "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": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/roleType1" }, { "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." } ] } }, { "name": "tenantUuid", "in": "path", "description": "The unique identifier of the tenant to be modified", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/usergroups": { "get": { "tags": [ "sdn-usergroups" ], "summary": "Getgets5", "description": "Query all Usergroups", "operationId": "Getgets5", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/usergroups/{groupName}": { "get": { "tags": [ "sdn-usergroups" ], "summary": "Getget6", "description": "Find a Usergroup by a group name", "operationId": "Getget6", "parameters": [ { "name": "groupName", "in": "path", "description": "The unique name of the Userroup to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/usergroups/{groupName}/tenants": { "get": { "tags": [ "sdn-usergroups" ], "summary": "GetgetTenants", "description": "getTenants", "operationId": "GetgetTenants", "parameters": [ { "name": "groupName", "in": "path", "description": "The unique name of the Usergroup to be queried", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": true, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/pathtool/diagnose-lsp/{lspPathId}": { "post": { "tags": [ "sdn-path-tool" ], "summary": "diagnoseLsp", "description": "LSP Diagnosis API to run additional calculations and return a result set that may aid in determining why an LSP is operationally down. Use cases that involved grouping or association such as Diversity or Bidirectionality may return limited results. Please note that this API is currently experimental and not yet comprehensive.", "operationId": "diagnoseLsp", "parameters": [ { "name": "lspPathId", "in": "path", "description": "ID: Unique LSP path identifier", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/pathtool/diagnose-path": { "post": { "tags": [ "sdn-path-tool" ], "summary": "diagnosePath", "description": "Path Diagnosis API to invoke extra behaviour to try and determine why/what paths are found or not found. Please note that this API is currently experimental and not yet comprehensive.", "operationId": "diagnosePath", "parameters": [], "requestBody": { "description": "Point to point path request, which supports path finding from one source to one destination, and optional secondary source/destination", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestPointToPointPathRequest" }, { "description": "Point to point path request, which supports path finding from one source to one destination, and optional secondary source/destination" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataListPathAttempt" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/nsp/pathtool/find-path": { "post": { "tags": [ "sdn-path-tool" ], "summary": "findPath", "description": "Path Finder API to validate whether a path is possible without actually creating the path", "operationId": "findPath", "parameters": [], "requestBody": { "description": "Point to point path request, which supports path finding from one source to one destination, and optional secondary source/destination", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestPointToPointPathRequest" }, { "description": "Point to point path request, which supports path finding from one source to one destination, and optional secondary source/destination" } ] } } }, "required": false }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataPointToPointPathResult" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies": { "get": { "tags": [ "sdn-sr-policies" ], "summary": "get", "description": "Get SR Policies", "operationId": "Getget", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] }, "post": { "tags": [ "sdn-sr-policies" ], "summary": "create", "description": "Create SR Policies", "operationId": "Postcreate1", "parameters": [], "requestBody": { "description": "srPoliciesConfigRequests", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListSrPoliciesConfigRequest" }, { "description": "srPoliciesConfigRequests" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataListstring" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/by-key/{headend}/{endpoint}/{color}": { "get": { "tags": [ "sdn-sr-policies" ], "summary": "getByKey", "description": "Get SR Policy by key (headend, endpoint, color)", "operationId": "getByKey", "parameters": [ { "name": "color", "in": "path", "description": "Color associated with the policy", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "endpoint", "in": "path", "description": "Policy end point IP address", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "headend", "in": "path", "description": "Policy headend IP address", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/candidate-path-list": { "post": { "tags": [ "sdn-sr-policies" ], "summary": "fetchCandidatePathList", "description": "Fetch Candidate Path list", "operationId": "fetchCandidatePathList", "parameters": [], "requestBody": { "description": "candidatePathIds", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "candidatePathIds" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataCandidatePaths" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/candidate-path-resignal/{id}": { "post": { "tags": [ "sdn-sr-policies" ], "summary": "createCandidatePathResignal", "description": "Trigger resignal on a Candidate Path", "operationId": "createCandidatePathResignal", "parameters": [ { "name": "id", "in": "path", "description": "ID: An identifier to uniquely identify the Candidate Path", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/candidate-path/{candidatePathId}/admin/{adminState}": { "patch": { "tags": [ "sdn-sr-policies" ], "summary": "patchCandidatePathAdmin", "description": "Patch a Candidate Path admin status", "operationId": "patchCandidatePathAdmin", "parameters": [ { "name": "adminState", "in": "path", "description": "Candidate path administrative state, UP for enabled, DOWN for disabled, Maintenance is not supported", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/adminState461" }, { "description": "Candidate path administrative state, UP for enabled, DOWN for disabled, Maintenance is not supported" } ] } }, { "name": "candidatePathId", "in": "path", "description": "The unique identifier of the Candidate Path", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/candidate-paths/{id}": { "put": { "tags": [ "sdn-sr-policies" ], "summary": "updateCandidatePaths", "description": "Update Candidate Path. This request requires Candidate Path to be shutdown first. Add/Delete segment list(s) on the Candidate Path can be utilized for this request.", "operationId": "updateCandidatePaths", "parameters": [ { "name": "id", "in": "path", "description": "ID: An identifier to uniquely identify the Candidate Path", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "candidatePathsUpdateRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestCandidatePathsUpdateRequest" }, { "description": "candidatePathsUpdateRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/consumer/{id}": { "get": { "tags": [ "sdn-sr-policies" ], "summary": "getConsumer", "description": "Get the number of consumers on the given SR Policy", "operationId": "getConsumer", "parameters": [ { "name": "id", "in": "path", "description": "ID: An identifier to uniquely identify the SR Policy", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/on-link/{linkId}/{requestType}": { "get": { "tags": [ "sdn-sr-policies" ], "summary": "getOnLink", "description": "Get SR Policies on link", "operationId": "GetgetOnLink", "parameters": [ { "name": "linkId", "in": "path", "description": "UUID: Identifier for a link", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "requestType", "in": "path", "description": "OUTGOING: Return all SR Policies in the forward direction of the link which egress from this router. INCOMING: Return all SR Policies that ingress into the router on this link. SR Policies are unidirectional, however links form symmetric adjacencies/neighbours when point to point and it may be valuable to know which SR Policies flow across a given adjacency from the other router. For broadcast links, the termination point between a router and the subnet effectively carries SR Policy traffic in both directions. This option will return the list of SR Policies which transit through neighbor routers, the subnet and then to this router MOVED: Return all SR Policies moved off the link due to maintenance enabled.", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/requestType2" }, { "description": "OUTGOING: Return all SR Policies in the forward direction of the link which egress from this router. INCOMING: Return all SR Policies that ingress into the router on this link. SR Policies are unidirectional, however links form symmetric adjacencies/neighbours when point to point and it may be valuable to know which SR Policies flow across a given adjacency from the other router. For broadcast links, the termination point between a router and the subnet effectively carries SR Policy traffic in both directions. This option will return the list of SR Policies which transit through neighbor routers, the subnet and then to this router MOVED: Return all SR Policies moved off the link due to maintenance enabled." } ] } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/policies": { "delete": { "tags": [ "sdn-sr-policies" ], "summary": "deletePolicies", "description": "Delete SR Policies", "operationId": "deletePolicies", "parameters": [], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/policies/{id}": { "put": { "tags": [ "sdn-sr-policies" ], "summary": "updatePolicies", "description": "Update SR Policy. This request requires SR Policy to be shutdown first. Add/delete Candidate Path(s) can be utilized by this request.", "operationId": "updatePolicies", "parameters": [ { "name": "id", "in": "path", "description": "ID: An identifier to uniquely identify the SR Policy", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "srPoliciesUpdateRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestSrPoliciesUpdateRequest" }, { "description": "srPoliciesUpdateRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/policy-list": { "post": { "tags": [ "sdn-sr-policies" ], "summary": "fetchPolicyList", "description": "Fetch SR Policy list", "operationId": "fetchPolicyList", "parameters": [], "requestBody": { "description": "policyIds", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "policyIds" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataPolicies" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/policy/{id}": { "delete": { "tags": [ "sdn-sr-policies" ], "summary": "deletePolicy", "description": "Delete SR Policy", "operationId": "deletePolicy", "parameters": [ { "name": "id", "in": "path", "description": "ID: An identifier to uniquely identify the SR Policy", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/policy/{srPolicyId}/admin/{adminState}": { "patch": { "tags": [ "sdn-sr-policies" ], "summary": "patchPolicyAdmin", "description": "Patch a SR Policy admin status", "operationId": "patchPolicyAdmin", "parameters": [ { "name": "adminState", "in": "path", "description": "SR Policy administrative state, UP for enabled, DOWN for disabled, Maintenance is not supported", "required": true, "style": "simple", "schema": { "allOf": [ { "$ref": "#/components/schemas/adminState463" }, { "description": "SR Policy administrative state, UP for enabled, DOWN for disabled, Maintenance is not supported" } ] } }, { "name": "srPolicyId", "in": "path", "description": "The unique identifier of the SR Policy", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/resignal": { "post": { "tags": [ "sdn-sr-policies" ], "summary": "createResignal", "description": "Trigger resignal on a list of SR Policies", "operationId": "PostcreateResignal", "parameters": [], "requestBody": { "description": "policyIds", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RequestListstring" }, { "description": "policyIds" } ] } } }, "required": true }, "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDataboolean" } } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseData" } } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/resignal-all": { "post": { "tags": [ "sdn-sr-policies" ], "summary": "createResignalAll", "description": "Trigger resignal all SR Policies", "operationId": "createResignalAll", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/Content-Type" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } }, "/v4/srpolicies/{id}": { "get": { "tags": [ "sdn-sr-policies" ], "summary": "gets", "description": "Get SR Policy by unique identifier", "operationId": "gets", "parameters": [ { "name": "id", "in": "path", "description": "ID: An identifier to uniquely identify the SR Policy", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK - Request executed successfully", "headers": {}, "content": { "*/*": { "schema": {} } } }, "400": { "description": "Bad Request - Malformed content or invalid data provided", "headers": {}, "content": { "*/*": { "schema": {} } } }, "401": { "description": "Unauthorized - Authentication rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "403": { "description": "Forbidden - Authorization rejected", "headers": {}, "content": { "*/*": { "schema": {} } } }, "404": { "description": "Not Found - Resource does not exist", "headers": {}, "content": { "*/*": { "schema": {} } } }, "409": { "description": "Conflict - System not ready", "headers": {}, "content": { "*/*": { "schema": {} } } }, "500": { "description": "Internal Server Error - Unrecognized system error", "headers": {}, "content": { "*/*": { "schema": {} } } } }, "deprecated": false, "security": [ { "RESTToken": [ "global" ] } ] } } }, "components": { "schemas": { "Adjacency": { "title": "Adjacency", "type": "object", "properties": { "farEndIpAddress": { "$ref": "#/components/schemas/FarEndIpAddress" }, "vcId": { "type": "integer", "description": "The pseudowire identifier that must match what is configured on the far-end.", "format": "int64" } }, "description": "Adjacency" }, "AdjacencySegmentId": { "title": "AdjacencySegmentId", "type": "object", "properties": { "adjacencySegmentIdsInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdjacencySegmentIdsInfo" } } }, "description": "Deprecated. Use AdjacencySegmentIdData as this only returns one entry. A list of segment ids and its destination router, flags and weight" }, "AdjacencySegmentIdData": { "title": "AdjacencySegmentIdData", "type": "object", "properties": { "adjacencySegmentIdsData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdjacencySegmentIdsData" } } }, "description": "A list of segment ids and its neighbor router, flags and weight" }, "AdjacencySegmentIdsData": { "title": "AdjacencySegmentIdsData", "type": "object", "properties": { "flags": { "$ref": "#/components/schemas/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", "description": "Segment identifier", "format": "int64" }, "weight": { "type": "integer", "description": "Adjacency segment identifier weight", "format": "int32" } } }, "AdjacencySegmentIdsInfo": { "title": "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": { "$ref": "#/components/schemas/AdjacencySidFlags" }, "segmentId": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "" }, "weight": { "type": "integer", "description": "Deprecated. Use AdjacencySegmentIdData as this only returns one entry. Adjacency segment identifier weight", "format": "int32" } } }, "AdjacencySidFlags": { "title": "AdjacencySidFlags", "type": "object", "properties": { "addressFamilyFlag": { "type": "boolean" }, "backupFlag": { "type": "boolean" }, "localFlag": { "type": "boolean" }, "persistentFlag": { "type": "boolean" }, "setFlag": { "type": "boolean" }, "valueFlag": { "type": "boolean" } } }, "AdminGroup": { "title": "AdminGroup", "type": "object", "properties": { "binary": { "type": "string" } }, "description": "Administrative group/Resource class/Color." }, "AdminGroups": { "title": "AdminGroups", "type": "object", "properties": { "adminGroup": { "$ref": "#/components/schemas/AdminGroup1" }, "extendedAdminGroup": { "$ref": "#/components/schemas/ExtendedAdminGroup2" } }, "description": "TE administrative group derived type" }, "AmiNameVersionTemplates": { "title": "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", "items": { "type": "string" }, "description": "List of global template names" } }, "description": "Grouping for each AMI with available global templates" }, "AmiNameVersions": { "title": "AmiNameVersions", "type": "object", "properties": { "amiName": { "type": "string", "description": "AMI name" }, "amiVersions": { "type": "array", "items": { "type": "string" }, "description": "AMI versions" } }, "description": "AMI Name Versions" }, "Area": { "title": "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", "description": "The level attribute for ISIS", "format": "int32" }, "protocol": { "$ref": "#/components/schemas/Protocol" } } }, "AsNumber": { "title": "AsNumber", "type": "object", "properties": { "uint32": { "type": "integer", "format": "int64" } }, "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": { "title": "AsymmetricalOperation", "type": "object", "properties": { "egress": { "$ref": "#/components/schemas/Egress2" }, "ingress": { "$ref": "#/components/schemas/Ingress2" } }, "description": "Asymmetrical operations" }, "AugmentationMeta": { "title": "AugmentationMeta", "type": "object", "properties": { "augmentationMetaInput": { "$ref": "#/components/schemas/AugmentationMetaInput2" }, "augmentationMetaJsonFileName": { "$ref": "#/components/schemas/AugmentationMetaJsonFileName2" } }, "description": "Request to update the JSON augmentation meta information for a given hierarchy and template." }, "AugmentationMetaInput": { "title": "AugmentationMetaInput", "required": [ "pathName", "templateName" ], "type": "object", "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" } }, "description": "Augmentation meta input parameters for given hierarchy and template" }, "AugmentationMetaJsonFileName": { "title": "AugmentationMetaJsonFileName", "type": "object", "properties": { "jsonFileName": { "type": "string", "description": "The json file name" } }, "description": "Json file name to read the json from the file for Augmentation Meta." }, "Authentication": { "title": "Authentication", "type": "object", "properties": { "expires": { "type": "integer", "description": "Specifies the expiry date of the token in milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" }, "description": "The role(s) this User has relative to their Tenant" }, "tenant": { "$ref": "#/components/schemas/Tenant2" }, "user": { "$ref": "#/components/schemas/User2" } }, "description": "Information regarding the current authentication status of the user" }, "BackhaulL2RequestData": { "title": "BackhaulL2RequestData", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/NspEthtSvcAccessParameters" }, "description": "" }, "ethtSvcDescr": { "type": "string", "description": "Description of the ETH transport service." }, "ethtSvcName": { "type": "string", "description": "Name of the p2p ETH transport service." }, "ethtSvcType": { "$ref": "#/components/schemas/UrlSafeString" }, "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", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "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", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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" } }, "description": "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network." }, "BackhaulPath": { "title": "BackhaulPath", "type": "object", "properties": { "isHetrogenous": { "type": "boolean", "description": "True if the path is hetrogenous" }, "methodType": { "$ref": "#/components/schemas/MethodType" }, "pathNumber": { "type": "integer", "description": "The Index of the Path", "format": "int64" }, "routeList": { "type": "array", "items": { "$ref": "#/components/schemas/NspEthtSvcAccessParameters" }, "description": "" }, "sourceService": { "type": "string", "description": "The UUID of the service" }, "uuid": { "type": "string", "description": "The UUID of the service" } } }, "BandwidthProfiles": { "title": "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." } }, "description": "A grouping which represent bandwidth profile configuration." }, "BaseEndpointRequest": { "title": "BaseEndpointRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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" } }, "description": "All endpoints type definition" }, "BaseEntity": { "title": "BaseEntity", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" } } }, "BaseService": { "title": "BaseService", "required": [ "bidirectional", "objective" ], "type": "object", "properties": { "actualEndState": { "$ref": "#/components/schemas/ActualEndState" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional1" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpointExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndPointExtension" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/BaseServiceEndpoint" }, "description": "" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "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": { "$ref": "#/components/schemas/LifeCycle3" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "name": { "type": "string", "description": "The name of the service" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service. Populated only when same node service identifier is used across all sites.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "pathProfileId": { "type": "string", "description": "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "requestedEndState": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "serviceType": { "$ref": "#/components/schemas/ServiceType1" }, "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." } }, "description": "This object is a read only representation of a service" }, "BaseServiceEndpoint": { "title": "BaseServiceEndpoint", "type": "object", "properties": { "actualEndState": { "$ref": "#/components/schemas/ActualEndState1" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "name": { "type": "string", "description": "The name of the service endpoint" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "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": { "$ref": "#/components/schemas/OperationalState" }, "portAdminState": { "$ref": "#/components/schemas/PortAdminState" }, "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": { "$ref": "#/components/schemas/PortOperationalState" }, "portSpeed": { "type": "integer", "description": "The bandwidth of port used by endpoint", "format": "int64" }, "serviceId": { "type": "string", "description": "The identifier of the service that uses this endpoint" } }, "description": "The service endpoint definition. The service endpoint is a port which is terminated against a service." }, "BaseServiceHierarchy": { "title": "BaseServiceHierarchy", "type": "object", "properties": { "baseService": { "$ref": "#/components/schemas/BaseService1" }, "serviceTunnels": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTunnel" }, "description": "" } }, "description": "This object is a read only representation of a service" }, "BundledLink": { "title": "BundledLink", "type": "object", "properties": { "desTpRef": { "type": "string", "description": "Reference to another TE termination point on the same destination node." }, "sequence": { "type": "integer", "description": "Identify the sequence in the bundle.", "format": "int64" }, "srcTpRef": { "type": "string", "description": "Reference to another TE termination point on the same souruce node." } } }, "BundledLinks": { "title": "BundledLinks", "type": "object", "properties": { "bundledLink": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BundledLink" } } }, "description": "A set of bundled links." }, "Capacity": { "title": "Capacity", "type": "object", "properties": { "capacityValue": { "$ref": "#/components/schemas/CapacityValue2" } }, "description": "Capacity of service requested" }, "CapacityValue": { "title": "CapacityValue", "type": "object", "properties": { "unit": { "$ref": "#/components/schemas/Unit" }, "value": { "type": "integer", "description": "none", "format": "int32" } }, "description": "The Capacity (Bandwidth) values that are applicable for digital layers." }, "ClineServiceCreationTemplate": { "title": "ClineServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "cemUseRtpHeader": { "type": "boolean", "description": "Enable the inclusion of RTP header. It is disabled by default." }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "monitorBandwidth": { "type": "boolean", "description": "Specifies whether or not the service bandwidth should be monitored" }, "mtu": { "type": "integer", "description": "The MTU for the service. The valid values are between 0 and 9194.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "The ID of the Workflow Profile associated with the service" }, "workflowValidate": { "type": "string", "description": "Workflow to run for service validation" } }, "description": "This template is used during C-Line service creation" }, "ClineServiceRequest": { "title": "ClineServiceRequest", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "cemUseRtpHeader": { "type": "boolean", "description": "Enable the inclusion of RTP header. It is disabled by default." }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/TdmEndpointRequest" }, "description": "" }, "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", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The normalized IP C-Line service request. This object is used to create and modify service entities in the network." }, "ComponentLink": { "title": "ComponentLink", "type": "object", "properties": { "desInterfaceRef": { "type": "string", "description": "Reference to component link interface on the destinatioin node." }, "sequence": { "type": "integer", "description": "Identify the sequence in the bundle.", "format": "int64" }, "srcInterfaceRef": { "type": "string", "description": "Reference to component link interface on the source node." } } }, "ComponentLinks": { "title": "ComponentLinks", "type": "object", "properties": { "componentLink": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ComponentLink" } } }, "description": "A set of component links" }, "ComputedHops": { "title": "ComputedHops", "type": "object", "properties": { "pathHops": { "$ref": "#/components/schemas/PathHops1" } }, "description": "Path computed hops. Explicit Route Objects (ERO)" }, "Condition1": { "title": "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" } } }, "Config": { "title": "Config", "type": "object", "properties": { "teLinkConfig": { "$ref": "#/components/schemas/TeLinkConfig1" } }, "description": "Configuration data." }, "ConnectivityConstraint": { "title": "ConnectivityConstraint", "type": "object", "properties": { "capacity": { "$ref": "#/components/schemas/Capacity1" }, "connectivityDirection": { "$ref": "#/components/schemas/ConnectivityDirection" }, "schedule": { "$ref": "#/components/schemas/Schedule1" }, "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": { "$ref": "#/components/schemas/ServiceType3" } }, "description": "Connectivity Service generic parameters" }, "ConnectivityLabelRestrictionList": { "title": "ConnectivityLabelRestrictionList", "type": "object", "properties": { "labelRestriction": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LabelRestriction" } } }, "description": "List of abel restrictions specifying what labels may or may not be used on a link connectivity." }, "ConnectivityMatrix": { "title": "ConnectivityMatrix", "type": "object", "properties": { "connectivityLabelRestrictionList": { "$ref": "#/components/schemas/ConnectivityLabelRestrictionList1" }, "from": { "$ref": "#/components/schemas/From2" }, "id": { "type": "integer", "description": "Identifies the connectivity-matrix entry.", "format": "int64" }, "isAllowed": { "type": "boolean", "description": "true - switching is allowed, false - switching is disallowed." }, "teLinkConnectivityAttributes": { "$ref": "#/components/schemas/TeLinkConnectivityAttributes1" }, "to": { "$ref": "#/components/schemas/To2" } } }, "CosMapping": { "title": "CosMapping", "type": "object", "properties": { "cos": { "type": "string", "description": "Class of Service for the qos profile" }, "queueId": { "type": "integer", "description": "The ID of an endpoint queue.", "format": "int32" } } }, "CostCharacteristic": { "title": "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." } }, "description": "The information for a particular cost characteristic." }, "CustomAttribute": { "title": "CustomAttribute", "type": "object", "properties": { "attributeName": { "type": "string", "description": "custom attribute name" }, "attributeValue": { "type": "string", "description": "custom attribute value" } }, "description": "A custom attribute" }, "CustomAttributesTemplate": { "title": "CustomAttributesTemplate", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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" } }, "description": "custom attributes template" }, "Customer": { "title": "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", "description": "The unique identifier for the customer", "format": "int64" }, "phoneNumber": { "type": "string", "description": "The phone number for the customer" } }, "description": "The customer defined in the system" }, "DateAndTime": { "title": "DateAndTime", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "Dc", "type": "object", "properties": { "l3DomainTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/L3DcDomainTemplate" }, "description": "" } }, "description": "Contains DC related configuration" }, "DeferredResultResponseDataListOpenflowFlowEntry": { "title": "DeferredResultResponseDataListOpenflowFlowEntry", "type": "object", "properties": { "result": { "type": "object" }, "setOrExpired": { "type": "boolean" } } }, "Destination": { "title": "Destination", "required": [ "destNode" ], "type": "object", "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." } }, "description": "This container holds the logical destination of a particular link." }, "DomainName": { "title": "DomainName", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "DottedQuad", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "Dscp", "type": "object", "properties": { "uint8": { "type": "integer", "format": "int32" } }, "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": { "title": "EaccessRequestData", "type": "object", "properties": { "adjacencies": { "type": "array", "items": { "$ref": "#/components/schemas/Adjacency" }, "description": "" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndpointRequest" }, "description": "" }, "mtu": { "type": "integer", "description": "The MTU for the service. Must match with far-end.", "format": "int64" }, "name": { "type": "string", "description": "The name of the service" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" }, "requestedEndState": { "$ref": "#/components/schemas/RequestedEndState" }, "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": { "$ref": "#/components/schemas/VcType2" } }, "description": "The normalized E-Access service request" }, "EbgpRoute": { "title": "EbgpRoute", "required": [ "peerAS", "peerIpAddress" ], "type": "object", "properties": { "bfdEnabled": { "type": "boolean", "description": "BFD protocol monitoring for the remote peer" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "peerAS": { "type": "integer", "description": "Autonomous System number for the remote peer. Mandatory for Post only", "format": "int64" }, "peerIpAddress": { "$ref": "#/components/schemas/PeerIpAddress" } } }, "Egress": { "title": "Egress", "type": "object", "properties": { "vlanOperations": { "$ref": "#/components/schemas/VlanOperations1" } }, "description": "Egress operations" }, "EgressParam": { "title": "EgressParam", "type": "object", "properties": { "tier1Scheduler": { "$ref": "#/components/schemas/Tier1Scheduler1" } }, "description": "Egress Qos policy parameters associated with an endpoint." }, "ElanServiceCreationTemplate": { "title": "ElanServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autoBindType": { "$ref": "#/components/schemas/AutoBindType" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "extensionTemplate": { "$ref": "#/components/schemas/EndpointExtensionTemplate" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "monitorBandwidth": { "type": "boolean", "description": "Specifies whether or not the service bandwidth should be monitored" }, "mtu": { "type": "integer", "description": "The MTU for the service. The valid values are between 0 and 9194.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "The ID of the Workflow Profile associated with the service" }, "workflowValidate": { "type": "string", "description": "Workflow to run for service validation" } }, "description": "This template is used during E-LAN service creation" }, "ElineRequestData": { "title": "ElineRequestData", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autoBindType": { "$ref": "#/components/schemas/AutoBindType1" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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": "#/components/schemas/L2EndpointExtensionRequest" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndpointRequest" }, "description": "" }, "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", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "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", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network." }, "ElineServiceCreationTemplate": { "title": "ElineServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autoBindType": { "$ref": "#/components/schemas/AutoBindType2" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "extensionTemplate": { "$ref": "#/components/schemas/EndpointExtensionTemplate" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "monitorBandwidth": { "type": "boolean", "description": "Specifies whether or not the service bandwidth should be monitored" }, "mtu": { "type": "integer", "description": "The MTU for the service. The valid values are between 0 and 9194.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "The ID of the Workflow Profile associated with the service" }, "workflowValidate": { "type": "string", "description": "Workflow to run for service validation" } }, "description": "This template is used during E-Line service creation" }, "EndpointExtensionNniTemplate": { "title": "EndpointExtensionNniTemplate", "type": "object", "properties": { "autosetTagsToMatchServiceEndpoint": { "type": "boolean", "description": "Auto-set the NNI tags to match the service-endpoint" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable QinQ ports.", "format": "int32" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" } } }, "EndpointExtensionPortTemplate": { "title": "EndpointExtensionPortTemplate", "type": "object", "properties": { "innerTag": { "type": "integer", "description": "The inner tag. Applicable QinQ ports.", "format": "int32" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" } } }, "EndpointExtensionTemplate": { "title": "EndpointExtensionTemplate", "type": "object", "properties": { "allowL2ExtensionConfiguration": { "type": "boolean", "description": "Allow L2 Extension" }, "enableL2ExtensionAugmentation": { "type": "boolean", "description": "Enable L2 Augmentation" }, "nni": { "$ref": "#/components/schemas/EndpointExtensionNniTemplate" }, "uni": { "$ref": "#/components/schemas/EndpointExtensionPortTemplate" } } }, "ErrorMessages": { "title": "ErrorMessages", "type": "object", "properties": { "errorReports": { "$ref": "#/components/schemas/ErrorReports" }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Descriptive message of one or many errors" } }, "description": "An object which carries a list of errors" }, "ErrorReport": { "title": "ErrorReport", "required": [ "errorTag", "errorType" ], "type": "object", "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" }, "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": { "$ref": "#/components/schemas/ErrorType" } } }, "ErrorReports": { "title": "ErrorReports", "type": "object", "properties": { "errorReport": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorReport" }, "description": "" } } }, "ErrorResponseData": { "title": "ErrorResponseData", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseErrorMessages" } } }, "EthTagClassify": { "title": "EthTagClassify", "type": "object", "properties": { "string": { "type": "string" } }, "description": "Identifies a specific VLAN tag classification." }, "EthTagType": { "title": "EthTagType", "type": "object", "properties": { "string": { "type": "string" } }, "description": "Identifies a specific ETH VLAN tag type." }, "Ethernet": { "title": "Ethernet", "type": "object", "properties": { "encapType": { "$ref": "#/components/schemas/EncapType" }, "lag": { "$ref": "#/components/schemas/Lag2" }, "lldpConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/LldpConfigurationInfo" }, "description": "" }, "lldpRemotePeers": { "type": "array", "items": { "$ref": "#/components/schemas/LldpRemotePeerInfo" }, "description": "" }, "portMode": { "$ref": "#/components/schemas/PortMode1" } }, "description": "Contains all Ethernet interface related configuration" }, "ExtendedAdminGroup": { "title": "ExtendedAdminGroup", "type": "object", "properties": { "binary": { "type": "string" } }, "description": "Extended administrative group/Resource class/Color." }, "ExternalDomain": { "title": "ExternalDomain", "type": "object", "properties": { "plugId": { "type": "integer", "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.", "format": "int64" }, "remoteTeLinkTpId": { "$ref": "#/components/schemas/RemoteTeLinkTpId" }, "remoteTeNodeId": { "$ref": "#/components/schemas/RemoteTeNodeId" } }, "description": "For an inter-domain link, specify the attributes of the remote end of link, to facilitate the signalling at local end." }, "ExternalId": { "title": "ExternalId", "type": "object", "properties": { "context": { "$ref": "#/components/schemas/Context" }, "id": { "type": "string", "description": "The local identifier used on the entity." }, "location": { "type": "array", "items": { "type": "string" }, "description": "The entity instance that is managing this external-id. This may be an IP address or a DNS name." } }, "description": "An external identifier to the NSP." }, "FlowCollection": { "title": "FlowCollection", "type": "object", "properties": { "mplsLabelStackQueryRate": { "type": "integer", "description": "Interval in seconds between each query of KPI-engine for cflowd statistics.", "format": "int32" }, "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", "description": "Interval in seconds between checks for stale cflowd stats.", "format": "int32" }, "statsTimeToLive": { "type": "integer", "description": "Time to live in seconds for stats before they become stale.", "format": "int32" } }, "description": "NSP configuration for flow-collection telemetry parameters." }, "From": { "title": "From", "type": "object", "properties": { "tpRef": { "type": "string", "description": "Relative reference to source termination point." } }, "description": "Reference to source NTP." }, "GeneralizedLabel": { "title": "GeneralizedLabel", "type": "object", "properties": { "binary": { "type": "string" } }, "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": { "title": "GeoLocation", "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude of the geographical location in degrees" }, "longitude": { "type": "number", "description": "The longitude of the geographical location in degrees" } }, "description": "The location of the network element site" }, "IesServiceCreationTemplate": { "title": "IesServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState19" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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" } }, "description": "This template is used during IES service creation" }, "InformationSourceAttributes": { "title": "InformationSourceAttributes", "type": "object", "properties": { "informationSource": { "$ref": "#/components/schemas/InformationSource" }, "informationSourceState": { "$ref": "#/components/schemas/InformationSourceState2" } }, "description": "The attributes identifying source that has provided the related information, and the source credibility." }, "InformationSourceEntry": { "title": "InformationSourceEntry", "type": "object", "properties": { "informationSourceAttributes": { "$ref": "#/components/schemas/InformationSourceAttributes1" }, "teLinkInfoAttributes": { "$ref": "#/components/schemas/TeLinkInfoAttributes1" } } }, "InformationSourceState": { "title": "InformationSourceState", "type": "object", "properties": { "credibilityPreference": { "type": "integer", "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.", "format": "int32" }, "routingInstance": { "type": "string", "description": "When applicable, this is the name of a routing instance from which the information is learned." }, "topology": { "$ref": "#/components/schemas/Topology2" } }, "description": "The container contains state attributes related to the information source." }, "Ingress": { "title": "Ingress", "type": "object", "properties": { "vlanOperations": { "$ref": "#/components/schemas/VlanOperations1" } }, "description": "Ingress operations" }, "IngressParam": { "title": "IngressParam", "type": "object", "properties": { "tier1Scheduler": { "$ref": "#/components/schemas/Tier1Scheduler1" } }, "description": "Ingress Qos policy parameters associated with an endpoint." }, "InterfaceSwitchingCapability": { "title": "InterfaceSwitchingCapability", "type": "object", "properties": { "encoding": { "type": "object", "description": "Base identity for encoding types" }, "maxLspBandwidth": { "type": "object", "additionalProperties": { "type": "number" } }, "switchingCapability": { "type": "object", "description": "Base identity for interface switching capabilities" }, "timeDivisionMultiplexCapable": { "$ref": "#/components/schemas/TimeDivisionMultiplexCapable2" } } }, "InterfaceSwitchingCapabilityList": { "title": "InterfaceSwitchingCapabilityList", "type": "object", "properties": { "interfaceSwitchingCapability": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/InterfaceSwitchingCapability" } } }, "description": "List of Interface Switching Capabilities Descriptors (ISCD)" }, "IpAddress": { "title": "IpAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "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": { "title": "IpElanServiceRequest", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autoBindType": { "$ref": "#/components/schemas/AutoBindType3" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpointExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndpointExtensionRequest" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndpointRequest" }, "description": "" }, "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", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The normalized E-LAN service request" }, "IpIesServiceRequest": { "title": "IpIesServiceRequest", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L3EndpointRequest" }, "description": "" }, "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": "#/components/schemas/LoopbackEndpointRequest" }, "description": "" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The IES service request. This object is used to create and modify service entities in the network." }, "IpL3DciServiceRequest": { "title": "IpL3DciServiceRequest", "required": [ "bidirectional", "connectivity", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autobind": { "$ref": "#/components/schemas/Autobind" }, "backhaulMtu": { "type": "integer", "description": "The MTU to used for the backhaul service connectivity", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "connectivity": { "$ref": "#/components/schemas/Connectivity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "dcEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L3DcEndpointRequest" }, "description": "" }, "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", "description": "Maximum ECMP configuration to deploy on the service for tunnel binding", "format": "int64" }, "encryption": { "type": "boolean", "description": "Specifies whether or not Network Group Encryption is enabled for the service" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L3EndpointRequest" }, "description": "" }, "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": "#/components/schemas/LoopbackEndpointRequest" }, "description": "" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The L3 DCI service request. This object is used to create and modify service entities in the network." }, "IpL3ServiceNormalizedRequest": { "title": "IpL3ServiceNormalizedRequest", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autobind": { "$ref": "#/components/schemas/Autobind" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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": "#/components/schemas/L3EndpointNormalizedRequest" }, "description": "" }, "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": "#/components/schemas/LoopbackEndpointRequest" }, "description": "" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The normalized L3 VPN service request. This object is used to create and modify service entities in the network." }, "IpL3ServiceRequest": { "title": "IpL3ServiceRequest", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autobind": { "$ref": "#/components/schemas/Autobind" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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": "#/components/schemas/L3EndpointRequest" }, "description": "" }, "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": "#/components/schemas/LoopbackEndpointRequest" }, "description": "" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The L3 VPN service request. This object is used to create and modify service entities in the network." }, "IpOpticalCorrelationPolicy": { "title": "IpOpticalCorrelationPolicy", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/LatencyUploadPolicy" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "srlgUploadPolicy": { "$ref": "#/components/schemas/SrlgUploadPolicy" } }, "description": "IP Optical correlation policies" }, "IpPrefix": { "title": "IpPrefix", "type": "object", "properties": { "ipv4Prefix": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Prefix": { "$ref": "#/components/schemas/UrlSafeString" } }, "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": { "title": "Ipv4Address", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "Ipv4Prefix", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "Ipv6Address", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "Ipv6Prefix", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "IroHop", "type": "object", "properties": { "hopType": { "$ref": "#/components/schemas/HopType1" }, "ipAddress": { "$ref": "#/components/schemas/IpAddress1" } }, "description": "IRO hop" }, "L2DciVpnServiceCreationTemplate": { "title": "L2DciVpnServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autobind": { "$ref": "#/components/schemas/Autobind3" }, "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", "description": "Maximum ECMP configuration to deploy on the service for tunnel binding", "format": "int64" }, "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "nameGenerationMaxLength": { "type": "integer", "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", "format": "int64" }, "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" } }, "description": "This template is used during L2 DCI VPN service creation" }, "L2EndPointExtension": { "title": "L2EndPointExtension", "type": "object", "properties": { "connectedInner": { "type": "integer", "description": "The inner tag of connected port", "format": "int32" }, "connectedOuter": { "type": "integer", "description": "The outer tag of connected port", "format": "int32" }, "connectedPortId": { "type": "string", "description": "The uuid of the connected port" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "nniPort": { "$ref": "#/components/schemas/NniPort" }, "uniPort": { "$ref": "#/components/schemas/UniPort" } }, "description": "The L2 endpoint extension definition" }, "L2EndpointExtensionRequest": { "title": "L2EndpointExtensionRequest", "type": "object", "properties": { "connectedInner": { "type": "integer", "description": "The inner tag of connected port", "format": "int32" }, "connectedOuter": { "type": "integer", "description": "The outer tag of connected port", "format": "int32" }, "connectedPortId": { "type": "string", "description": "The UUID of the connected port" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "nniPortConfig": { "$ref": "#/components/schemas/NniPortConfig2" }, "uniPortConfig": { "$ref": "#/components/schemas/UniPortConfig2" } }, "description": "The Layer 2 endpoint extension definition" }, "L2EndpointRequest": { "title": "L2EndpointRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/EncapType" }, "id": { "type": "string", "description": "The UUID of the port" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "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", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portMode": { "$ref": "#/components/schemas/PortMode" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" }, "siteServiceQosProfile": { "$ref": "#/components/schemas/SiteServiceQosProfile1" } }, "description": "The Layer 2 endpoint definition" }, "L2backhaulServiceCreationTemplate": { "title": "L2backhaulServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "description": "The maximum latency. The value must be greater than or equal to 0." }, "meta": { "type": "array", "items": { "type": "string" }, "description": "Meta data associated with template" }, "monitorBandwidth": { "type": "boolean", "description": "Specifies whether or not the service bandwidth should be monitored" }, "mtu": { "type": "integer", "description": "The MTU for the service. The valid values are between 0 and 9194.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "The ID of the Workflow Profile associated with the service" }, "workflowValidate": { "type": "string", "description": "Workflow to run for service validation" } }, "description": "This template is used during L2 Backhaul service creation" }, "L3DcDomainTemplate": { "title": "L3DcDomainTemplate", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the DC Domain Template" }, "name": { "type": "string", "description": "The name of the DC Domain Template" } }, "description": "DC Domain template information" }, "L3DcEndpointRequest": { "title": "L3DcEndpointRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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" } }, "description": "The Layer 3 DC Interconnect endpoint definition" }, "L3DciVpnServiceCreationTemplate": { "title": "L3DciVpnServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState19" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autobind": { "$ref": "#/components/schemas/Autobind3" }, "backhaulMtu": { "type": "integer", "description": "The MTU to used for the backhaul service connectivity", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "connectivity": { "$ref": "#/components/schemas/Connectivity" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "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", "description": "Maximum ECMP configuration to deploy on the service for tunnel binding", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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" } }, "description": "This template is used during L3 DCI VPN service creation" }, "L3EndpointNormalizedRequest": { "title": "L3EndpointNormalizedRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/EncapType" }, "id": { "type": "string", "description": "The UUID of the port" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "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", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portMode": { "$ref": "#/components/schemas/PortMode" }, "primaryAddress": { "$ref": "#/components/schemas/PrimaryAddress" }, "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": "#/components/schemas/RouteTarget" }, "description": "" }, "routingBgp": { "$ref": "#/components/schemas/RoutingBgp1" }, "routingStatic": { "$ref": "#/components/schemas/RoutingStatic" }, "secondaryAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/IpPrefix" }, "description": "A list of secondary IP addresses assigned to the service endpoint" }, "siteServiceQosProfile": { "$ref": "#/components/schemas/SiteServiceQosProfile1" }, "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." } } }, "L3EndpointRequest": { "title": "L3EndpointRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/EncapType" }, "id": { "type": "string", "description": "The UUID of the port" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "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", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portMode": { "$ref": "#/components/schemas/PortMode" }, "primaryAddress": { "$ref": "#/components/schemas/PrimaryAddress" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" }, "routingBgp": { "$ref": "#/components/schemas/RoutingBgp1" }, "routingStatic": { "$ref": "#/components/schemas/RoutingStatic" }, "secondaryAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/IpPrefix" }, "description": "A list of secondary IP addresses assigned to the service endpoint" }, "siteServiceQosProfile": { "$ref": "#/components/schemas/SiteServiceQosProfile1" }, "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." } } }, "L3vpnRdRtPolicy": { "title": "L3vpnRdRtPolicy", "required": [ "name" ], "type": "object", "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", "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", "format": "int64" }, "maxAssignedForRt": { "type": "integer", "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", "format": "int64" }, "maxAssignedForRtExtranet": { "type": "integer", "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", "format": "int64" }, "minAssignedForRd": { "type": "integer", "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", "format": "int64" }, "minAssignedForRt": { "type": "integer", "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", "format": "int64" }, "minAssignedForRtExtranet": { "type": "integer", "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", "format": "int64" }, "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": { "$ref": "#/components/schemas/PolicyType" }, "rdAS": { "type": "integer", "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", "format": "int64" }, "rdType": { "type": "integer", "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", "format": "int32" }, "rtAS": { "type": "integer", "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", "format": "int64" }, "rtExtranetAS": { "type": "integer", "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", "format": "int64" }, "rtExtranetType": { "type": "integer", "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", "format": "int32" }, "rtType": { "type": "integer", "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", "format": "int32" } }, "description": "L3VPN RT/RD policy" }, "L3vpnServiceCreationTemplate": { "title": "L3vpnServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState19" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autobind": { "$ref": "#/components/schemas/Autobind3" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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" } }, "description": "This template is used during L3 VPN service creation" }, "LXContainer": { "title": "LXContainer", "type": "object", "properties": { "lxinformationList": { "type": "array", "items": { "$ref": "#/components/schemas/LXInformation" }, "description": "" } } }, "LXInformation": { "title": "LXInformation", "type": "object", "properties": { "id": { "type": "string", "description": "The id of the 1830 LX" }, "ip": { "$ref": "#/components/schemas/Ip" }, "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" } } }, "LabelRestriction": { "title": "LabelRestriction", "type": "object", "properties": { "inclusiveExclusive": { "$ref": "#/components/schemas/InclusiveExclusive" }, "labelEnd": { "$ref": "#/components/schemas/LabelEnd" }, "labelStart": { "$ref": "#/components/schemas/LabelStart" }, "rangeBitmap": { "type": "string", "description": "When there are gaps between label-start and label-end, this attribute is used to specified the possitions of the used labels." } } }, "Lag": { "title": "Lag", "type": "object", "properties": { "lagId": { "type": "integer", "description": "The Id of the LAG", "format": "int32" }, "lagMembers": { "type": "array", "items": { "$ref": "#/components/schemas/LagMemberInfo" }, "description": "" } }, "description": "Contains LAG related configuration" }, "LagMemberInfo": { "title": "LagMemberInfo", "type": "object", "properties": { "bandwidth": { "type": "integer", "description": "The bandwidth of the LAG member", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the LAG member" }, "name": { "type": "string", "description": "The name of the LAG member" } }, "description": "LAG member parameters" }, "LagRequest": { "title": "LagRequest", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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", "items": { "type": "string" }, "description": "A list of destination service endpoints" }, "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": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "facility": { "type": "integer", "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", "format": "int32" }, "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": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "lambda": { "type": "number", "description": "Unsupported - Specifies the lambda to be used for the service" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "modulation": { "$ref": "#/components/schemas/Modulation" }, "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", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "pathProfileId": { "type": "string", "description": "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "phaseEncoding": { "$ref": "#/components/schemas/PhaseEncoding" }, "protection": { "type": "boolean", "description": "Unsupported - Specifies whether a protection path should be created" }, "protectionExcludeRouteObject": { "type": "array", "items": { "$ref": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "protectionIncludeRouteObject": { "type": "array", "items": { "$ref": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "protectionType": { "$ref": "#/components/schemas/ProtectionType" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "restoration": { "$ref": "#/components/schemas/Restoration" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "reversionMode": { "$ref": "#/components/schemas/ReversionMode" }, "servicePlaneType": { "$ref": "#/components/schemas/ServicePlaneType" }, "sourceTimeslot": { "type": "string", "description": "Applies timeslots to the port represented in a comma seperated value" }, "sources": { "type": "array", "items": { "type": "string" }, "description": "A list of source service endpoints" }, "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": { "$ref": "#/components/schemas/Waveshape" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The normalized LAG service request. This object is used to create and modify service entities in the network." }, "LagServiceCreationTemplate": { "title": "LagServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bandwidth": { "type": "integer", "description": "Specifies the bandwidth required for LAG service creation", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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": { "$ref": "#/components/schemas/Objective3" }, "reverseBandwidth": { "type": "integer", "description": "Specifies the reverse bandwidth required for LAG service creation", "format": "int64" } }, "description": "This template is used during LAG service creation" }, "Latency": { "title": "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": "#/components/schemas/TwampTest" }, "description": "" } }, "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": { "title": "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)." } }, "description": "Provides information on latency characteristic for a particular stated trafficProperty." }, "LifeCycle": { "title": "LifeCycle", "type": "object", "properties": { "phase": { "$ref": "#/components/schemas/Phase" }, "reason": { "type": "string", "description": "The reason for the current phase/state of the life cycle object" }, "state": { "$ref": "#/components/schemas/State2" } }, "description": "The Life Cycle details for a given object." }, "Link": { "title": "Link", "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Destination2" }, "linkId": { "$ref": "#/components/schemas/LinkId2" }, "nspLink": { "$ref": "#/components/schemas/NspLink2" }, "source": { "$ref": "#/components/schemas/Source7" }, "supportingLink": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SupportingLink" } } }, "description": "Configuration parameters for NSP at link level" }, "LinkConfig": { "title": "LinkConfig", "type": "object", "properties": { "linkParams": { "$ref": "#/components/schemas/LinkParams1" } }, "description": "Configuration data" }, "LinkCost": { "title": "LinkCost", "type": "object", "properties": { "cost": { "type": "number", "description": "Allocation cost of the physical link" }, "latency": { "type": "number", "description": "The latency of the physical link in microseconds" } } }, "LinkId": { "title": "LinkId", "type": "object", "properties": { "uri": { "$ref": "#/components/schemas/UrlSafeString" } }, "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": { "title": "LinkParams", "type": "object", "properties": { "accessType": { "$ref": "#/components/schemas/AccessType1" }, "adminStatus": { "$ref": "#/components/schemas/AdminStatus1" }, "administrativeGroup": { "$ref": "#/components/schemas/AdministrativeGroup" }, "igpMetric": { "type": "integer", "description": "IGP topology Metric", "format": "int32" }, "isAbstract": { "type": "object", "description": "Present if the link is abstract" }, "latency": { "type": "number", "description": "Delay or latency in micro seconds. The value must be greater than or equal to 0" }, "maxResvLinkBandwidth": { "type": "integer", "description": "Maximum amount of bandwidth that can be reserved in this direction in this link. Units in kbps", "format": "int64" }, "measuredIpBw": { "type": "number", "description": "Measured IP bandwidth. Units in Mbps. The value must be greater than or equal to 0" }, "measuredMplsBw": { "type": "number", "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", "items": { "$ref": "#/components/schemas/Srlg" }, "description": "A list of SRLG values" }, "teMetric": { "type": "integer", "description": "Traffic Engineering Metric", "format": "int64" }, "unreservedBandwidth": { "type": "integer", "description": "Unreserved bandwidth. Units in kbps", "format": "int64" } }, "description": "NSP link parameters grouping" }, "LinkState": { "title": "LinkState", "type": "object", "properties": { "linkParams": { "$ref": "#/components/schemas/LinkParams1" }, "operStatus": { "$ref": "#/components/schemas/OperStatus" } }, "description": "Operational state data" }, "LinkTemplate": { "title": "LinkTemplate", "type": "object", "properties": { "name": { "$ref": "#/components/schemas/UrlSafeString" }, "teLinkConfigAttributes": { "$ref": "#/components/schemas/TeLinkConfigAttributes2" }, "templateAttributes": { "$ref": "#/components/schemas/TemplateAttributes1" } } }, "LldpConfigurationInfo": { "title": "LldpConfigurationInfo", "type": "object", "properties": { "administrativeStatus": { "$ref": "#/components/schemas/AdministrativeStatus" }, "configurationType": { "$ref": "#/components/schemas/ConfigurationType" }, "notifications": { "type": "boolean", "description": "Whether notifications for LLDP are enabled on this port" } }, "description": "LLDP parameters reflect physical connectivity in the network" }, "LldpRemotePeerInfo": { "title": "LldpRemotePeerInfo", "type": "object", "properties": { "capabilitiesEnabled": { "type": "integer", "description": "The capabilities that are enabled on the remote port", "format": "int64" }, "capabilitiesSupported": { "type": "integer", "description": "The capabilities the remote port supports", "format": "int64" }, "portDescription": { "type": "string", "description": "The description of the remote port" }, "remoteChassisId": { "type": "string", "description": "A string identifying the remote chassis" }, "remoteChassisIdType": { "$ref": "#/components/schemas/RemoteChassisIdType" }, "remoteIndex": { "type": "integer", "description": "The remote peer index", "format": "int64" }, "remoteManagementIpAddress": { "type": "array", "items": { "$ref": "#/components/schemas/IpAddress" }, "description": "" }, "remotePeerType": { "$ref": "#/components/schemas/RemotePeerType" }, "remotePortId": { "type": "string", "description": "A string identifying the remote port" }, "remotePortIdType": { "$ref": "#/components/schemas/RemotePortIdType" }, "remoteSystemName": { "type": "string", "description": "The name of the remote system" } }, "description": "LLDP parameters reflect physical connectivity in the network" }, "LoopbackEndpointRequest": { "title": "LoopbackEndpointRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/PrimaryAddress" }, "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." } }, "description": "The LoopBack endpoint definition" }, "Lsp": { "title": "Lsp", "type": "object", "properties": { "externalId": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/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", "format": "int32" }, "paths": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LspPath" } }, "tunnelId": { "type": "integer", "description": "LSP tunnel identifier", "format": "int64" } }, "description": "MPLS LSP" }, "LspPath": { "title": "LspPath", "type": "object", "properties": { "administrativeFailureErrorCode": { "$ref": "#/components/schemas/AdministrativeFailureErrorCode" }, "administrativeState": { "$ref": "#/components/schemas/AdministrativeState" }, "computationState": { "$ref": "#/components/schemas/ComputationState" }, "computedHops": { "$ref": "#/components/schemas/ComputedHops1" }, "creationType": { "$ref": "#/components/schemas/CreationType" }, "destinationAddress": { "$ref": "#/components/schemas/DestinationAddress" }, "destinationId": { "type": "string", "description": "ID: Unique identifier of the destination topology link/tp" }, "destinationNetworkName": { "type": "array", "items": { "type": "string" }, "description": "Path destination network topology name" }, "latency": { "type": "number", "description": "Path latency" }, "lifecycleState": { "$ref": "#/components/schemas/LifecycleState" }, "lspId": { "type": "string", "description": "ID: Unique identifier of the parent LSP" }, "maintenanceAffected": { "$ref": "#/components/schemas/MaintenanceAffected" }, "operationalState": { "$ref": "#/components/schemas/OperationalState7" }, "ownershipState": { "$ref": "#/components/schemas/OwnershipState2" }, "paramsConfig": { "$ref": "#/components/schemas/ParamsConfig1" }, "paramsState": { "$ref": "#/components/schemas/ParamsState2" }, "pathErrorCode": { "$ref": "#/components/schemas/PathErrorCode" }, "pathId": { "type": "string", "description": "ID: Unique identifier of the path" }, "pathName": { "type": "string", "description": "Path name" }, "pathType": { "$ref": "#/components/schemas/PathType" }, "protectionState": { "$ref": "#/components/schemas/ProtectionState" }, "protectionType": { "$ref": "#/components/schemas/ProtectionType1" }, "provisionedHops": { "$ref": "#/components/schemas/ProvisionedHops2" }, "recordedHops": { "$ref": "#/components/schemas/RecordedHops2" }, "sourceAddress": { "$ref": "#/components/schemas/SourceAddress" }, "sourceId": { "type": "string", "description": "ID: Unique identifier of the source topology link/tp" }, "sourceNetworkName": { "type": "array", "items": { "type": "string" }, "description": "Path source network topology name" }, "sourceRouterAddress": { "$ref": "#/components/schemas/SourceRouterAddress" }, "tunnelId": { "type": "integer", "description": "Path tunnel identifier", "format": "int64" } }, "description": "LSP path" }, "LspPathConfigRequest": { "title": "LspPathConfigRequest", "required": [ "creationType", "destinationAddress", "pathName", "pathType", "sourceAddress", "sourceRouterAddress" ], "type": "object", "properties": { "administrativeState": { "$ref": "#/components/schemas/AdministrativeState" }, "creationType": { "$ref": "#/components/schemas/CreationType" }, "destinationAddress": { "$ref": "#/components/schemas/DestinationAddress" }, "paramsConfig": { "$ref": "#/components/schemas/ParamsConfig1" }, "pathName": { "type": "string", "description": "Path name" }, "pathType": { "$ref": "#/components/schemas/PathType" }, "sourceAddress": { "$ref": "#/components/schemas/SourceAddress" }, "sourceRouterAddress": { "$ref": "#/components/schemas/SourceRouterAddress" } } }, "LspPathConfigRequestParamsConfig": { "title": "LspPathConfigRequestParamsConfig", "type": "object", "properties": { "pathParams": { "$ref": "#/components/schemas/PathParams1" } }, "description": "Path parameters configuration" }, "Measurement": { "title": "Measurement", "type": "object", "properties": { "performanceMetricAttributes": { "$ref": "#/components/schemas/PerformanceMetricAttributes1" } }, "description": "Measured performance metric values. Static configuration and manual overrides of these measurements are also allowed." }, "MediationAugmentationRequest": { "title": "MediationAugmentationRequest", "required": [ "neId", "pathName" ], "type": "object", "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": { "$ref": "#/components/schemas/ServiceType1" }, "templateId": { "type": "string", "description": "The identifier of the template associated to the augmentation." } }, "description": "Mediation Augmentation Request" }, "MediationInfo": { "title": "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" } }, "description": "Mediation Template mapping information" }, "MediationProfileTemplateMapping": { "title": "MediationProfileTemplateMapping", "required": [ "name" ], "type": "object", "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": "#/components/schemas/MediationInfo" }, "description": "" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "profileType": { "$ref": "#/components/schemas/ProfileType" } }, "description": "Mediation profile that defines the Mediation and their template associations." }, "NePolicyIdentifier": { "title": "NePolicyIdentifier", "type": "object", "properties": { "ipAddress": { "type": "string", "description": "The IP address of the network element" }, "policyIdentifiers": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyIdentifier" }, "description": "" }, "siteName": { "type": "string", "description": "The name of the network element site" } }, "description": "The list of policy identifiers per NE" }, "Network": { "title": "Network", "type": "object", "properties": { "link": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Link" } }, "networkId": { "$ref": "#/components/schemas/NetworkId2" }, "networkTypes": { "type": "object", "description": "Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container." }, "node": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Node" } }, "nspNetwork": { "$ref": "#/components/schemas/NspNetwork2" }, "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" }, "description": "" } }, "description": "Configuration parameters for NSP L3 topology" }, "NetworkConfig": { "title": "NetworkConfig", "type": "object", "properties": { "networkParams": { "$ref": "#/components/schemas/NetworkParams1" } }, "description": "Configuration data" }, "NetworkElement": { "title": "NetworkElement", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "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": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "items": { "type": "string" }, "description": "The custom properties of the network element" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "geoLocation": { "$ref": "#/components/schemas/GeoLocation1" }, "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": { "$ref": "#/components/schemas/NeDeploymentState" }, "nspDbFdn": { "type": "string", "description": "FDN of the network element used for this object in the NSP DB" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "platform": { "$ref": "#/components/schemas/Platform2" }, "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" } }, "description": "The network element definition" }, "NetworkElementRequest": { "title": "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" } }, "description": "A request object used to modify Network Element" }, "NetworkId": { "title": "NetworkId", "type": "object", "properties": { "uri": { "$ref": "#/components/schemas/UrlSafeString" } }, "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": { "title": "NetworkIdentifierType", "type": "object", "properties": { "uint32": { "type": "integer", "format": "int64" } }, "description": "Network identifier." }, "NetworkParams": { "title": "NetworkParams", "type": "object", "properties": { "area": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Area" } }, "preference": { "type": "integer", "description": "Specifies a preference for this topology. A lower number indicates a higher preference", "format": "int32" } }, "description": "NSP network topology parameters grouping" }, "NetworkState": { "title": "NetworkState", "type": "object", "properties": { "networkParams": { "$ref": "#/components/schemas/NetworkParams1" } }, "description": "Operational state data" }, "Networks": { "title": "Networks", "type": "object", "properties": { "network": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Network" } }, "nspNetworks": { "$ref": "#/components/schemas/NspNetworks" } } }, "NetworksConfig": { "title": "NetworksConfig", "type": "object", "properties": { "networksParams": { "type": "object", "description": "networks attributes in a topology" } } }, "NetworksState": { "title": "NetworksState", "type": "object", "properties": { "networksParams": { "type": "object", "description": "networks attributes in a topology" } } }, "NniPort": { "title": "NniPort", "type": "object", "properties": { "actualEndState": { "$ref": "#/components/schemas/ActualEndState1" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "name": { "type": "string", "description": "The name of the service endpoint" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "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": { "$ref": "#/components/schemas/OperationalState" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portAdminState": { "$ref": "#/components/schemas/PortAdminState" }, "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": { "$ref": "#/components/schemas/PortOperationalState" }, "portSpeed": { "type": "integer", "description": "The bandwidth of port used by endpoint", "format": "int64" }, "serviceId": { "type": "string", "description": "The identifier of the service that uses this endpoint" } } }, "NniPortConfig": { "title": "NniPortConfig", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "name": { "type": "string", "description": "The name of the endpoint" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" } }, "description": "The NNI endpoint definition" }, "Node": { "title": "Node", "type": "object", "properties": { "nodeId": { "$ref": "#/components/schemas/NodeId3" }, "nspNode": { "$ref": "#/components/schemas/NspNode1" }, "supportingNode": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SupportingNode" } }, "terminationPoint": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TerminationPoint" } } } }, "NodeConfig": { "title": "NodeConfig", "type": "object", "properties": { "nodeParams": { "$ref": "#/components/schemas/NodeParams1" } }, "description": "Configuration data" }, "NodeData": { "title": "NodeData", "type": "object", "properties": { "nspNode": { "$ref": "#/components/schemas/NspNode1" } }, "description": "Node data" }, "NodeId": { "title": "NodeId", "type": "object", "properties": { "uri": { "$ref": "#/components/schemas/UrlSafeString" } }, "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": { "title": "NodeParams", "type": "object", "properties": { "areaId": { "type": "array", "items": { "type": "string" }, "description": "" }, "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": { "$ref": "#/components/schemas/NodeId1" }, "operStatus": { "$ref": "#/components/schemas/OperStatus1" }, "srStartLabel": { "type": "integer", "description": "MPLS label range start value", "format": "int64" } }, "description": "NSP node parameters grouping" }, "NodeState": { "title": "NodeState", "type": "object", "properties": { "nodeParams": { "$ref": "#/components/schemas/NodeParams1" } }, "description": "Operational state data" }, "NodeTemplate": { "title": "NodeTemplate", "type": "object", "properties": { "name": { "$ref": "#/components/schemas/UrlSafeString" }, "teNodeConfigAttributesTemplate": { "$ref": "#/components/schemas/TeNodeConfigAttributesTemplate2" }, "templateAttributes": { "$ref": "#/components/schemas/TemplateAttributes1" } } }, "Normality": { "title": "Normality", "type": "object", "properties": { "performanceMetricNormalityAttributes": { "$ref": "#/components/schemas/PerformanceMetricNormalityAttributes2" } }, "description": "Performance metric normality values." }, "NspEthtSvcAccessParameters": { "title": "NspEthtSvcAccessParameters", "type": "object", "properties": { "accessLtpId": { "$ref": "#/components/schemas/AccessLtpId" }, "accessNodeId": { "$ref": "#/components/schemas/AccessNodeId" }, "bandwidthProfiles": { "$ref": "#/components/schemas/BandwidthProfiles2" }, "baseEndpointRequest": { "$ref": "#/components/schemas/BaseEndpointRequest2" }, "outerTag": { "$ref": "#/components/schemas/OuterTag1" }, "secondTag": { "$ref": "#/components/schemas/SecondTag1" }, "serviceClassificationType": { "type": "object", "description": "Service classification." }, "splitHorizonGroup": { "type": "string", "description": "Identify a split horizon group" }, "vlanOperations": { "$ref": "#/components/schemas/NspEthtSvcAccessParametersVlanOperations" } }, "description": "ETH transport services access parameters" }, "NspEthtSvcAccessParametersVlanOperations": { "title": "NspEthtSvcAccessParametersVlanOperations", "type": "object", "properties": { "asymmetricalOperation": { "$ref": "#/components/schemas/AsymmetricalOperation1" }, "symmetricalOperation": { "$ref": "#/components/schemas/SymmetricalOperation2" } } }, "NspLink": { "title": "NspLink", "type": "object", "properties": { "linkConfig": { "$ref": "#/components/schemas/LinkConfig2" }, "linkState": { "$ref": "#/components/schemas/LinkState2" } }, "description": "Augmentation for NSP link" }, "NspNetwork": { "title": "NspNetwork", "type": "object", "properties": { "networkConfig": { "$ref": "#/components/schemas/NetworkConfig2" }, "networkName": { "type": "string", "description": "The name of the network" }, "networkState": { "$ref": "#/components/schemas/NetworkState2" } }, "description": "Augmentation for NSP network" }, "NspNetworks": { "title": "NspNetworks", "type": "object", "properties": { "networksConfig": { "$ref": "#/components/schemas/NetworksConfig" }, "networksState": { "$ref": "#/components/schemas/NetworksState" } } }, "NspNode": { "title": "NspNode", "type": "object", "properties": { "nodeConfig": { "$ref": "#/components/schemas/NodeConfig2" }, "nodeState": { "$ref": "#/components/schemas/NodeState2" } }, "description": "Augmentation for NSP node" }, "NspNodeWithNetwork": { "title": "NspNodeWithNetwork", "type": "object", "properties": { "networkId": { "type": "string", "description": "The ID of the network which this node belongs to" }, "nodeData": { "$ref": "#/components/schemas/NodeData1" } }, "description": "Augmentation for NSP node" }, "NspOpticsExplicitRoute": { "title": "NspOpticsExplicitRoute", "type": "object", "properties": { "asNumber": { "type": "integer", "description": "AS number", "format": "int32" }, "interfaceId": { "type": "integer", "description": "The interface identifier", "format": "int64" }, "linkId": { "type": "string", "description": "The identifier for the link." }, "linkLoose": { "type": "boolean", "description": "Specifies if this contraint is strict or loose." }, "regenInterfaceIds": { "type": "array", "items": { "type": "string" }, "description": "The regen interface identifiers" }, "regenLoose": { "type": "boolean", "description": "Specifies if this constraint is strict or loose" }, "regenRouterId": { "$ref": "#/components/schemas/UrlSafeString" }, "routerId": { "$ref": "#/components/schemas/RouterId1" }, "srlgLoose": { "type": "boolean", "description": "Specifies if this constraint is strict or loose" }, "srlgs": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "The srlg value" }, "v4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "v4Loose": { "type": "boolean", "description": "Describes whether the object is loose if set, or otherwise strict" }, "v4PrefixLength": { "type": "integer", "description": "Length in bits of the IPv4 prefix", "format": "int32" }, "v6Address": { "$ref": "#/components/schemas/UrlSafeString" }, "v6Loose": { "type": "boolean", "description": "Describes whether the object is loose if set, or otherwise strict" }, "v6PrefixLength": { "type": "integer", "description": "Length in bits of the IPv4 prefix", "format": "int32" }, "value": { "type": "integer", "description": "the label value", "format": "int64" } }, "description": "The explicit route object for Optical services" }, "NspTerminationPoint": { "title": "NspTerminationPoint", "type": "object", "properties": { "terminationPointConfig": { "$ref": "#/components/schemas/TerminationPointConfig2" }, "terminationPointState": { "$ref": "#/components/schemas/TerminationPointState2" } }, "description": "Augmentation for NSP termination point" }, "OchServiceCreationTemplate": { "title": "OchServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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": { "$ref": "#/components/schemas/Objective3" }, "restoration": { "$ref": "#/components/schemas/Restoration" }, "reversionMode": { "$ref": "#/components/schemas/ReversionMode" } }, "description": "This template is used during OCH service creation" }, "OduServiceCreationTemplate": { "title": "OduServiceCreationTemplate", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bandwidth": { "type": "integer", "description": "Specifies the bandwidth required for ODU creation", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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": { "$ref": "#/components/schemas/Objective3" }, "reverseBandwidth": { "type": "integer", "description": "Specifies the reverse bandwidth required for ODU creation", "format": "int64" } }, "description": "This template is used during ODU service creation" }, "OpenflowAction": { "title": "OpenflowAction", "type": "object", "properties": { "actionType": { "$ref": "#/components/schemas/ActionType" }, "experimenterActionType": { "$ref": "#/components/schemas/ExperimenterActionType" }, "ipAddress": { "$ref": "#/components/schemas/IpAddress1" }, "isIndirect": { "type": "boolean", "description": "Set the value for indirect hop" }, "outerVlanId": { "type": "integer", "description": "Outer QinQ tag VlanId", "format": "int64" }, "portId": { "type": "integer", "description": "Openflow switch output port id", "format": "int64" }, "sdpId": { "type": "integer", "description": "SDP id", "format": "int64" }, "vcId": { "type": "integer", "description": "Virtual circuit id", "format": "int64" }, "vlanId": { "type": "integer", "description": "Dot1Q tag or inner QinQ tag VlanId", "format": "int64" } }, "description": "Openflow action" }, "OpenflowFlowEntry": { "title": "OpenflowFlowEntry", "required": [ "applicationGroupId", "applicationId", "auditstate", "cookie", "datapathId", "flowId", "lifecycle", "priority", "tableId" ], "type": "object", "properties": { "applicationGroupId": { "type": "integer", "description": "The identification of the application group, used by the application to categorize this flow", "format": "int64" }, "applicationId": { "type": "integer", "description": "The identification of the application which deployed the flow, negative numbers are reserved and should not be used", "format": "int32" }, "auditstate": { "$ref": "#/components/schemas/Auditstate" }, "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": { "$ref": "#/components/schemas/Lifecycle1" }, "openflowInstruction": { "$ref": "#/components/schemas/OpenflowInstruction1" }, "openflowMatch": { "$ref": "#/components/schemas/OpenflowMatch1" }, "priority": { "type": "integer", "description": "The priority of the flow", "format": "int64" }, "tableId": { "type": "integer", "description": "The table id number within the switch", "format": "int64" } }, "description": "Openflow flow entry" }, "OpenflowFlowEntryRequest": { "title": "OpenflowFlowEntryRequest", "required": [ "applicationId", "cookie", "datapathId", "priority", "tableId" ], "type": "object", "properties": { "applicationGroupId": { "type": "integer", "description": "The identification of the application group, used by the application to categorize this flow", "format": "int64" }, "applicationId": { "type": "integer", "description": "The identification of the application which deployed the flow, negative numbers are reserved and should not be used", "format": "int32" }, "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": { "$ref": "#/components/schemas/OpenflowInstruction1" }, "openflowMatch": { "$ref": "#/components/schemas/OpenflowMatch1" }, "priority": { "type": "integer", "description": "The priority of the flow", "format": "int64" }, "tableId": { "type": "integer", "description": "The table id number within the switch", "format": "int64" } }, "description": "Flows to be created" }, "OpenflowFlowSearch": { "title": "OpenflowFlowSearch", "required": [ "datapathId" ], "type": "object", "properties": { "applicationGroupId": { "type": "integer", "description": "The identification of the application group, used by the application to categorize this flow", "format": "int64" }, "applicationId": { "type": "integer", "description": "The identification number of the application which deployed the flow", "format": "int32" }, "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": { "$ref": "#/components/schemas/OpenflowMatch1" }, "priority": { "type": "integer", "description": "The priority of the flow", "format": "int64" }, "tableId": { "type": "integer", "description": "The table id number within the switch", "format": "int64" } }, "description": "Search criteria" }, "OpenflowFlowSearchById": { "title": "OpenflowFlowSearchById", "type": "object", "properties": { "flowIds": { "type": "array", "items": { "type": "string" }, "description": "List of flows' unique identifers" } }, "description": "The unique identifiers of the flows to find" }, "OpenflowFlowUpdateEntry": { "title": "OpenflowFlowUpdateEntry", "type": "object", "properties": { "flowIds": { "type": "array", "items": { "type": "string" }, "description": "The unique identifiers of the flows for which the Instruction needs to be modified." }, "openflowInstruction": { "$ref": "#/components/schemas/OpenflowInstruction1" } }, "description": "Openflow flow instruction update" }, "OpenflowInstruction": { "title": "OpenflowInstruction", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenflowAction" }, "description": "" }, "instructionType": { "$ref": "#/components/schemas/InstructionType" } }, "description": "The instruction to be performed on the flow" }, "OpenflowMatch": { "title": "OpenflowMatch", "type": "object", "properties": { "destIpAddress": { "$ref": "#/components/schemas/DestIpAddress" }, "destPort": { "type": "integer", "description": "Destination (TCP or UDP) port number", "format": "int64" }, "dscp": { "$ref": "#/components/schemas/Dscp1" }, "ethernetType": { "type": "string", "description": "Ethernet Type in hexadecimal (for example 0x800 for IPv4)" }, "inPort": { "type": "integer", "description": "Input port number", "format": "int64" }, "ipProtocolType": { "type": "integer", "description": "IP Protocol Type (for example 6 for TCP or 17 for UDP)", "format": "int32" }, "outerVlanId": { "type": "integer", "description": "Experimenter outer VlanId", "format": "int64" }, "sourceIpAddress": { "$ref": "#/components/schemas/SourceIpAddress" }, "sourcePort": { "type": "integer", "description": "Source (TCP or UDP) port number", "format": "int64" }, "vlanId": { "type": "integer", "description": "Dot1Q tag or inner QinQ tag VlanId", "format": "int64" } }, "description": "The match criteria for this flow" }, "OpenflowPort": { "title": "OpenflowPort", "required": [ "datapathId", "hardwareAddress", "portId", "portName" ], "type": "object", "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", "description": "The port id which identifies the port", "format": "int64" }, "portName": { "type": "string", "description": "The name of the port" } }, "description": "Openflow port" }, "OpenflowSwitch": { "title": "OpenflowSwitch", "required": [ "datapathId", "dpDescription", "hwDescription", "maxTables", "mfgDescription", "numberOfBuffers", "openflowVersion", "serialNumber", "status", "swDescription", "switchAddress", "vendorType" ], "type": "object", "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", "description": "Maximum number of tables supported on this switch", "format": "int64" }, "mfgDescription": { "type": "string", "description": "Manufacturer description" }, "numberOfBuffers": { "type": "integer", "description": "Maximum number of buffers supported on this switch", "format": "int64" }, "openflowVersion": { "$ref": "#/components/schemas/OpenflowVersion" }, "serialNumber": { "type": "string", "description": "Serial number of this switch" }, "status": { "$ref": "#/components/schemas/Status" }, "swDescription": { "type": "string", "description": "Software description" }, "switchAddress": { "$ref": "#/components/schemas/SwitchAddress" }, "vendorType": { "$ref": "#/components/schemas/VendorType" } }, "description": "Openflow switch information" }, "OpenflowTable": { "title": "OpenflowTable", "required": [ "datapathId", "maxEntries", "tableId" ], "type": "object", "properties": { "datapathId": { "type": "string", "description": "The hexadecimal openflow data-path id for this switch" }, "maxEntries": { "type": "integer", "description": "The number of entries the table supports", "format": "int64" }, "tableId": { "type": "integer", "description": "The table id number within the switch", "format": "int64" } }, "description": "Openflow table" }, "OpticalConnectivityConstraintTemplate": { "title": "OpticalConnectivityConstraintTemplate", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "connectivityConstraint": { "$ref": "#/components/schemas/ConnectivityConstraint1" }, "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" } }, "description": "Optical connectivity constraint template" }, "OpticalConnectivityServiceTemplate": { "title": "OpticalConnectivityServiceTemplate", "required": [ "name" ], "type": "object", "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", "items": { "type": "string" }, "description": "Resilience constraint template ids" }, "routingConstraintTemplateId": { "type": "string", "description": "Routing constraint template id" } }, "description": "Optical connectivity service template" }, "OpticalDateAndTime": { "title": "OpticalDateAndTime", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "OpticalResilienceConstraintTemplate", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/ResilienceConstraint2" } }, "description": "Optical resilience constraint template" }, "OpticalRoutingConstraintTemplate": { "title": "OpticalRoutingConstraintTemplate", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/RoutingConstraint2" } }, "description": "Optical routing constraint template" }, "Optics": { "title": "Optics", "type": "object", "properties": { "protectionType": { "$ref": "#/components/schemas/ProtectionType3" } }, "description": "Contains Optical related configuration" }, "OpticsRequest": { "title": "OpticsRequest", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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", "items": { "type": "string" }, "description": "A list of destination service endpoints" }, "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": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "facility": { "type": "integer", "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", "format": "int32" }, "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": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "lambda": { "type": "number", "description": "Unsupported - Specifies the lambda to be used for the service" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "modulation": { "$ref": "#/components/schemas/Modulation" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "pathProfileId": { "type": "string", "description": "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "phaseEncoding": { "$ref": "#/components/schemas/PhaseEncoding" }, "protection": { "type": "boolean", "description": "Unsupported - Specifies whether a protection path should be created" }, "protectionExcludeRouteObject": { "type": "array", "items": { "$ref": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "protectionIncludeRouteObject": { "type": "array", "items": { "$ref": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "protectionType": { "$ref": "#/components/schemas/ProtectionType" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "restoration": { "$ref": "#/components/schemas/Restoration" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "reversionMode": { "$ref": "#/components/schemas/ReversionMode" }, "servicePlaneType": { "$ref": "#/components/schemas/ServicePlaneType" }, "sourceTimeslot": { "type": "string", "description": "Applies timeslots to the port represented in a comma seperated value" }, "sources": { "type": "array", "items": { "type": "string" }, "description": "A list of source service endpoints" }, "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": { "$ref": "#/components/schemas/Waveshape" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } }, "description": "The normalized Optical service request. This object is used to create and modify service entities in the network." }, "OuterTag": { "title": "OuterTag", "type": "object", "properties": { "vlanWrite": { "$ref": "#/components/schemas/VlanWrite1" } }, "description": "The outermost VLAN tag to push/swap." }, "Ownership": { "title": "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" } } }, "OwnershipState": { "title": "OwnershipState", "type": "object", "properties": { "ownership": { "$ref": "#/components/schemas/Ownership" } }, "description": "Path ownership state" }, "ParamsConfig": { "title": "ParamsConfig", "type": "object", "properties": { "pathParams": { "$ref": "#/components/schemas/PathParams1" } }, "description": "Path parameters configuration" }, "ParamsState": { "title": "ParamsState", "type": "object", "properties": { "pathParams": { "$ref": "#/components/schemas/PathParams1" } }, "description": "Path parameters state" }, "PathHop": { "title": "PathHop", "type": "object", "properties": { "hopId": { "type": "integer", "description": "Path hop identifier", "format": "int32" }, "hopIndex": { "type": "integer", "description": "Path hop index. A counter denoting hop order", "format": "int32" }, "hopLinkId": { "type": "string", "description": "ID: Unique identifier of the topology link" }, "hopType": { "$ref": "#/components/schemas/HopType" }, "ifLinkIndex": { "type": "integer", "description": "Path hop link interface index. This value used as local link identifier for unnumbered interface", "format": "int32" }, "ipAddress": { "$ref": "#/components/schemas/IpAddress1" }, "postProcessedSourceId": { "$ref": "#/components/schemas/PostProcessedSourceId" }, "postProcessedSourceInterface": { "$ref": "#/components/schemas/PostProcessedSourceInterface" }, "postProcessedSourceTp": { "type": "string", "description": "Path hop source router termination point" }, "routerId": { "$ref": "#/components/schemas/RouterId" }, "segmentLabel": { "type": "integer", "description": "Path hop segment routing label. Segment Identifier (SID)", "format": "int64" }, "segmentRouteType": { "$ref": "#/components/schemas/SegmentRouteType" }, "sidHopType": { "$ref": "#/components/schemas/SidHopType" } } }, "PathHops": { "title": "PathHops", "type": "object", "properties": { "pathHop": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PathHop" } } }, "description": "LSP path hops" }, "PathParams": { "title": "PathParams", "type": "object", "properties": { "adminGroupExcludeAny": { "$ref": "#/components/schemas/AdminGroupExcludeAny" }, "adminGroupIncludeAll": { "$ref": "#/components/schemas/AdminGroupIncludeAll" }, "adminGroupIncludeAny": { "$ref": "#/components/schemas/AdminGroupIncludeAny" }, "bandwidth": { "type": "integer", "description": "Path bandwidth capacity. Units in Kbps", "format": "int32" }, "maxCost": { "type": "integer", "description": "Path maximum cost constraint", "format": "int64" }, "maxHops": { "type": "integer", "description": "Path maximum hops constraint. 0 and 255 means no limit.", "format": "int64" }, "maxLatency": { "type": "number", "description": "Path maximum latency constraint" }, "maxTeMetric": { "type": "integer", "description": "Path maximum TE metric constraint", "format": "int64" }, "msd": { "type": "integer", "description": "Path maximum SID depth. 0 means no MSD.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective19" }, "pathProfile": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PathProfile" } }, "pathProfileOverride": { "$ref": "#/components/schemas/PathProfileOverride2" }, "setupPriority": { "type": "integer", "description": "Path setup priority from 0 to 7. Value 0 is the highest priority", "format": "int32" }, "templateId": { "type": "integer", "description": "MPLS path template ID (PCE Initiated only)", "format": "int64" } }, "description": "LSP path parameters" }, "PathProfile": { "title": "PathProfile", "type": "object", "properties": { "extendedId": { "type": "integer", "description": "Path extended identifier. An identifier for profile association/grouping", "format": "int64" }, "profileId": { "type": "integer", "description": "Path profile identifier. An identifier of a predefined profile. 0 means no path profile assigned.", "format": "int64" }, "profileIndex": { "type": "integer", "description": "Path profile index. A counter denoting profile order", "format": "int32" } } }, "PathProfileOverride": { "title": "PathProfileOverride", "type": "object", "properties": { "extendedId": { "type": "integer", "description": "Path extended identifier. An identifier for profile association/grouping", "format": "int64" }, "profileGroupOverrideState": { "$ref": "#/components/schemas/ProfileGroupOverrideState" }, "profileId": { "type": "integer", "description": "Path profile identifier. An identifier of a predefined profile. 0 means no path profile assigned. -1 deletes the path profile override.", "format": "int64" } }, "description": "Path computation profile override" }, "PathProfileTemplate": { "title": "PathProfileTemplate", "required": [ "name", "profileId" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bandwidthStrategy": { "$ref": "#/components/schemas/BandwidthStrategy" }, "bidirection": { "$ref": "#/components/schemas/Bidirection" }, "bwSplitMonitoringTime": { "type": "integer", "description": "Time in seconds to watch measured bandwidth before sending LSP split trigger", "format": "int32" }, "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", "format": "int32" }, "bwSplitWorkflowName": { "type": "string", "description": "The name of workflow for LSP bandwidth split" }, "controlRerouteStrategy": { "$ref": "#/components/schemas/ControlRerouteStrategy" }, "disjoint": { "$ref": "#/components/schemas/Disjoint" }, "excludeRouteObjects": { "type": "array", "items": { "$ref": "#/components/schemas/IpAddress" }, "description": "The hops to be excluded from the path" }, "explicitRouteStrategy": { "$ref": "#/components/schemas/ExplicitRouteStrategy" }, "explicitRouteStrategyEcmpPreference": { "$ref": "#/components/schemas/ExplicitRouteStrategyEcmpPreference" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "includeRouteObjects": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IroHop" } }, "latencyThreshold": { "type": "number", "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", "description": "The Max Cost constraint to be used in path computation", "format": "int64" }, "maxHops": { "type": "integer", "description": "The Max Hops constraint to be used in path computation", "format": "int64" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in microseconds) to consider for the path calculation" }, "maxTeMetric": { "type": "integer", "description": "The Max TE Metric constraint to be used in the path computation", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective23" }, "profileId": { "type": "integer", "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", "format": "int64" }, "sidProtectionStrategy": { "$ref": "#/components/schemas/SidProtectionStrategy" } }, "description": "The path profile template controls computation parameters for creating paths in the network" }, "PathSearchRequest": { "title": "PathSearchRequest", "required": [ "uuid" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Destination2" }, "erpInstance": { "type": "integer", "description": "The Instance number of ERP", "format": "int64" }, "minBandwidth": { "type": "integer", "description": "The minimum bandwidth to maintain for the service", "format": "int64" }, "source": { "$ref": "#/components/schemas/Source7" }, "uuid": { "type": "string", "description": "The UUID of the service" }, "vlanId": { "$ref": "#/components/schemas/VlanId2" } }, "description": "The path calculation request definition" }, "PerformanceMetric": { "title": "PerformanceMetric", "type": "object", "properties": { "measurement": { "$ref": "#/components/schemas/Measurement2" }, "normality": { "$ref": "#/components/schemas/Normality2" }, "tePerformanceMetric": { "type": "object", "description": "This feature indicates that the system supports TE performance metric." } }, "description": "Link performance information in real time." }, "PerformanceMetricAttributes": { "title": "PerformanceMetricAttributes", "type": "object", "properties": { "unidirectionalAvailableBandwidth": { "type": "number", "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", "description": "Delay or latency in micro seconds.", "format": "int64" }, "unidirectionalDelayVariation": { "type": "integer", "description": "Delay variation in micro seconds.", "format": "int64" }, "unidirectionalMaxDelay": { "type": "integer", "description": "Maximum delay or latency in micro seconds.", "format": "int64" }, "unidirectionalMinDelay": { "type": "integer", "description": "Minimum delay or latency in micro seconds.", "format": "int64" }, "unidirectionalPacketLoss": { "type": "number", "description": "Packet loss as a percentage of the total traffic sent over a configurable interval. The finest precision is 0.000003%." }, "unidirectionalResidualBandwidth": { "type": "number", "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", "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." } }, "description": "Link performance information in real time." }, "PerformanceMetricNormalityAttributes": { "title": "PerformanceMetricNormalityAttributes", "type": "object", "properties": { "unidirectionalAvailableBandwidth": { "$ref": "#/components/schemas/UnidirectionalAvailableBandwidth" }, "unidirectionalDelay": { "$ref": "#/components/schemas/UnidirectionalDelay" }, "unidirectionalDelayVariation": { "$ref": "#/components/schemas/UnidirectionalDelayVariation" }, "unidirectionalMaxDelay": { "$ref": "#/components/schemas/UnidirectionalMaxDelay" }, "unidirectionalMinDelay": { "$ref": "#/components/schemas/UnidirectionalMinDelay" }, "unidirectionalPacketLoss": { "$ref": "#/components/schemas/UnidirectionalPacketLoss" }, "unidirectionalResidualBandwidth": { "$ref": "#/components/schemas/UnidirectionalResidualBandwidth" }, "unidirectionalUtilizedBandwidth": { "$ref": "#/components/schemas/UnidirectionalUtilizedBandwidth" } }, "description": "Link performance metric normality attributes." }, "PerformanceMetricThrottle": { "title": "PerformanceMetricThrottle", "type": "object", "properties": { "advertisementInterval": { "type": "integer", "description": "Interval in seconds to advertise the extended metric values.", "format": "int64" }, "measureInterval": { "type": "integer", "description": "Interval in seconds to measure the extended metric values.", "format": "int64" }, "suppressionInterval": { "type": "integer", "description": "Interval in seconds to suppress advertising the extended metric values.", "format": "int64" }, "tePerformanceMetric": { "type": "object", "description": "This feature indicates that the system supports TE performance metric." }, "thresholdAcceleratedAdvertisement": { "$ref": "#/components/schemas/ThresholdAcceleratedAdvertisement2" }, "thresholdIn": { "$ref": "#/components/schemas/ThresholdIn2" }, "thresholdOut": { "$ref": "#/components/schemas/ThresholdOut2" }, "unidirectionalDelayOffset": { "type": "integer", "description": "Offset value to be added to the measured delay value.", "format": "int64" } }, "description": "Link performance information in real time." }, "PerformanceMetricThrottleContainer": { "title": "PerformanceMetricThrottleContainer", "type": "object", "properties": { "performanceMetricThrottle": { "$ref": "#/components/schemas/PerformanceMetricThrottle2" } }, "description": "A container controlling performance metric throttle." }, "PhysicalLink": { "title": "PhysicalLink", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "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": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "linkCost": { "$ref": "#/components/schemas/LinkCost" }, "lxcontainer": { "$ref": "#/components/schemas/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": { "$ref": "#/components/schemas/NeDeploymentState" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "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" }, "description": "" } }, "description": "A physical link represents a link connecting different network elements." }, "Platform": { "title": "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." } }, "description": "Contains vendor-specific information for identifying the system platform and operating system." }, "PolicyIdentifier": { "title": "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." } }, "description": "The parameters of a policy identifier" }, "Port": { "title": "Port", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "availableEgressBandwidth": { "type": "integer", "description": "Specifies the available egress bandwidth associated with a port", "format": "int64" }, "availableIngressBandwidth": { "type": "integer", "description": "Specifies the available ingress bandwidth associated with a port", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/Dc1" }, "description": { "type": "string", "description": "A textual description of the port." }, "ethernet": { "$ref": "#/components/schemas/Ethernet1" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "interfaceId": { "type": "integer", "description": "The id of the port/interface", "format": "int64" }, "name": { "type": "string", "description": "The name of the port" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "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": { "$ref": "#/components/schemas/OperationalState" }, "optics": { "$ref": "#/components/schemas/Optics1" }, "portCapability": { "$ref": "#/components/schemas/PortCapabilityType" }, "portSpeed": { "type": "integer", "description": "The interface speed of the port", "format": "int64" }, "portType": { "type": "string", "description": "The type of port. Supported values are defined in RFC7224" }, "role": { "$ref": "#/components/schemas/Role1" }, "tdm": { "$ref": "#/components/schemas/Tdm2" } }, "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": { "title": "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" } } }, "PortFilter": { "title": "PortFilter", "type": "object", "properties": { "condition1": { "$ref": "#/components/schemas/Condition1" }, "condition2": { "$ref": "#/components/schemas/Condition1" }, "connector": { "type": "string", "description": "Specifies operator that connects filter rules" }, "groupNum": { "type": "integer", "description": "Specifies the group filter element belongs to", "format": "int64" }, "name": { "type": "string", "description": "Specifies port key to filter on" }, "operator": { "type": "string", "description": "Specifies operator between condition1 and condition2" } } }, "PortRequest": { "title": "PortRequest", "type": "object", "properties": { "protectionType": { "$ref": "#/components/schemas/ProtectionType5" } }, "description": "A request object used to modify Port" }, "PrefixSid": { "title": "PrefixSid", "type": "object", "properties": { "prefixSidsInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PrefixSidFlags" } } } }, "PrefixSidFlags": { "title": "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" } } }, "ProvisionedHops": { "title": "ProvisionedHops", "type": "object", "properties": { "pathHops": { "$ref": "#/components/schemas/PathHops1" } }, "description": "Path provisioned hops. Include Route Objects (IRO)" }, "PushTags": { "title": "PushTags", "type": "object", "properties": { "outerTag": { "$ref": "#/components/schemas/OuterTag3" }, "secondTag": { "$ref": "#/components/schemas/SecondTag3" } }, "description": "The VLAN tags to push (or swap if used in conjunction with pop-tags)" }, "QosProfile": { "title": "QosProfile", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "egressCosMappingTable": { "type": "array", "items": { "$ref": "#/components/schemas/CosMapping" }, "description": "" }, "egressParam": { "$ref": "#/components/schemas/EgressParam2" }, "egressPolicyList": { "type": "array", "items": { "type": "string" }, "description": "The list of policy names as discovered from the network element. These policies don't need to be discovered yet." }, "egressQueueConfigurationTable": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "ingressCosMappingTable": { "type": "array", "items": { "$ref": "#/components/schemas/CosMapping" }, "description": "" }, "ingressParam": { "$ref": "#/components/schemas/IngressParam2" }, "ingressPolicyList": { "type": "array", "items": { "type": "string" }, "description": "The list of policy names as discovered from the network element. These policies don't need to be discovered yet." }, "ingressQueueConfigurationTable": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" } }, "description": "The Generic QoS Profile (GQP), which applies to L2 and L3 access interfaces." }, "QosTemplate": { "title": "QosTemplate", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "egressParam": { "$ref": "#/components/schemas/EgressParam2" }, "egressQueueOverride": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "ingressParam": { "$ref": "#/components/schemas/IngressParam2" }, "ingressQueueOverride": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "qosProfile": { "type": "integer", "description": "The ID of the default Generic QoS profile associated with the quality of service template", "format": "int64" } }, "description": "Qos template that defines cir & pir. Also used to template certain endpoint values" }, "Queue": { "title": "Queue", "type": "object", "properties": { "cbs": { "type": "integer", "description": "The Committed Burst Size in KB.", "format": "int64" }, "cir": { "type": "integer", "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", "format": "int64" }, "id": { "type": "integer", "description": "ID of the queue", "format": "int64" }, "mbs": { "type": "integer", "description": "The Maximum Burst Size in KB.", "format": "int64" }, "pir": { "type": "integer", "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", "format": "int64" }, "queueType": { "$ref": "#/components/schemas/QueueType" }, "rateType": { "$ref": "#/components/schemas/RateType" } }, "description": "The parameters of a queue" }, "RecordedHops": { "title": "RecordedHops", "type": "object", "properties": { "pathHops": { "$ref": "#/components/schemas/PathHops1" } }, "description": "Path recorded/actual hops. Recorded Route Objects (RRO)" }, "Recovery": { "title": "Recovery", "type": "object", "properties": { "protectionStatus": { "$ref": "#/components/schemas/ProtectionStatus" }, "restorationStatus": { "$ref": "#/components/schemas/RestorationStatus" } }, "description": "Status of the recovery process." }, "RequestAugmentationMetaJsonFileName": { "title": "RequestAugmentationMetaJsonFileName", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data1" } } }, "RequestAugmentationMeta": { "title": "RequestAugmentationMeta", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data2" } } }, "RequestBackhaulL2RequestData": { "title": "RequestBackhaulL2RequestData", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data3" } } }, "RequestClineServiceCreationTemplate": { "title": "RequestClineServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data4" } } }, "RequestClineServiceRequest": { "title": "RequestClineServiceRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data5" } } }, "RequestCustomAttributesTemplate": { "title": "RequestCustomAttributesTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data6" } } }, "RequestEaccessRequestData": { "title": "RequestEaccessRequestData", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data7" } } }, "RequestElanServiceCreationTemplate": { "title": "RequestElanServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data8" } } }, "RequestElineRequestData": { "title": "RequestElineRequestData", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data9" } } }, "RequestElineServiceCreationTemplate": { "title": "RequestElineServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data10" } } }, "RequestExternalId": { "title": "RequestExternalId", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data11" } } }, "RequestIesServiceCreationTemplate": { "title": "RequestIesServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data12" } } }, "RequestIpElanServiceRequest": { "title": "RequestIpElanServiceRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data13" } } }, "RequestIpIesServiceRequest": { "title": "RequestIpIesServiceRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data14" } } }, "RequestIpL3DciServiceRequest": { "title": "RequestIpL3DciServiceRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data15" } } }, "RequestIpL3ServiceNormalizedRequest": { "title": "RequestIpL3ServiceNormalizedRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data16" } } }, "RequestIpL3ServiceRequest": { "title": "RequestIpL3ServiceRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data17" } } }, "RequestIpOpticalCorrelationPolicy": { "title": "RequestIpOpticalCorrelationPolicy", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data18" } } }, "RequestL2DciVpnServiceCreationTemplate": { "title": "RequestL2DciVpnServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data19" } } }, "RequestL2EndpointRequest": { "title": "RequestL2EndpointRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data20" } } }, "RequestL2backhaulServiceCreationTemplate": { "title": "RequestL2backhaulServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data21" } } }, "RequestL3DciVpnServiceCreationTemplate": { "title": "RequestL3DciVpnServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data22" } } }, "RequestL3EndpointNormalizedRequest": { "title": "RequestL3EndpointNormalizedRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/L3EndpointNormalizedRequest" } } }, "RequestL3EndpointRequest": { "title": "RequestL3EndpointRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/L3EndpointRequest" } } }, "RequestL3vpnRdRtPolicy": { "title": "RequestL3vpnRdRtPolicy", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data23" } } }, "RequestL3vpnServiceCreationTemplate": { "title": "RequestL3vpnServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data24" } } }, "RequestLagRequest": { "title": "RequestLagRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data25" } } }, "RequestLagServiceCreationTemplate": { "title": "RequestLagServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data26" } } }, "RequestLatency": { "title": "RequestLatency", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data27" } } }, "RequestLinkParams": { "title": "RequestLinkParams", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data28" } } }, "RequestListLspPathConfigRequest": { "title": "RequestListLspPathConfigRequest", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LspPathConfigRequest" }, "description": "" } } }, "RequestListOpenflowFlowEntryRequest": { "title": "RequestListOpenflowFlowEntryRequest", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpenflowFlowEntryRequest" }, "description": "" } } }, "RequestListOpenflowFlowUpdateEntry": { "title": "RequestListOpenflowFlowUpdateEntry", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpenflowFlowUpdateEntry" }, "description": "" } } }, "RequestListstring": { "title": "RequestListstring", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "RequestLoopbackEndpointRequest": { "title": "RequestLoopbackEndpointRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data29" } } }, "RequestLspPathConfigRequest": { "title": "RequestLspPathConfigRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LspPathConfigRequest" } } }, "RequestMediationAugmentationRequest": { "title": "RequestMediationAugmentationRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data30" } } }, "RequestMediationProfileTemplateMapping": { "title": "RequestMediationProfileTemplateMapping", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data31" } } }, "RequestNetworkElementRequest": { "title": "RequestNetworkElementRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data32" } } }, "RequestNspEthtSvcAccessParameters": { "title": "RequestNspEthtSvcAccessParameters", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data33" } } }, "RequestOchServiceCreationTemplate": { "title": "RequestOchServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data34" } } }, "RequestOduServiceCreationTemplate": { "title": "RequestOduServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data35" } } }, "RequestOpenflowFlowSearchById": { "title": "RequestOpenflowFlowSearchById", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data36" } } }, "RequestOpenflowFlowSearch": { "title": "RequestOpenflowFlowSearch", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data37" } } }, "RequestOpticalConnectivityConstraintTemplate": { "title": "RequestOpticalConnectivityConstraintTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data38" } } }, "RequestOpticalConnectivityServiceTemplate": { "title": "RequestOpticalConnectivityServiceTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data39" } } }, "RequestOpticalResilienceConstraintTemplate": { "title": "RequestOpticalResilienceConstraintTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data40" } } }, "RequestOpticalRoutingConstraintTemplate": { "title": "RequestOpticalRoutingConstraintTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data41" } } }, "RequestOpticsRequest": { "title": "RequestOpticsRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data42" } } }, "RequestPathProfileTemplate": { "title": "RequestPathProfileTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data43" } } }, "RequestPathSearchRequest": { "title": "RequestPathSearchRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data44" } } }, "RequestPortRequest": { "title": "RequestPortRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data45" } } }, "RequestQosProfile": { "title": "RequestQosProfile", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data46" } } }, "RequestQosTemplate": { "title": "RequestQosTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data47" } } }, "RequestRouterIdSystemIdMapping": { "title": "RequestRouterIdSystemIdMapping", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data48" } } }, "RequestRouterPortProtectionGroupPolicy": { "title": "RequestRouterPortProtectionGroupPolicy", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data49" } } }, "RequestServiceTunnelRequest": { "title": "RequestServiceTunnelRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data50" } } }, "RequestSnmpTcaPolicyInfo": { "title": "RequestSnmpTcaPolicyInfo", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data51" } } }, "RequestSteeringParameter": { "title": "RequestSteeringParameter", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data52" } } }, "RequestSystemIpMplsConfig": { "title": "RequestSystemIpMplsConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SystemIpMplsConfig" } } }, "RequestTdmEndpointRequest": { "title": "RequestTdmEndpointRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data53" } } }, "RequestTeLinkConfig": { "title": "RequestTeLinkConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data54" } } }, "RequestTenantRequest": { "title": "RequestTenantRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data55" } } }, "RequestTenant": { "title": "RequestTenant", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data56" } } }, "RequestTrafficDataCollection": { "title": "RequestTrafficDataCollection", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data57" } } }, "RequestTunnelCreationTemplate": { "title": "RequestTunnelCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data58" } } }, "RequestTunnelSelectionTemplate": { "title": "RequestTunnelSelectionTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data59" } } }, "RequestWorkflowProfileTemplate": { "title": "RequestWorkflowProfileTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data60" } } }, "ResilienceConstraint": { "title": "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.", "format": "int32" }, "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.", "format": "int32" }, "resilienceType": { "$ref": "#/components/schemas/ResilienceType2" }, "restorationCoordinateType": { "$ref": "#/components/schemas/RestorationCoordinateType" }, "restorePriority": { "type": "integer", "description": "none", "format": "int32" }, "reversionMode": { "$ref": "#/components/schemas/ReversionMode2" }, "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.", "format": "int32" } }, "description": "A list of control parameters to apply to a switch." }, "ResilienceType": { "title": "ResilienceType", "type": "object", "properties": { "protectionType": { "$ref": "#/components/schemas/ProtectionType2" }, "restorationPolicy": { "$ref": "#/components/schemas/RestorationPolicy" } }, "description": "Resilience type" }, "ResponseDataAugmentationMeta": { "title": "ResponseDataAugmentationMeta", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseAugmentationMeta" } } }, "ResponseDataAuthentication": { "title": "ResponseDataAuthentication", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseAuthentication" } } }, "ResponseDataBackhaulPath": { "title": "ResponseDataBackhaulPath", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseBackhaulPath" } } }, "ResponseDataBaseEntity": { "title": "ResponseDataBaseEntity", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseBaseEntity" } } }, "ResponseDataBaseService": { "title": "ResponseDataBaseService", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseBaseService" } } }, "ResponseDataClineServiceCreationTemplate": { "title": "ResponseDataClineServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseClineServiceCreationTemplate" } } }, "ResponseDataCustomAttributesTemplate": { "title": "ResponseDataCustomAttributesTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseCustomAttributesTemplate" } } }, "ResponseDataCustomer": { "title": "ResponseDataCustomer", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseCustomer" } } }, "ResponseDataElanServiceCreationTemplate": { "title": "ResponseDataElanServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseElanServiceCreationTemplate" } } }, "ResponseDataElineServiceCreationTemplate": { "title": "ResponseDataElineServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseElineServiceCreationTemplate" } } }, "ResponseDataIesServiceCreationTemplate": { "title": "ResponseDataIesServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseIesServiceCreationTemplate" } } }, "ResponseDataIpOpticalCorrelationPolicy": { "title": "ResponseDataIpOpticalCorrelationPolicy", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseIpOpticalCorrelationPolicy" } } }, "ResponseDataL2DciVpnServiceCreationTemplate": { "title": "ResponseDataL2DciVpnServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseL2DciVpnServiceCreationTemplate" } } }, "ResponseDataL2backhaulServiceCreationTemplate": { "title": "ResponseDataL2backhaulServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseL2backhaulServiceCreationTemplate" } } }, "ResponseDataL3DciVpnServiceCreationTemplate": { "title": "ResponseDataL3DciVpnServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseL3DciVpnServiceCreationTemplate" } } }, "ResponseDataL3vpnRdRtPolicy": { "title": "ResponseDataL3vpnRdRtPolicy", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseL3vpnRdRtPolicy" } } }, "ResponseDataL3vpnServiceCreationTemplate": { "title": "ResponseDataL3vpnServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseL3vpnServiceCreationTemplate" } } }, "ResponseDataLagServiceCreationTemplate": { "title": "ResponseDataLagServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseLagServiceCreationTemplate" } } }, "ResponseDataLatency": { "title": "ResponseDataLatency", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseLatency" } } }, "ResponseDataLink": { "title": "ResponseDataLink", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseLink" } } }, "ResponseDataListAmiNameVersionTemplates": { "title": "ResponseDataListAmiNameVersionTemplates", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListAmiNameVersionTemplates" } } }, "ResponseDataListAmiNameVersions": { "title": "ResponseDataListAmiNameVersions", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListAmiNameVersions" } } }, "ResponseDataListAugmentationMetaInput": { "title": "ResponseDataListAugmentationMetaInput", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListAugmentationMetaInput" } } }, "ResponseDataListBaseEntity": { "title": "ResponseDataListBaseEntity", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListBaseEntity" } } }, "ResponseDataListBaseServiceEndpoint": { "title": "ResponseDataListBaseServiceEndpoint", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListBaseServiceEndpoint" } } }, "ResponseDataListBaseService": { "title": "ResponseDataListBaseService", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListBaseService" } } }, "ResponseDataListClineServiceCreationTemplate": { "title": "ResponseDataListClineServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListClineServiceCreationTemplate" } } }, "ResponseDataListCustomAttributesTemplate": { "title": "ResponseDataListCustomAttributesTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListCustomAttributesTemplate" } } }, "ResponseDataListCustomer": { "title": "ResponseDataListCustomer", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListCustomer" } } }, "ResponseDataListElanServiceCreationTemplate": { "title": "ResponseDataListElanServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListElanServiceCreationTemplate" } } }, "ResponseDataListElineServiceCreationTemplate": { "title": "ResponseDataListElineServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListElineServiceCreationTemplate" } } }, "ResponseDataListIesServiceCreationTemplate": { "title": "ResponseDataListIesServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListIesServiceCreationTemplate" } } }, "ResponseDataListIpOpticalCorrelationPolicy": { "title": "ResponseDataListIpOpticalCorrelationPolicy", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListIpOpticalCorrelationPolicy" } } }, "ResponseDataListL2DciVpnServiceCreationTemplate": { "title": "ResponseDataListL2DciVpnServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListL2DciVpnServiceCreationTemplate" } } }, "ResponseDataListL2backhaulServiceCreationTemplate": { "title": "ResponseDataListL2backhaulServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListL2backhaulServiceCreationTemplate" } } }, "ResponseDataListL3DciVpnServiceCreationTemplate": { "title": "ResponseDataListL3DciVpnServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListL3DciVpnServiceCreationTemplate" } } }, "ResponseDataListL3vpnRdRtPolicy": { "title": "ResponseDataListL3vpnRdRtPolicy", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListL3vpnRdRtPolicy" } } }, "ResponseDataListL3vpnServiceCreationTemplate": { "title": "ResponseDataListL3vpnServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListL3vpnServiceCreationTemplate" } } }, "ResponseDataListLagServiceCreationTemplate": { "title": "ResponseDataListLagServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListLagServiceCreationTemplate" } } }, "ResponseDataListLspPath": { "title": "ResponseDataListLspPath", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListLspPath" } } }, "ResponseDataListLsp": { "title": "ResponseDataListLsp", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListLsp" } } }, "ResponseDataListMediationProfileTemplateMapping": { "title": "ResponseDataListMediationProfileTemplateMapping", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListMediationProfileTemplateMapping" } } }, "ResponseDataListNePolicyIdentifier": { "title": "ResponseDataListNePolicyIdentifier", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListNePolicyIdentifier" } } }, "ResponseDataListNetworkElement": { "title": "ResponseDataListNetworkElement", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListNetworkElement" } } }, "ResponseDataListNspNodeWithNetwork": { "title": "ResponseDataListNspNodeWithNetwork", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListNspNodeWithNetwork" } } }, "ResponseDataListNspTerminationPoint": { "title": "ResponseDataListNspTerminationPoint", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListNspTerminationPoint" } } }, "ResponseDataListOchServiceCreationTemplate": { "title": "ResponseDataListOchServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOchServiceCreationTemplate" } } }, "ResponseDataListOduServiceCreationTemplate": { "title": "ResponseDataListOduServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOduServiceCreationTemplate" } } }, "ResponseDataListOpenflowFlowEntry": { "title": "ResponseDataListOpenflowFlowEntry", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOpenflowFlowEntry" } } }, "ResponseDataListOpenflowPort": { "title": "ResponseDataListOpenflowPort", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOpenflowPort" } } }, "ResponseDataListOpenflowSwitch": { "title": "ResponseDataListOpenflowSwitch", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOpenflowSwitch" } } }, "ResponseDataListOpenflowTable": { "title": "ResponseDataListOpenflowTable", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOpenflowTable" } } }, "ResponseDataListOpticalConnectivityConstraintTemplate": { "title": "ResponseDataListOpticalConnectivityConstraintTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOpticalConnectivityConstraintTemplate" } } }, "ResponseDataListOpticalConnectivityServiceTemplate": { "title": "ResponseDataListOpticalConnectivityServiceTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOpticalConnectivityServiceTemplate" } } }, "ResponseDataListOpticalResilienceConstraintTemplate": { "title": "ResponseDataListOpticalResilienceConstraintTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOpticalResilienceConstraintTemplate" } } }, "ResponseDataListOpticalRoutingConstraintTemplate": { "title": "ResponseDataListOpticalRoutingConstraintTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListOpticalRoutingConstraintTemplate" } } }, "ResponseDataListPathProfileTemplate": { "title": "ResponseDataListPathProfileTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListPathProfileTemplate" } } }, "ResponseDataListPhysicalLink": { "title": "ResponseDataListPhysicalLink", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListPhysicalLink" } } }, "ResponseDataListPolicyIdentifier": { "title": "ResponseDataListPolicyIdentifier", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListPolicyIdentifier" } } }, "ResponseDataListPort": { "title": "ResponseDataListPort", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListPort" } } }, "ResponseDataListQosProfile": { "title": "ResponseDataListQosProfile", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListQosProfile" } } }, "ResponseDataListQosTemplate": { "title": "ResponseDataListQosTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListQosTemplate" } } }, "ResponseDataListRouterIdSystemIdMapping": { "title": "ResponseDataListRouterIdSystemIdMapping", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListRouterIdSystemIdMapping" } } }, "ResponseDataListRouterPortProtectionGroupPolicy": { "title": "ResponseDataListRouterPortProtectionGroupPolicy", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListRouterPortProtectionGroupPolicy" } } }, "ResponseDataListServiceTunnel": { "title": "ResponseDataListServiceTunnel", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListServiceTunnel" } } }, "ResponseDataListSteeringParameter": { "title": "ResponseDataListSteeringParameter", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListSteeringParameter" } } }, "ResponseDataListSystemIpMplsConfig": { "title": "ResponseDataListSystemIpMplsConfig", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListSystemIpMplsConfig" } } }, "ResponseDataListTenant": { "title": "ResponseDataListTenant", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListTenant" } } }, "ResponseDataListTunnelCreationTemplate": { "title": "ResponseDataListTunnelCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListTunnelCreationTemplate" } } }, "ResponseDataListTunnelSelectionTemplate": { "title": "ResponseDataListTunnelSelectionTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListTunnelSelectionTemplate" } } }, "ResponseDataListUsergroup": { "title": "ResponseDataListUsergroup", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListUsergroup" } } }, "ResponseDataListWorkflowProfileTemplate": { "title": "ResponseDataListWorkflowProfileTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListWorkflowProfileTemplate" } } }, "ResponseDataListstring": { "title": "ResponseDataListstring", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListstring" } } }, "ResponseDataLspPath": { "title": "ResponseDataLspPath", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseLspPath" } } }, "ResponseDataLsp": { "title": "ResponseDataLsp", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseLsp" } } }, "ResponseDataMediationProfileTemplateMapping": { "title": "ResponseDataMediationProfileTemplateMapping", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseMediationProfileTemplateMapping" } } }, "ResponseDataNetworkElement": { "title": "ResponseDataNetworkElement", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseNetworkElement" } } }, "ResponseDataNetworks": { "title": "ResponseDataNetworks", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseNetworks" } } }, "ResponseDataNetwork": { "title": "ResponseDataNetwork", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseNetwork" } } }, "ResponseDataNode": { "title": "ResponseDataNode", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseNode" } } }, "ResponseDataOchServiceCreationTemplate": { "title": "ResponseDataOchServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseOchServiceCreationTemplate" } } }, "ResponseDataOduServiceCreationTemplate": { "title": "ResponseDataOduServiceCreationTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseOduServiceCreationTemplate" } } }, "ResponseDataOpticalConnectivityConstraintTemplate": { "title": "ResponseDataOpticalConnectivityConstraintTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseOpticalConnectivityConstraintTemplate" } } }, "ResponseDataOpticalConnectivityServiceTemplate": { "title": "ResponseDataOpticalConnectivityServiceTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseOpticalConnectivityServiceTemplate" } } }, "ResponseDataOpticalResilienceConstraintTemplate": { "title": "ResponseDataOpticalResilienceConstraintTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseOpticalResilienceConstraintTemplate" } } }, "ResponseDataOpticalRoutingConstraintTemplate": { "title": "ResponseDataOpticalRoutingConstraintTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseOpticalRoutingConstraintTemplate" } } }, "ResponseDataPathProfileTemplate": { "title": "ResponseDataPathProfileTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponsePathProfileTemplate" } } }, "ResponseDataPhysicalLink": { "title": "ResponseDataPhysicalLink", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponsePhysicalLink" } } }, "ResponseDataPort": { "title": "ResponseDataPort", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponsePort" } } }, "ResponseDataQosProfile": { "title": "ResponseDataQosProfile", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseQosProfile" } } }, "ResponseDataQosTemplate": { "title": "ResponseDataQosTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseQosTemplate" } } }, "ResponseDataRouterIdSystemIdMapping": { "title": "ResponseDataRouterIdSystemIdMapping", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseRouterIdSystemIdMapping" } } }, "ResponseDataRouterPortProtectionGroupPolicy": { "title": "ResponseDataRouterPortProtectionGroupPolicy", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseRouterPortProtectionGroupPolicy" } } }, "ResponseDataServiceDebugResult": { "title": "ResponseDataServiceDebugResult", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseServiceDebugResult" } } }, "ResponseDataServiceHierarchy": { "title": "ResponseDataServiceHierarchy", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseServiceHierarchy" } } }, "ResponseDataServiceTunnel": { "title": "ResponseDataServiceTunnel", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseServiceTunnel" } } }, "ResponseDataSnmpTcaPolicyInfo": { "title": "ResponseDataSnmpTcaPolicyInfo", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseSnmpTcaPolicyInfo" } } }, "ResponseDataSteeringParameter": { "title": "ResponseDataSteeringParameter", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseSteeringParameter" } } }, "ResponseDataTenant": { "title": "ResponseDataTenant", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseTenant" } } }, "ResponseDataTerminationPoint": { "title": "ResponseDataTerminationPoint", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseTerminationPoint" } } }, "ResponseDataTrafficDataCollection": { "title": "ResponseDataTrafficDataCollection", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseTrafficDataCollection" } } }, "ResponseDataTunnelSelectionTemplate": { "title": "ResponseDataTunnelSelectionTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseTunnelSelectionTemplate" } } }, "ResponseDataUsergroup": { "title": "ResponseDataUsergroup", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseUsergroup" } } }, "ResponseDataWorkflowProfileTemplate": { "title": "ResponseDataWorkflowProfileTemplate", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseWorkflowProfileTemplate" } } }, "ResponseDataboolean": { "title": "ResponseDataboolean", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/Responseboolean" } } }, "ResponseDatalong": { "title": "ResponseDatalong", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/Responselong" } } }, "ResponseDatastring": { "title": "ResponseDatastring", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/Responsestring" } } }, "ResponseAugmentationMeta": { "title": "ResponseAugmentationMeta", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data2" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseAuthentication": { "title": "ResponseAuthentication", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data62" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseBackhaulPath": { "title": "ResponseBackhaulPath", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BackhaulPath" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseBaseEntity": { "title": "ResponseBaseEntity", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BaseEntity" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseBaseService": { "title": "ResponseBaseService", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data63" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseClineServiceCreationTemplate": { "title": "ResponseClineServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data4" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseCustomAttributesTemplate": { "title": "ResponseCustomAttributesTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data6" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseCustomer": { "title": "ResponseCustomer", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data66" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseElanServiceCreationTemplate": { "title": "ResponseElanServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data8" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseElineServiceCreationTemplate": { "title": "ResponseElineServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data10" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseErrorMessages": { "title": "ResponseErrorMessages", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data127" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseIesServiceCreationTemplate": { "title": "ResponseIesServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data12" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseIpOpticalCorrelationPolicy": { "title": "ResponseIpOpticalCorrelationPolicy", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data18" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseL2DciVpnServiceCreationTemplate": { "title": "ResponseL2DciVpnServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data19" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseL2backhaulServiceCreationTemplate": { "title": "ResponseL2backhaulServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data21" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseL3DciVpnServiceCreationTemplate": { "title": "ResponseL3DciVpnServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data22" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseL3vpnRdRtPolicy": { "title": "ResponseL3vpnRdRtPolicy", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data23" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseL3vpnServiceCreationTemplate": { "title": "ResponseL3vpnServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data24" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseLagServiceCreationTemplate": { "title": "ResponseLagServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data26" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseLatency": { "title": "ResponseLatency", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data27" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseLink": { "title": "ResponseLink", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data78" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListAmiNameVersionTemplates": { "title": "ResponseListAmiNameVersionTemplates", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AmiNameVersionTemplates" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListAmiNameVersions": { "title": "ResponseListAmiNameVersions", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AmiNameVersions" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListAugmentationMetaInput": { "title": "ResponseListAugmentationMetaInput", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AugmentationMetaInput" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListBaseEntity": { "title": "ResponseListBaseEntity", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaseEntity" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListBaseServiceEndpoint": { "title": "ResponseListBaseServiceEndpoint", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaseServiceEndpoint" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListBaseService": { "title": "ResponseListBaseService", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaseService" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListClineServiceCreationTemplate": { "title": "ResponseListClineServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClineServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListCustomAttributesTemplate": { "title": "ResponseListCustomAttributesTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributesTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListCustomer": { "title": "ResponseListCustomer", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListElanServiceCreationTemplate": { "title": "ResponseListElanServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ElanServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListElineServiceCreationTemplate": { "title": "ResponseListElineServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ElineServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListIesServiceCreationTemplate": { "title": "ResponseListIesServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IesServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListIpOpticalCorrelationPolicy": { "title": "ResponseListIpOpticalCorrelationPolicy", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IpOpticalCorrelationPolicy" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListL2DciVpnServiceCreationTemplate": { "title": "ResponseListL2DciVpnServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/L2DciVpnServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListL2backhaulServiceCreationTemplate": { "title": "ResponseListL2backhaulServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/L2backhaulServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListL3DciVpnServiceCreationTemplate": { "title": "ResponseListL3DciVpnServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/L3DciVpnServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListL3vpnRdRtPolicy": { "title": "ResponseListL3vpnRdRtPolicy", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/L3vpnRdRtPolicy" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListL3vpnServiceCreationTemplate": { "title": "ResponseListL3vpnServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/L3vpnServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListLagServiceCreationTemplate": { "title": "ResponseListLagServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LagServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListLspPath": { "title": "ResponseListLspPath", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LspPath" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListLsp": { "title": "ResponseListLsp", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Lsp" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListMediationProfileTemplateMapping": { "title": "ResponseListMediationProfileTemplateMapping", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediationProfileTemplateMapping" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListNePolicyIdentifier": { "title": "ResponseListNePolicyIdentifier", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NePolicyIdentifier" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListNetworkElement": { "title": "ResponseListNetworkElement", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkElement" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListNspNodeWithNetwork": { "title": "ResponseListNspNodeWithNetwork", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NspNodeWithNetwork" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListNspTerminationPoint": { "title": "ResponseListNspTerminationPoint", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NspTerminationPoint" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOchServiceCreationTemplate": { "title": "ResponseListOchServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OchServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOduServiceCreationTemplate": { "title": "ResponseListOduServiceCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OduServiceCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOpenflowFlowEntry": { "title": "ResponseListOpenflowFlowEntry", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpenflowFlowEntry" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOpenflowPort": { "title": "ResponseListOpenflowPort", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpenflowPort" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOpenflowSwitch": { "title": "ResponseListOpenflowSwitch", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpenflowSwitch" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOpenflowTable": { "title": "ResponseListOpenflowTable", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpenflowTable" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOpticalConnectivityConstraintTemplate": { "title": "ResponseListOpticalConnectivityConstraintTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpticalConnectivityConstraintTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOpticalConnectivityServiceTemplate": { "title": "ResponseListOpticalConnectivityServiceTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpticalConnectivityServiceTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOpticalResilienceConstraintTemplate": { "title": "ResponseListOpticalResilienceConstraintTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpticalResilienceConstraintTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListOpticalRoutingConstraintTemplate": { "title": "ResponseListOpticalRoutingConstraintTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpticalRoutingConstraintTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListPathProfileTemplate": { "title": "ResponseListPathProfileTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PathProfileTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListPhysicalLink": { "title": "ResponseListPhysicalLink", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PhysicalLink" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListPolicyIdentifier": { "title": "ResponseListPolicyIdentifier", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyIdentifier" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListPort": { "title": "ResponseListPort", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Port" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListQosProfile": { "title": "ResponseListQosProfile", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QosProfile" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListQosTemplate": { "title": "ResponseListQosTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QosTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListRouterIdSystemIdMapping": { "title": "ResponseListRouterIdSystemIdMapping", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RouterIdSystemIdMapping" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListRouterPortProtectionGroupPolicy": { "title": "ResponseListRouterPortProtectionGroupPolicy", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RouterPortProtectionGroupPolicy" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListServiceTunnel": { "title": "ResponseListServiceTunnel", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTunnel" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListSteeringParameter": { "title": "ResponseListSteeringParameter", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListSystemIpMplsConfig": { "title": "ResponseListSystemIpMplsConfig", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SystemIpMplsConfig" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListTenant": { "title": "ResponseListTenant", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tenant" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListTunnelCreationTemplate": { "title": "ResponseListTunnelCreationTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TunnelCreationTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListTunnelSelectionTemplate": { "title": "ResponseListTunnelSelectionTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TunnelSelectionTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListUsergroup": { "title": "ResponseListUsergroup", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Usergroup" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListWorkflowProfileTemplate": { "title": "ResponseListWorkflowProfileTemplate", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowProfileTemplate" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListstring": { "title": "ResponseListstring", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Datum" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseLspPath": { "title": "ResponseLspPath", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data79" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseLsp": { "title": "ResponseLsp", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data80" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseMediationProfileTemplateMapping": { "title": "ResponseMediationProfileTemplateMapping", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data31" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseNetworkElement": { "title": "ResponseNetworkElement", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data82" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseNetworks": { "title": "ResponseNetworks", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Networks" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseNetwork": { "title": "ResponseNetwork", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data83" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseNode": { "title": "ResponseNode", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Node" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseOchServiceCreationTemplate": { "title": "ResponseOchServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data34" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseOduServiceCreationTemplate": { "title": "ResponseOduServiceCreationTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data35" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseOpticalConnectivityConstraintTemplate": { "title": "ResponseOpticalConnectivityConstraintTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data38" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseOpticalConnectivityServiceTemplate": { "title": "ResponseOpticalConnectivityServiceTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data39" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseOpticalResilienceConstraintTemplate": { "title": "ResponseOpticalResilienceConstraintTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data40" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseOpticalRoutingConstraintTemplate": { "title": "ResponseOpticalRoutingConstraintTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data41" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponsePathProfileTemplate": { "title": "ResponsePathProfileTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data43" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponsePhysicalLink": { "title": "ResponsePhysicalLink", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data91" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponsePort": { "title": "ResponsePort", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data92" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseQosProfile": { "title": "ResponseQosProfile", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data46" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseQosTemplate": { "title": "ResponseQosTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data47" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseRouterIdSystemIdMapping": { "title": "ResponseRouterIdSystemIdMapping", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data48" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseRouterPortProtectionGroupPolicy": { "title": "ResponseRouterPortProtectionGroupPolicy", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data49" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseServiceDebugResult": { "title": "ResponseServiceDebugResult", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data97" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseServiceHierarchy": { "title": "ResponseServiceHierarchy", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data98" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseServiceTunnel": { "title": "ResponseServiceTunnel", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data99" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseSnmpTcaPolicyInfo": { "title": "ResponseSnmpTcaPolicyInfo", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data51" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseSteeringParameter": { "title": "ResponseSteeringParameter", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data52" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseTenant": { "title": "ResponseTenant", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data56" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseTerminationPoint": { "title": "ResponseTerminationPoint", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TerminationPoint" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseTrafficDataCollection": { "title": "ResponseTrafficDataCollection", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data57" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseTunnelSelectionTemplate": { "title": "ResponseTunnelSelectionTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data59" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseUsergroup": { "title": "ResponseUsergroup", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data105" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseWorkflowProfileTemplate": { "title": "ResponseWorkflowProfileTemplate", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data60" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "Responseboolean": { "title": "Responseboolean", "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" } } }, "Responselong": { "title": "Responselong", "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" } } }, "Responsestring": { "title": "Responsestring", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ReversionPolicy": { "title": "ReversionPolicy", "type": "object", "properties": { "reversionMode": { "$ref": "#/components/schemas/ReversionMode4" }, "waitToRevertTime": { "$ref": "#/components/schemas/WaitToRevertTime2" } }, "description": "Router Port Protection Group reversion policy" }, "RiskCharacteristic": { "title": "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", "items": { "type": "string" }, "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." } }, "description": "The information for a particular risk characteristic where there is a list of risk identifiers related to that characteristic." }, "RouteTarget": { "title": "RouteTarget", "type": "object", "properties": { "rt": { "type": "string", "description": "The route target for the service" }, "targetType": { "$ref": "#/components/schemas/TargetType" } } }, "RouterIdSystemIdMapping": { "title": "RouterIdSystemIdMapping", "required": [ "name", "systemId" ], "type": "object", "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": { "$ref": "#/components/schemas/PccAddress" }, "routerInfos": { "type": "array", "items": { "$ref": "#/components/schemas/RouterInfo" }, "description": "" }, "systemId": { "$ref": "#/components/schemas/SystemId" }, "systemName": { "type": "string", "description": "The system name." } }, "description": "Policy template that defines system ID and router ID mapping." }, "RouterInfo": { "title": "RouterInfo", "required": [ "asNumber", "bgpLsId", "networkIdentifier", "routerId" ], "type": "object", "properties": { "asNumber": { "$ref": "#/components/schemas/AsNumber1" }, "bgpLsId": { "type": "integer", "description": "BGP-LS topology identifier.", "format": "int64" }, "dcIdentifier": { "type": "integer", "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.", "format": "int64" }, "networkIdentifier": { "$ref": "#/components/schemas/NetworkIdentifier" }, "protocol": { "$ref": "#/components/schemas/Protocol1" }, "routerId": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Object that defines router information." }, "RouterPortProtectionGroupPolicy": { "title": "RouterPortProtectionGroupPolicy", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/ReversionPolicy2" }, "switchPolicy": { "$ref": "#/components/schemas/SwitchPolicy2" } }, "description": "Router Port Protection Group policies" }, "RoutingBgp": { "title": "RoutingBgp", "type": "object", "properties": { "routes": { "type": "array", "items": { "$ref": "#/components/schemas/EbgpRoute" }, "description": "" } }, "description": "BGP specific configuration." }, "RoutingConstraint": { "title": "RoutingConstraint", "type": "object", "properties": { "costCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CostCharacteristic" }, "description": "" }, "diversityPolicy": { "$ref": "#/components/schemas/DiversityPolicy" }, "isExclusive": { "type": "boolean", "description": "To distinguish if the resources are to be exclusive to the service" }, "latencyCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/LatencyCharacteristic" }, "description": "" }, "riskDiversityCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/RiskCharacteristic" }, "description": "" }, "routeDirection": { "$ref": "#/components/schemas/RouteDirection" }, "routeObjectiveFunction": { "$ref": "#/components/schemas/RouteObjectiveFunction" } }, "description": "Routing constraint" }, "RoutingStatic": { "title": "RoutingStatic", "type": "object", "properties": { "routes": { "type": "array", "items": { "$ref": "#/components/schemas/StaticRoute" }, "description": "" } } }, "Schedule": { "title": "Schedule", "type": "object", "properties": { "timeRange": { "$ref": "#/components/schemas/TimeRange2" } }, "description": "Schedule" }, "Scheduler": { "title": "Scheduler", "type": "object", "properties": { "cir": { "type": "integer", "description": "Scheduler CIR override in either Kbps or percentage (0..100), where -3 is sum of CIR, -2 is no override, -1 is maximum", "format": "int64" }, "pir": { "type": "integer", "description": "Scheduler PIR override in either Kbps or percentage (1..100), where -2 is no override, -1 is maximum", "format": "int64" }, "rateType": { "$ref": "#/components/schemas/RateType1" }, "schedulerType": { "$ref": "#/components/schemas/SchedulerType" } }, "description": "The parameters of a scheduler" }, "Schedules": { "title": "Schedules", "type": "object", "properties": { "schedules": { "$ref": "#/components/schemas/Schedules1" } }, "description": "A list of schedules defining when a particular configuration takes effect." }, "SchedulesMember": { "title": "SchedulesMember", "type": "object", "properties": { "schedule": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Schedule" } } }, "description": "Container of a schedule list defining when a particular configuration takes effect." }, "SecondTag": { "title": "SecondTag", "type": "object", "properties": { "vlanWrite": { "$ref": "#/components/schemas/VlanWrite1" } }, "description": "The second outermost VLAN tag to push/swap." }, "ServiceDebugResult": { "title": "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" } }, "description": "An object to request a constraint test on a service" }, "ServiceHierarchy": { "title": "ServiceHierarchy", "type": "object", "properties": { "baseServiceHierarchy": { "$ref": "#/components/schemas/BaseServiceHierarchy1" } }, "description": "This object is a read only representation of a service and it's related hierarchy" }, "ServiceTunnel": { "title": "ServiceTunnel", "required": [ "bidirectional", "objective" ], "type": "object", "properties": { "actualEndState": { "$ref": "#/components/schemas/ActualEndState" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "availableBw": { "type": "integer", "description": "Specifies the available bandwidth on the service", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional1" }, "bw": { "type": "integer", "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)", "format": "int64" }, "cost": { "type": "number", "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": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "destinationEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTunnelEndpoint" }, "description": "" }, "destinationNodeId": { "$ref": "#/components/schemas/DestinationNodeId" }, "endpointExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndPointExtension" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/BaseServiceEndpoint" }, "description": "" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "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", "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.", "format": "int32" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "latency": { "type": "number", "description": "The latency of the tunnel in microseconds. The value of 2147483647 indicates infinite latency on the tunnel." }, "lifeCycle": { "$ref": "#/components/schemas/LifeCycle3" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "name": { "type": "string", "description": "The name of the service" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service. Populated only when same node service identifier is used across all sites.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "ownership": { "$ref": "#/components/schemas/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": "#/components/schemas/PhysicalLink" }, "description": "" }, "requestedEndState": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "serviceType": { "$ref": "#/components/schemas/ServiceType1" }, "sourceEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTunnelEndpoint" }, "description": "" }, "sourceNodeId": { "$ref": "#/components/schemas/SourceNodeId" }, "steeringParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" }, "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": { "$ref": "#/components/schemas/TunnelType" }, "underlyingTransport": { "$ref": "#/components/schemas/UnderlyingTransport" } }, "description": "A tunnel is a logical group that allows the assigning of network resources" }, "ServiceTunnelEndpoint": { "title": "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." } }, "description": "A source and/or destination endpoint of the service-tunnel." }, "ServiceTunnelRequest": { "title": "ServiceTunnelRequest", "type": "object", "properties": { "availableBw": { "type": "integer", "description": "Specifies the available bandwidth on the service", "format": "int64" }, "ownership": { "$ref": "#/components/schemas/Ownership" }, "steeringParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" } }, "description": "A request object used to modify tunnel entities in the network." }, "Servicetype": { "title": "Servicetype", "type": "object", "properties": { "string": { "type": "string" } }, "description": "Identifies the type of Ethernet service." }, "SiteServiceQosProfile": { "title": "SiteServiceQosProfile", "type": "object", "properties": { "egressOverrideQueues": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "egressParam": { "$ref": "#/components/schemas/EgressParam2" }, "ingressOverrideQueues": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "ingressParam": { "$ref": "#/components/schemas/IngressParam2" }, "qosProfile": { "type": "integer", "description": "The ID reference to the Generic QoS Profile", "format": "int64" } }, "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": { "title": "SnmpTcaPolicyInfo", "required": [ "policyEnabled" ], "type": "object", "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" } }, "description": "NSP configuration on SNMP TCA policy for statistic collection" }, "Source": { "title": "Source", "required": [ "sourceNode" ], "type": "object", "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." } }, "description": "This container holds the logical source of a particular link." }, "Srlg": { "title": "Srlg", "type": "object", "properties": { "uint32": { "type": "integer", "format": "int64" } }, "description": "SRLG type" }, "State": { "title": "State", "type": "object", "properties": { "teLinkConfig": { "$ref": "#/components/schemas/TeLinkConfig1" }, "teLinkStateDerived": { "$ref": "#/components/schemas/TeLinkStateDerived2" } }, "description": "Operational state data." }, "StaticRoute": { "title": "StaticRoute", "type": "object", "properties": { "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "destination": { "$ref": "#/components/schemas/Destination1" }, "preference": { "type": "integer", "description": "The preference of this static route. The default is 5 and the range is from 1 - 255", "format": "int64" }, "routeType": { "$ref": "#/components/schemas/RouteType" }, "targetIpAddress": { "$ref": "#/components/schemas/TargetIpAddress" } } }, "SteeringParameter": { "title": "SteeringParameter", "required": [ "name" ], "type": "object", "properties": { "name": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "A steering parameter is used to mark tunnels and guide tunnel selection" }, "SupportingLink": { "title": "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." } } }, "SupportingNode": { "title": "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." } } }, "SupportingTerminationPoint": { "title": "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" } } }, "SwitchPolicy": { "title": "SwitchPolicy", "type": "object", "properties": { "waitToSwitchTime": { "$ref": "#/components/schemas/WaitToSwitchTime2" } }, "description": "Router Port Protection Group switch policy" }, "SymmetricalOperation": { "title": "SymmetricalOperation", "type": "object", "properties": { "vlanOperations": { "$ref": "#/components/schemas/VlanOperations1" } }, "description": "Symmetrical operations. Expressed in the ingress direction, but the reverse operation is applied to egress traffic" }, "SystemIpMplsConfig": { "title": "SystemIpMplsConfig", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/MaintenanceMode" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" } } }, "TargetIpAddressInfo": { "title": "TargetIpAddressInfo", "type": "object", "properties": { "associatedTunnelType": { "$ref": "#/components/schemas/AssociatedTunnelType" }, "primaryAddress": { "$ref": "#/components/schemas/PrimaryAddress" } } }, "Tdm": { "title": "Tdm", "type": "object", "properties": { "channelFraming": { "type": "string", "description": "Specifies the channel framing configuration for the DS1/E1 port" }, "ds0ChannelGroups": { "type": "array", "items": { "$ref": "#/components/schemas/TdmDs0ChannelGroupInfo" }, "description": "" }, "signalMode": { "$ref": "#/components/schemas/SignalMode" } }, "description": "Contains TDM DS1/E1 interface related configuration" }, "TdmDs0ChannelGroupInfo": { "title": "TdmDs0ChannelGroupInfo", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState36" }, "encapType": { "$ref": "#/components/schemas/EncapType4" }, "id": { "type": "string", "description": "The identifier of this DS0 channel group" }, "name": { "type": "string", "description": "The name of this DS0 channel group" }, "operationalState": { "$ref": "#/components/schemas/OperationalState10" }, "timeSlots": { "type": "string", "description": "The time-slots configured on the DS0 channel group" } }, "description": "Attributes of the DS0 channel group" }, "TdmEndpointRequest": { "title": "TdmEndpointRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/SiteServiceQosProfile1" }, "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" } }, "description": "The TDM DS0 channel group definition" }, "Te": { "title": "Te", "type": "object", "properties": { "config": { "$ref": "#/components/schemas/Config1" }, "state": { "$ref": "#/components/schemas/State1" } }, "description": "Indicates TE support." }, "TeGlobalId": { "title": "TeGlobalId", "type": "object", "properties": { "uint32": { "type": "integer", "format": "int64" } }, "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": { "title": "TeLinkAttributes", "type": "object", "properties": { "accessType": { "$ref": "#/components/schemas/AccessType" }, "adminStatus": { "$ref": "#/components/schemas/AdminStatus" }, "externalDomain": { "$ref": "#/components/schemas/ExternalDomain2" }, "isAbstract": { "type": "object", "description": "Present if the link is abstract." }, "name": { "type": "string", "description": "Link Name." }, "performanceMetricThrottleContainer": { "$ref": "#/components/schemas/PerformanceMetricThrottleContainer2" }, "schedules": { "$ref": "#/components/schemas/Schedules2" }, "teLinkInfoAttributes": { "$ref": "#/components/schemas/TeLinkInfoAttributes1" }, "underlay": { "$ref": "#/components/schemas/Underlay3" } }, "description": "Link attributes in a TE topology." }, "TeLinkAugment": { "title": "TeLinkAugment", "type": "object", "properties": { "te": { "$ref": "#/components/schemas/Te1" } }, "description": "Augmentation for TE link." }, "TeLinkConfig": { "title": "TeLinkConfig", "type": "object", "properties": { "bundledLinks": { "$ref": "#/components/schemas/BundledLinks1" }, "componentLinks": { "$ref": "#/components/schemas/ComponentLinks1" }, "teLinkAttributes": { "$ref": "#/components/schemas/TeLinkAttributes1" }, "teLinkTemplate": { "type": "array", "items": { "type": "string" }, "description": "The reference to a TE link template." }, "template": { "type": "object", "description": "This feature indicates that the system supports template configuration." } }, "description": "TE link configuration grouping." }, "TeLinkConfigAttributes": { "title": "TeLinkConfigAttributes", "type": "object", "properties": { "teLinkAttributes": { "$ref": "#/components/schemas/TeLinkAttributes1" } }, "description": "Link configuration attributes in a TE topology." }, "TeLinkConnectivityAttributes": { "title": "TeLinkConnectivityAttributes", "type": "object", "properties": { "maxLinkBandwidth": { "type": "number", "description": "Maximum bandwidth that can be seen on this link in this direction. Units in bytes per second." }, "maxResvLinkBandwidth": { "type": "number", "description": "Maximum amount of bandwidth that can be reserved in this direction in this link. Units in bytes per second." }, "performanceMetric": { "$ref": "#/components/schemas/PerformanceMetric2" }, "teDefaultMetric": { "type": "integer", "description": "Traffic Engineering Metric.", "format": "int64" }, "teSrlgs": { "$ref": "#/components/schemas/TeSrlgs2" }, "unreservedBandwidth": { "type": "object", "additionalProperties": { "type": "number" } } }, "description": "Advertised TE connectivity attributes." }, "TeLinkInfoAttributes": { "title": "TeLinkInfoAttributes", "type": "object", "properties": { "administrativeGroup": { "$ref": "#/components/schemas/AdministrativeGroup" }, "interfaceSwitchingCapabilityList": { "$ref": "#/components/schemas/InterfaceSwitchingCapabilityList2" }, "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.", "format": "int32" }, "linkProtectionType": { "$ref": "#/components/schemas/LinkProtectionType" }, "teLinkConnectivityAttributes": { "$ref": "#/components/schemas/TeLinkConnectivityAttributes1" } }, "description": "Advertised TE information attributes." }, "TeLinkStateDerived": { "title": "TeLinkStateDerived", "type": "object", "properties": { "informationSource": { "$ref": "#/components/schemas/InformationSource" }, "informationSourceEntry": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/InformationSourceEntry" } }, "informationSourceState": { "$ref": "#/components/schemas/InformationSourceState2" }, "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." }, "operStatus": { "$ref": "#/components/schemas/OperStatus2" }, "recovery": { "$ref": "#/components/schemas/Recovery1" }, "underlay": { "$ref": "#/components/schemas/Underlay1" } }, "description": "Link state attributes in a TE topology." }, "TeLinkStateDerivedUnderlay": { "title": "TeLinkStateDerivedUnderlay", "type": "object", "properties": { "teLinkStateUnderlayAttributes": { "$ref": "#/components/schemas/TeLinkStateUnderlayAttributes1" }, "teTopologyHierarchy": { "type": "object", "description": "This feature indicates that the system allows underlay and/or overlay TE topology hierarchy." } }, "description": "State attributes for te-link underlay." }, "TeLinkStateUnderlayAttributes": { "title": "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." } }, "description": "State attributes for te-link underlay." }, "TeLinkUnderlayAttributes": { "title": "TeLinkUnderlayAttributes", "type": "object", "properties": { "underlayBackupPath": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UnderlayBackupPath" } }, "underlayPrimaryPath": { "$ref": "#/components/schemas/UnderlayPrimaryPath2" }, "underlayProtectionType": { "type": "integer", "description": "Underlay protection type desired for this link", "format": "int32" }, "underlayTrailDes": { "$ref": "#/components/schemas/UnderlayTrailDes2" }, "underlayTrailSrc": { "$ref": "#/components/schemas/UnderlayTrailSrc2" } }, "description": "Attributes for te-link underlay." }, "TeNodeAttributes": { "title": "TeNodeAttributes", "type": "object", "properties": { "adminStatus": { "$ref": "#/components/schemas/AdminStatus" }, "schedules": { "$ref": "#/components/schemas/Schedules2" }, "teNodeConnectivityMatrix": { "$ref": "#/components/schemas/TeNodeConnectivityMatrix1" }, "teNodeInfoAttributes": { "$ref": "#/components/schemas/TeNodeInfoAttributes1" } }, "description": "Containing node attributes in a TE topology." }, "TeNodeAugment": { "title": "TeNodeAugment", "type": "object", "properties": { "te": { "$ref": "#/components/schemas/Te2" } }, "description": "Augmentation for TE node." }, "TeNodeAugmentTe": { "title": "TeNodeAugmentTe", "required": [ "teNodeId" ], "type": "object", "properties": { "config": { "$ref": "#/components/schemas/Config2" }, "state": { "$ref": "#/components/schemas/State3" }, "teNodeId": { "$ref": "#/components/schemas/TeNodeId2" }, "tunnelTerminationPoint": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TunnelTerminationPoint" } } }, "description": "Indicates TE support." }, "TeNodeAugmentTeConfig": { "title": "TeNodeAugmentTeConfig", "type": "object", "properties": { "teNodeConfig": { "$ref": "#/components/schemas/TeNodeConfig1" } }, "description": "Configuration data." }, "TeNodeAugmentTeState": { "title": "TeNodeAugmentTeState", "type": "object", "properties": { "teNodeConfig": { "$ref": "#/components/schemas/TeNodeConfig1" }, "teNodeStateDerived": { "$ref": "#/components/schemas/TeNodeStateDerived2" } }, "description": "Operational state data." }, "TeNodeConfig": { "title": "TeNodeConfig", "type": "object", "properties": { "teNodeAttributes": { "$ref": "#/components/schemas/TeNodeAttributes2" }, "teNodeTemplate": { "type": "array", "items": { "type": "string" }, "description": "The reference to a TE node template." }, "template": { "type": "object", "description": "This feature indicates that the system supports template configuration." } }, "description": "TE node configuration grouping." }, "TeNodeConfigAttributesTemplate": { "title": "TeNodeConfigAttributesTemplate", "type": "object", "properties": { "teNodeAttributes": { "$ref": "#/components/schemas/TeNodeAttributes3" } }, "description": "Configuration node attributes for template in a TE topology." }, "TeNodeConfigAttributesTemplateTeNodeAttributes": { "title": "TeNodeConfigAttributesTemplateTeNodeAttributes", "type": "object", "properties": { "adminStatus": { "$ref": "#/components/schemas/AdminStatus" }, "schedules": { "$ref": "#/components/schemas/Schedules2" }, "teNodeInfoAttributes": { "$ref": "#/components/schemas/TeNodeInfoAttributes1" } }, "description": "Containing node attributes in a TE topology." }, "TeNodeConnectivityMatrix": { "title": "TeNodeConnectivityMatrix", "type": "object", "properties": { "connectivityMatrix": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectivityMatrix" } } }, "description": "Connectivity matrix on a TE node." }, "TeNodeId": { "title": "TeNodeId", "type": "object", "properties": { "dottedQuad": { "$ref": "#/components/schemas/UrlSafeString" } }, "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": { "title": "TeNodeInfoAttributes", "type": "object", "properties": { "domainId": { "type": "integer", "description": "Identifies the domain that this node belongs. This attribute is used to support inter-domain links.", "format": "int64" }, "isAbstract": { "type": "object", "description": "Present if the node is abstract, not present if the node is actual." }, "name": { "$ref": "#/components/schemas/UrlSafeString" }, "signalingAddress": { "type": "array", "items": { "$ref": "#/components/schemas/IpAddress" }, "description": "Node signaling address." }, "underlayTopology": { "$ref": "#/components/schemas/UnderlayTopology2" } }, "description": "Advertised TE information attributes." }, "TeNodeStateDerived": { "title": "TeNodeStateDerived", "type": "object", "properties": { "informationSource": { "$ref": "#/components/schemas/InformationSource" }, "informationSourceEntry": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TeNodeStateDerivedInformationSourceEntry" } }, "informationSourceState": { "$ref": "#/components/schemas/InformationSourceState2" }, "isMultiAccessDr": { "type": "object", "description": "The presence of this attribute indicates that this TE node is a pseudonode elected as a designated router." }, "operStatus": { "$ref": "#/components/schemas/OperStatus3" } }, "description": "Node state attributes in a TE topology." }, "TeNodeStateDerivedInformationSourceEntry": { "title": "TeNodeStateDerivedInformationSourceEntry", "type": "object", "properties": { "informationSourceAttributes": { "$ref": "#/components/schemas/InformationSourceAttributes1" }, "teNodeConnectivityMatrix": { "$ref": "#/components/schemas/TeNodeConnectivityMatrix1" }, "teNodeInfoAttributes": { "$ref": "#/components/schemas/TeNodeInfoAttributes1" } } }, "TeNodeTunnelTerminationCapability": { "title": "TeNodeTunnelTerminationCapability", "type": "object", "properties": { "encoding": { "type": "object", "description": "Base identity for encoding types" }, "interLayerLockId": { "type": "integer", "description": "Inter layer lock ID, used for path computation in a TE topology covering multiple layers or multiple regions.", "format": "int64" }, "protectionType": { "type": "object", "description": "Base identity from which LSP protection types are derived." }, "switchingCapability": { "type": "object", "description": "Base identity for interface switching capabilities" }, "terminationCapability": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TerminationCapability" } } }, "description": "Termination capability of a tunnel termination point on a TE node." }, "TePathElement": { "title": "TePathElement", "type": "object", "properties": { "asNumber": { "type": "integer", "description": "AS number", "format": "int32" }, "interfaceId": { "type": "integer", "description": "The interface identifier", "format": "int64" }, "routerId": { "$ref": "#/components/schemas/RouterId1" }, "v4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "v4Loose": { "type": "boolean", "description": "Describes whether the object is loose if set, or otherwise strict" }, "v4PrefixLength": { "type": "integer", "description": "Length in bits of the IPv4 prefix", "format": "int32" }, "v6Address": { "$ref": "#/components/schemas/UrlSafeString" }, "v6Loose": { "type": "boolean", "description": "Describes whether the object is loose if set, or otherwise strict" }, "v6PrefixLength": { "type": "integer", "description": "Length in bits of the IPv4 prefix", "format": "int32" }, "value": { "type": "integer", "description": "the label value", "format": "int64" } }, "description": "A group of attributes defining an element in a TE path such as TE node, TE link, TE atomic resource or label." }, "TeSrlgs": { "title": "TeSrlgs", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Srlg" }, "description": "SRLG value." } }, "description": "A list of SLRGs." }, "TeTemplateName": { "title": "TeTemplateName", "type": "object", "properties": { "string": { "type": "string" } }, "description": "A type for the name of a TE node template or TE link template." }, "TeTerminationPointAugment": { "title": "TeTerminationPointAugment", "type": "object", "properties": { "te": { "$ref": "#/components/schemas/Te3" } }, "description": "Augmentation for TE termination point." }, "TeTerminationPointAugmentTe": { "title": "TeTerminationPointAugmentTe", "required": [ "teTpId" ], "type": "object", "properties": { "config": { "$ref": "#/components/schemas/Config4" }, "state": { "$ref": "#/components/schemas/State5" }, "teTpId": { "$ref": "#/components/schemas/TeTpId2" } }, "description": "Indicates TE support." }, "TeTerminationPointAugmentTeConfig": { "title": "TeTerminationPointAugmentTeConfig", "type": "object", "properties": { "teTerminationPointConfig": { "$ref": "#/components/schemas/TeTerminationPointConfig1" } }, "description": "Configuration data." }, "TeTerminationPointAugmentTeState": { "title": "TeTerminationPointAugmentTeState", "type": "object", "properties": { "teTerminationPointConfig": { "$ref": "#/components/schemas/TeTerminationPointConfig1" } }, "description": "Operational state data." }, "TeTerminationPointConfig": { "title": "TeTerminationPointConfig", "type": "object", "properties": { "interLayerLockId": { "type": "integer", "description": "Inter layer lock ID, used for path computation in a TE topology covering multiple layers or multiple regions.", "format": "int64" }, "interfaceSwitchingCapabilityList": { "$ref": "#/components/schemas/InterfaceSwitchingCapabilityList2" }, "schedules": { "$ref": "#/components/schemas/Schedules2" } }, "description": "TE termination point configuration grouping." }, "TeTopologiesAugment": { "title": "TeTopologiesAugment", "type": "object", "properties": { "te": { "$ref": "#/components/schemas/Te4" } }, "description": "Augmentation for TE topologies." }, "TeTopologiesAugmentTe": { "title": "TeTopologiesAugmentTe", "type": "object", "properties": { "templates": { "$ref": "#/components/schemas/Templates2" } }, "description": "Indicates TE support." }, "TeTopologyAugment": { "title": "TeTopologyAugment", "type": "object", "properties": { "te": { "$ref": "#/components/schemas/Te5" } }, "description": "Augmentation for TE topology." }, "TeTopologyAugmentTe": { "title": "TeTopologyAugmentTe", "required": [ "clientId", "providerId", "teTopologyId" ], "type": "object", "properties": { "clientId": { "$ref": "#/components/schemas/ClientId" }, "config": { "$ref": "#/components/schemas/Config5" }, "providerId": { "$ref": "#/components/schemas/ProviderId" }, "state": { "$ref": "#/components/schemas/State6" }, "teTopologyId": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Indicates TE support." }, "TeTopologyAugmentTeConfig": { "title": "TeTopologyAugmentTeConfig", "type": "object", "properties": { "teTopologyConfig": { "$ref": "#/components/schemas/TeTopologyConfig1" } }, "description": "Configuration data." }, "TeTopologyAugmentTeState": { "title": "TeTopologyAugmentTeState", "type": "object", "properties": { "teTopologyConfig": { "$ref": "#/components/schemas/TeTopologyConfig1" } }, "description": "Operational state data." }, "TeTopologyConfig": { "title": "TeTopologyConfig", "type": "object", "properties": { "optimizationCriterion": { "type": "object", "description": "Base identity for TE optimization criterion." }, "preference": { "type": "integer", "description": "Specifies a preference for this topology. A lower number indicates a higher preference.", "format": "int32" }, "schedules": { "$ref": "#/components/schemas/Schedules1" } }, "description": "TE topology configuration grouping." }, "TeTopologyId": { "title": "TeTopologyId", "type": "object", "properties": { "string": { "type": "string" } }, "description": "An identifier for a topology." }, "TeTopologyRef": { "title": "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." } }, "description": "References a TE topology." }, "TeTpId": { "title": "TeTpId", "type": "object", "properties": { "ipAddress": { "$ref": "#/components/schemas/IpAddress1" }, "uint32": { "type": "integer", "format": "int64" } }, "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." }, "TemplateAttributes": { "title": "TemplateAttributes", "type": "object", "properties": { "priority": { "type": "integer", "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.", "format": "int32" }, "referenceChangePolicy": { "$ref": "#/components/schemas/ReferenceChangePolicy" } }, "description": "Common attributes for all templates." }, "Templates": { "title": "Templates", "type": "object", "properties": { "linkTemplate": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LinkTemplate" } }, "nodeTemplate": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NodeTemplate" } } }, "description": "Configuration parameters for templates used for TE topology." }, "Tenant": { "title": "Tenant", "required": [ "tenantName" ], "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", "description": "The customer-id associated with the tenant. This is optional and default value is 1", "format": "int64" }, "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" } }, "description": "A tenant is a logical group that allows the assigning of network resources" }, "TenantRequest": { "title": "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", "description": "The customer-id associated with the tenant", "format": "int64" }, "phoneNumber": { "type": "string", "description": "The phone number for the tenant" } }, "description": "A request object used to modify Tenant" }, "TerminationCapability": { "title": "TerminationCapability", "type": "object", "properties": { "labelRestriction": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LabelRestriction" } }, "linkTp": { "type": "string", "description": "Link termination point." }, "maxLspBandwidth": { "type": "object", "additionalProperties": { "type": "number" } } } }, "TerminationPoint": { "title": "TerminationPoint", "type": "object", "properties": { "nspTerminationPoint": { "$ref": "#/components/schemas/NspTerminationPoint2" }, "supportingTerminationPoint": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SupportingTerminationPoint" } }, "tpId": { "$ref": "#/components/schemas/TpId1" } } }, "TerminationPointConfig": { "title": "TerminationPointConfig", "type": "object", "properties": { "terminationPointParams": { "$ref": "#/components/schemas/TerminationPointParams1" } }, "description": "Configuration data" }, "TerminationPointParams": { "title": "TerminationPointParams", "type": "object", "properties": { "adjacencySegmentId": { "$ref": "#/components/schemas/AdjacencySegmentId1" }, "adjacencySegmentIdData": { "$ref": "#/components/schemas/AdjacencySegmentIdData1" }, "areaIds": { "type": "array", "items": { "type": "string" }, "description": "Identify the area in the network" }, "isisLevel": { "$ref": "#/components/schemas/IsisLevel" }, "prefixSid": { "$ref": "#/components/schemas/PrefixSid" }, "tpId": { "$ref": "#/components/schemas/TpId3" } }, "description": "NSP termination point parameters grouping" }, "TerminationPointState": { "title": "TerminationPointState", "type": "object", "properties": { "terminationPointParams": { "$ref": "#/components/schemas/TerminationPointParams1" } }, "description": "Operational state data" }, "ThresholdAcceleratedAdvertisement": { "title": "ThresholdAcceleratedAdvertisement", "type": "object", "properties": { "performanceMetricAttributes": { "$ref": "#/components/schemas/PerformanceMetricAttributes1" } }, "description": "When the difference between the last advertised value and current measured value exceed this threshold, anomalous announcement will be triggered." }, "ThresholdIn": { "title": "ThresholdIn", "type": "object", "properties": { "performanceMetricAttributes": { "$ref": "#/components/schemas/PerformanceMetricAttributes1" } }, "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": { "title": "ThresholdOut", "type": "object", "properties": { "performanceMetricAttributes": { "$ref": "#/components/schemas/PerformanceMetricAttributes1" } }, "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": { "title": "Tier1Scheduler", "type": "object", "properties": { "scheduler": { "$ref": "#/components/schemas/Scheduler2" } }, "description": "Tier1 Ingress QoS scheduler parameters" }, "Time": { "title": "Time", "type": "object", "properties": { "timeUnit": { "$ref": "#/components/schemas/TimeUnit" }, "value": { "type": "integer", "description": "Value", "format": "int64" } } }, "TimeDivisionMultiplexCapable": { "title": "TimeDivisionMultiplexCapable", "type": "object", "properties": { "indication": { "$ref": "#/components/schemas/Indication" }, "minimumLspBandwidth": { "type": "number", "description": "Minimum LSP Bandwidth. Units in bytes per second." } }, "description": "Interface has time-division multiplex capabilities." }, "TimeRange": { "title": "TimeRange", "type": "object", "properties": { "endTime": { "$ref": "#/components/schemas/UrlSafeString" }, "startTime": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Time range" }, "To": { "title": "To", "type": "object", "properties": { "tpRef": { "type": "string", "description": "Relative reference to destination termination point." } }, "description": "Reference to destination NTP." }, "Topology": { "title": "Topology", "type": "object", "properties": { "teTopologyRef": { "$ref": "#/components/schemas/TeTopologyRef1" } }, "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": { "title": "TpId", "type": "object", "properties": { "uri": { "$ref": "#/components/schemas/UrlSafeString" } }, "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": { "title": "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.)" } }, "description": "References a termination point in a specific node." }, "TrafficDataCollection": { "title": "TrafficDataCollection", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Toggle whether NSP traffic collection is enabled or not." }, "flowCollection": { "$ref": "#/components/schemas/FlowCollection1" }, "linkBwTargetThreshold": { "type": "integer", "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.", "format": "int32" }, "linkBwTriggerThreshold": { "type": "integer", "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.", "format": "int32" }, "source": { "$ref": "#/components/schemas/Source1" } }, "description": "Grouping of all traffic collection parameters" }, "TunnelCreationTemplate": { "title": "TunnelCreationTemplate", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/ProtectionType6" } }, "description": "The tunnel creation template controls system behaviour when automatically creating tunnels in the network. Deprecated: Please use tunnel-creation-template instead." }, "TunnelSelectionTemplate": { "title": "TunnelSelectionTemplate", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bgpPriority": { "type": "integer", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "looseRsvpPriority": { "type": "integer", "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]", "format": "int32" }, "looseSrTePriority": { "type": "integer", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "pccInitiatedSrTePriority": { "type": "integer", "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]", "format": "int32" }, "protection": { "type": "boolean", "description": "Specifies whether or not the tunnel has a protection path. Only applicable when creating a new LSP" }, "protectionType": { "$ref": "#/components/schemas/ProtectionType7" }, "shouldAvoidOperStateDown": { "type": "boolean", "description": "Specifies whether or not the policy should avoid resource which their operational state is down" }, "srIsisPriority": { "type": "integer", "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]", "format": "int32" }, "srOspfPriority": { "type": "integer", "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]", "format": "int32" }, "steeringParametersExcluded": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" }, "steeringParametersIncluded": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" }, "strictRsvpPriority": { "type": "integer", "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]", "format": "int32" }, "strictSrTePriority": { "type": "integer", "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]", "format": "int32" }, "targetIpAddressInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/TargetIpAddressInfo" }, "description": "" } }, "description": "The tunnel selection template controls system behaviour when selecting/creating tunnels in the network." }, "TunnelTerminationPoint": { "title": "TunnelTerminationPoint", "type": "object", "properties": { "config": { "$ref": "#/components/schemas/Config3" }, "state": { "$ref": "#/components/schemas/State4" }, "tunnelTpId": { "type": "string", "description": "Tunnel termination point identifier." } } }, "TunnelTerminationPointConfig": { "title": "TunnelTerminationPointConfig", "type": "object", "properties": { "teNodeTunnelTerminationCapability": { "$ref": "#/components/schemas/TeNodeTunnelTerminationCapability1" } }, "description": "Configuration data." }, "TunnelTerminationPointState": { "title": "TunnelTerminationPointState", "type": "object", "properties": { "teNodeTunnelTerminationCapability": { "$ref": "#/components/schemas/TeNodeTunnelTerminationCapability1" } }, "description": "Operational state data." }, "TwampTest": { "title": "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" } }, "description": "Object representing a single TWAMP test" }, "Underlay": { "title": "Underlay", "type": "object", "properties": { "teLinkStateUnderlayAttributes": { "$ref": "#/components/schemas/TeLinkStateUnderlayAttributes1" }, "teLinkUnderlayAttributes": { "$ref": "#/components/schemas/TeLinkUnderlayAttributes2" }, "teTopologyHierarchy": { "type": "object", "description": "This feature indicates that the system allows underlay and/or overlay TE topology hierarchy." } }, "description": "Attributes of the te-link underlay." }, "UnderlayBackupPath": { "title": "UnderlayBackupPath", "type": "object", "properties": { "clientIdRef": { "type": "string", "description": "A reference to a client-id." }, "index": { "type": "integer", "description": "A sequence number to identify a backup path.", "format": "int64" }, "networkIdRef": { "type": "string", "description": "A reference to a network-id in base ietf-network module." }, "pathElement": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TePathElement" } }, "providerIdRef": { "type": "string", "description": "A reference to a provider-id." }, "teTopologyIdRef": { "type": "string", "description": "A reference to a te-topology-id." } } }, "UnderlayPrimaryPath": { "title": "UnderlayPrimaryPath", "type": "object", "properties": { "pathElement": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TePathElement" } }, "teTopologyRef": { "$ref": "#/components/schemas/TeTopologyRef1" } }, "description": "The service path on the underlay topology that supports this link." }, "UnderlayTopology": { "title": "UnderlayTopology", "type": "object", "properties": { "teTopologyHierarchy": { "type": "object", "description": "This feature indicates that the system allows underlay and/or overlay TE topology hierarchy." }, "teTopologyRef": { "$ref": "#/components/schemas/TeTopologyRef1" } }, "description": "When an abstract node encapsulates a topology, the attributes in this container point to said topology." }, "UnderlayTrailDes": { "title": "UnderlayTrailDes", "type": "object", "properties": { "tpRef": { "$ref": "#/components/schemas/TpRef1" } }, "description": "Destination TE link of the underlay trail." }, "UnderlayTrailSrc": { "title": "UnderlayTrailSrc", "type": "object", "properties": { "tpRef": { "$ref": "#/components/schemas/TpRef1" } }, "description": "Source TE link of the underlay trail." }, "UniPort": { "title": "UniPort", "type": "object", "properties": { "actualEndState": { "$ref": "#/components/schemas/ActualEndState1" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "name": { "type": "string", "description": "The name of the service endpoint" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "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": { "$ref": "#/components/schemas/OperationalState" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portAdminState": { "$ref": "#/components/schemas/PortAdminState" }, "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": { "$ref": "#/components/schemas/PortOperationalState" }, "portSpeed": { "type": "integer", "description": "The bandwidth of port used by endpoint", "format": "int64" }, "serviceId": { "type": "string", "description": "The identifier of the service that uses this endpoint" } } }, "UniPortConfig": { "title": "UniPortConfig", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "name": { "type": "string", "description": "The name of the endpoint" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" } }, "description": "The UNI Port endpoint definition" }, "Uri": { "title": "Uri", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "UrlSafeString", "type": "object", "properties": { "string": { "type": "string" } } }, "User": { "title": "User", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The user unique identifier" }, "name": { "type": "string", "description": "The user name" } }, "description": "The user defined in the system" }, "Usergroup": { "title": "Usergroup", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The usergroup name" } }, "description": "The usergroup defined in the system" }, "VidRangeType": { "title": "VidRangeType", "type": "object", "properties": { "string": { "type": "string" } }, "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": { "title": "VlanClassification", "type": "object", "properties": { "tagType": { "$ref": "#/components/schemas/UrlSafeString" }, "vlanRange": { "$ref": "#/components/schemas/UrlSafeString" }, "vlanValue": { "$ref": "#/components/schemas/VlanValue" } }, "description": "A grouping which represents classification on an 802.1Q VLAN tag." }, "VlanClassificationOuterTag": { "title": "VlanClassificationOuterTag", "type": "object", "properties": { "vlanClassification": { "$ref": "#/components/schemas/VlanClassification1" } }, "description": "Classifies traffic using the outermost VLAN tag." }, "VlanClassificationSecondTag": { "title": "VlanClassificationSecondTag", "type": "object", "properties": { "vlanClassification": { "$ref": "#/components/schemas/VlanClassification1" } }, "description": "Classifies traffic using the second outermost VLAN tag." }, "VlanOperations": { "title": "VlanOperations", "type": "object", "properties": { "popTags": { "type": "integer", "description": "The number of VLAN tags to pop (or swap if used in conjunction with push-tags)", "format": "int32" }, "pushTags": { "$ref": "#/components/schemas/PushTags2" } }, "description": "A grouping which represents VLAN operations." }, "VlanWrite": { "title": "VlanWrite", "type": "object", "properties": { "tagType": { "$ref": "#/components/schemas/UrlSafeString" }, "vlanValue": { "$ref": "#/components/schemas/VlanValue" } }, "description": "A grouping which represents push/pop operations of an 802.1Q VLAN tag." }, "Vlanid": { "title": "Vlanid", "type": "object", "properties": { "uint16": { "type": "integer", "format": "int32" } }, "description": "The 12-bit VLAN-ID used in the VLAN Tag header." }, "WaitToRevertTime": { "title": "WaitToRevertTime", "type": "object", "properties": { "time": { "$ref": "#/components/schemas/Time" } }, "description": "Wait to revert time" }, "WaitToSwitchTime": { "title": "WaitToSwitchTime", "type": "object", "properties": { "time": { "$ref": "#/components/schemas/Time" } }, "description": "Wait to switch time" }, "WorkflowProfileInfo": { "title": "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": { "$ref": "#/components/schemas/ServiceStep" }, "workflowExecutionTimeout": { "type": "integer", "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.", "format": "int32" }, "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" } }, "description": "Workflow Profile information" }, "WorkflowProfileTemplate": { "title": "WorkflowProfileTemplate", "required": [ "name" ], "type": "object", "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": "#/components/schemas/WorkflowProfileInfo" }, "description": "" } }, "description": "workflow profile template" }, "AccessType": { "title": "AccessType", "enum": [ "point_to_point", "multi_access" ], "type": "string", "description": "Link access type, which can be point-to-point or multi-access." }, "AccessType1": { "title": "AccessType1", "enum": [ "point_to_point", "multi_access" ], "type": "string", "description": "Link access type, which can be point-to-point ormulti-access" }, "ActionType": { "title": "ActionType", "enum": [ "OUT_PORT", "EXPERIMENTER", "SET_FIELD" ], "type": "string", "description": "Type of the action" }, "ActualEndState": { "title": "ActualEndState", "enum": [ "Saved", "Deployed" ], "type": "string", "description": "Reflects the actual end state for this object, generally Saved, Deployed, etc. This is a read-only attribute." }, "ActualEndState1": { "title": "ActualEndState1", "enum": [ "Saved", "Deployed" ], "type": "string", "description": "The current end state of this endpoint (whether it is Saved, Deployed, etc)" }, "AdministrativeFailureErrorCode": { "title": "AdministrativeFailureErrorCode", "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" ], "type": "string", "description": "The error code when administrative operation is failed" }, "AdministrativeState": { "title": "AdministrativeState", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "Path administrative state" }, "AdministrativeStatus": { "title": "AdministrativeStatus", "enum": [ "DISABLED", "TX_ONLY", "TX_AND_RX", "RX_ONLY" ], "type": "string", "description": "The LLDP administrative status for the port" }, "AdminState": { "title": "AdminState", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "The current administrative state of the entity" }, "AdminState9": { "title": "AdminState9", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "The administrative state required for the service." }, "AdminState19": { "title": "AdminState19", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "The administrative state required for the service" }, "AdminState36": { "title": "AdminState36", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "The current administrative state of this DS0 channel group" }, "AdminStatus": { "title": "AdminStatus", "enum": [ "testing", "up", "preparing_maintenance", "down", "maintenance" ], "type": "string", "description": "The administrative state of the link." }, "AdminStatus1": { "title": "AdminStatus1", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "The administrative state of the link" }, "AssociatedTunnelType": { "title": "AssociatedTunnelType", "enum": [ "sr_pcc_initiated", "sr_isis", "sr_te_strict", "pcc_initiated", "sr_te_loose", "rsvp_strict", "ldp", "rsvp_loose", "bgp", "sr_ospf", "gre" ], "type": "string", "description": "Tunnel type associated with the termination IP address." }, "Auditstate": { "title": "Auditstate", "enum": [ "SUCCESS", "NOT_DONE", "FAILURE" ], "type": "string", "description": "The audit state of the flow" }, "Autobind": { "title": "Autobind", "enum": [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ], "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" }, "Autobind3": { "title": "Autobind3", "enum": [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ], "type": "string", "description": "The type of autobind to be used for the service" }, "AutoBindType": { "title": "AutoBindType", "enum": [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ], "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" }, "AutoBindType1": { "title": "AutoBindType1", "enum": [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ], "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" }, "AutoBindType2": { "title": "AutoBindType2", "enum": [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ], "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." }, "AutoBindType3": { "title": "AutoBindType3", "enum": [ "sr_isis", "rsvp_te", "sr_te", "ldp", "bgp", "none", "gre", "sr_ospf", "any" ], "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" }, "BandwidthStrategy": { "title": "BandwidthStrategy", "enum": [ "TELEMETRY", "STANDARD" ], "type": "string", "description": "The strategy to use for LSP bandwidth in the path computation" }, "Bidirection": { "title": "Bidirection", "enum": [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ], "type": "string", "description": "The Bidirectional Mode to be used in path computation" }, "Bidirectional": { "title": "Bidirectional", "enum": [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ], "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" }, "Bidirectional1": { "title": "Bidirectional1", "enum": [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ], "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" }, "Bidirectional3": { "title": "Bidirectional3", "enum": [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ], "type": "string", "description": "Specifies whether a return path is required, and if so what type of return path should be determined" }, "ComputationState": { "title": "ComputationState", "enum": [ "PATH_NOT_FOUND", "PATH_ERROR", "PATH_FOUND", "UNKNOWN", "PATH_NOT_COMPUTED" ], "type": "string", "description": "Path computation state" }, "ConfigurationType": { "title": "ConfigurationType", "enum": [ "NEAREST_NON_TPMR", "NEAREST_CUSTOMER", "NEAREST_BRIDGE" ], "type": "string", "description": "Whether this configuration is for Nearest Bridge, Nearest Customer, or Nearest Non TPMR" }, "Connectivity": { "title": "Connectivity", "enum": [ "VXLAN_STITCHED", "MPLS_E2E" ], "type": "string", "description": "Specifies the technology method in which the connectivity should be provided" }, "ConnectivityDirection": { "title": "ConnectivityDirection", "enum": [ "UNDEFINED_OR_UNKNOWN", "BIDIRECTIONAL", "UNIDIRECTIONAL" ], "type": "string", "description": "Direction" }, "Context": { "title": "Context", "enum": [ "NFM_T", "NFM_P", "NODE", "MDM", "NSP" ], "type": "string", "description": "The entity type that is managing this external-id" }, "ControlRerouteStrategy": { "title": "ControlRerouteStrategy", "enum": [ "STRICT", "LOOSE", "STANDARD" ], "type": "string", "description": "The strategy to use when recomputing the path" }, "CreationType": { "title": "CreationType", "enum": [ "PROVISIONED", "REQUESTED", "UNKNOWN", "INITIATED", "DISCOVERED" ], "type": "string", "description": "Path creation origin" }, "Data": { "title": "Data", "enum": [ "READY", "INIT" ], "type": "string" }, "Datum": { "title": "Datum", "enum": [ "OPERATOR", "ADMIN", "USER" ], "type": "string" }, "Disjoint": { "title": "Disjoint", "enum": [ "NO", "NODE_STRICT_AND_SRLG", "NODE_STRICT", "LINK_LOOSE", "LINK_STRICT_AND_SRLG", "NODE_LOOSE", "SRLG", "LINK_STRICT" ], "type": "string", "description": "The Disjoint Mode to be used in path computation" }, "DiversityPolicy": { "title": "DiversityPolicy", "enum": [ "NODE", "LINK", "SRLG", "SNG", "SRNG" ], "type": "string", "description": "Diversity policy" }, "EncapType": { "title": "EncapType", "enum": [ "Null", "Unknown", "Dot1Q", "QinQ" ], "type": "string", "description": "The encapsulation type of the ethernet port" }, "EncapType4": { "title": "EncapType4", "enum": [ "PPP_AUTO", "WAN_MIRROR", "BCP_NULL", "FRAME_RELAY", "IPCP", "BCP_DOT1Q", "ATM", "CEM", "UNKNOWN", "CISCO_HDLC" ], "type": "string" }, "ErrorType": { "title": "ErrorType", "enum": [ "protocol", "application", "rpc_notification", "transport" ], "type": "string", "description": "The protocol layer where the error occurred" }, "ExperimenterActionType": { "title": "ExperimenterActionType", "enum": [ "REDIRECT_TO_NEXTHOP", "REDIRECT_TO_SVCT" ], "type": "string", "description": "Type of the experimenter action. Applicable only for experimenter actions" }, "ExplicitRouteStrategy": { "title": "ExplicitRouteStrategy", "enum": [ "ECMP", "STANDARD_BSID_PREFERRED", "LOOSE_HOP", "COMPRESSED", "STANDARD", "LOOSE_HOP_ANYCAST_PREFERRED", "LOOSE_HOP_BSID_PREFERRED" ], "type": "string", "description": "The strategy to use when computing the explicit route objects" }, "ExplicitRouteStrategyEcmpPreference": { "title": "ExplicitRouteStrategyEcmpPreference", "enum": [ "ADJACENCY_SID", "NODE_SID" ], "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" }, "HopType": { "title": "HopType", "enum": [ "STRICT", "LOOSE", "UNKNOWN" ], "type": "string", "description": "Path hop type denoting hop restriction" }, "HopType1": { "title": "HopType1", "enum": [ "STRICT", "LOOSE", "UNKNOWN" ], "type": "string", "description": "The hop type, only strict or loose is supported" }, "InclusiveExclusive": { "title": "InclusiveExclusive", "enum": [ "inclusive", "exclusive" ], "type": "string", "description": "Whether the list item is inclusive or exclusive." }, "Indication": { "title": "Indication", "enum": [ "standard", "arbitrary" ], "type": "string", "description": "Indication whether the interface supports Standard or Arbitrary SONET/SDH" }, "InformationSource": { "title": "InformationSource", "enum": [ "other", "locally_configured", "ospfv2", "ospfv3", "isis", "system_processed", "unknown" ], "type": "string", "description": "Indicates the source of the information." }, "InstructionType": { "title": "InstructionType", "enum": [ "CLEAR_ACTIONS", "APPLY_ACTIONS", "WRITE_ACTIONS" ], "type": "string", "description": "Type of the instruction" }, "IsisLevel": { "title": "IsisLevel", "enum": [ "L1", "L2", "L1L2" ], "type": "string", "description": "The level attribute for ISIS" }, "LatencyUploadPolicy": { "title": "LatencyUploadPolicy", "enum": [ "auto", "manual" ], "type": "string", "description": "Policy to indicate how the latency changes in optical network need to be uploaded to IP Controller app" }, "Lifecycle1": { "title": "Lifecycle1", "enum": [ "PENDING_DELETE", "NO_ACTION", "DEPLOYED", "PENDING_SYNC", "DELETED", "PENDING_CREATE", "PENDING_MODIFICATION" ], "type": "string", "description": "The lifecycle of the flow" }, "LifecycleState": { "title": "LifecycleState", "enum": [ "Delete", "PartiallyDeployed", "Deploying", "Undeployed", "Routing", "Planned", "Deployed", "DeploymentFailed", "WaitingForDeployment", "RoutedAndSaved", "RoutingFailed", "Saved", "Undeploy" ], "type": "string", "description": "Path lifecycle state" }, "LinkProtectionType": { "title": "LinkProtectionType", "enum": [ "enhanced", "shared", "extra_traffic", "_1_plus_1", "unprotected", "_1_for_1" ], "type": "string", "description": "Link Protection Type desired for this link." }, "MaintenanceAffected": { "title": "MaintenanceAffected", "enum": [ "MAINTENANCE_CLEAR", "HOPS_IN_MAINTENANCE", "NONE" ], "type": "string", "description": "This flag indicates if any of the LSP path hops are affected by maintenance mode" }, "MaintenanceMode": { "title": "MaintenanceMode", "enum": [ "AUTOMATIC", "MANUAL" ], "type": "string", "description": "The System IP MPLS Configuration" }, "MethodType": { "title": "MethodType", "enum": [ "PATH_SEARCH", "RING_COMPLETION" ], "type": "string", "description": "Type of Path Search" }, "Modulation": { "title": "Modulation", "enum": [ "SYSTEM_ASSIGNED", "MOD_SP_QPSK", "MOD_QPSK", "MOD_8QAM", "MOD_16QAM", "MOD_BPSK" ], "type": "string", "description": "Specifies the modulation scheme for the optical signal" }, "NeDeploymentState": { "title": "NeDeploymentState", "enum": [ "DEPLOYED", "NA", "FAILED", "UNKNOWN", "PENDING" ], "type": "string", "description": "The current deployment state of the entity" }, "Objective": { "title": "Objective", "enum": [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ], "type": "string", "description": "Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services" }, "Objective3": { "title": "Objective3", "enum": [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ], "type": "string", "description": "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency and Hops are the supported values." }, "Objective19": { "title": "Objective19", "enum": [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ], "type": "string", "description": "Path metric objective" }, "Objective23": { "title": "Objective23", "enum": [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ], "type": "string", "description": "The Metric Objective to be used in path computation" }, "OpenflowVersion": { "title": "OpenflowVersion", "enum": [ "V140", "V150", "V10", "V200", "V131", "V130" ], "type": "string", "description": "The openflow protocol version for this switch" }, "OperationalState": { "title": "OperationalState", "enum": [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ], "type": "string", "description": "The current operational state of the entity" }, "OperationalState7": { "title": "OperationalState7", "enum": [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ], "type": "string", "description": "Path operational state" }, "OperationalState10": { "title": "OperationalState10", "enum": [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ], "type": "string", "description": "The current operational state of the DS0 channel group" }, "OperStatus": { "title": "OperStatus", "enum": [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ], "type": "string", "description": "The current operational state of the link" }, "OperStatus1": { "title": "OperStatus1", "enum": [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ], "type": "string", "description": "The current operational state of the node" }, "OperStatus2": { "title": "OperStatus2", "enum": [ "testing", "up", "preparing_maintenance", "down", "maintenance", "unknown" ], "type": "string", "description": "The current operational state of the link." }, "OperStatus3": { "title": "OperStatus3", "enum": [ "testing", "up", "preparing_maintenance", "down", "maintenance", "unknown" ], "type": "string", "description": "The current operational state of the node." }, "PathErrorCode": { "title": "PathErrorCode", "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" ], "type": "string", "description": "The error code of path status" }, "PathType": { "title": "PathType", "enum": [ "SRTE", "UNKNOWN", "RSVP" ], "type": "string", "description": "Path type denoting signaling type" }, "Phase": { "title": "Phase", "enum": [ "Creation", "Deployment", "Activation", "Planning" ], "type": "string", "description": "The phase of the life cycle object" }, "PhaseEncoding": { "title": "PhaseEncoding", "enum": [ "system_assigned", "absolute", "differential" ], "type": "string", "description": "Specifies the encoding type of the optical signal" }, "pluginName": { "title": "pluginName", "enum": [ "VSR_NRC" ], "type": "string" }, "PolicyType": { "title": "PolicyType", "enum": [ "RD_ONLY", "RD_AND_RT", "RT_EXTRANET_ONLY", "RT_ONLY" ], "type": "string", "description": "Specifies L3VPN RT/RD policy type. Type can be RD and RT, RD only, or RT only." }, "PortAdminState": { "title": "PortAdminState", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "The administrative state of port used by endpoint" }, "PortMode": { "title": "PortMode", "enum": [ "NETWORK", "UNDEFINED", "ACCESS", "HYBRID" ], "type": "string", "description": "the mode of the Port" }, "PortMode1": { "title": "PortMode1", "enum": [ "NETWORK", "UNDEFINED", "ACCESS", "HYBRID" ], "type": "string", "description": "The port-mode type of the ethernet port" }, "PortOperationalState": { "title": "PortOperationalState", "enum": [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ], "type": "string", "description": "The operational state of port used by endpoint" }, "ProfileGroupOverrideState": { "title": "ProfileGroupOverrideState", "enum": [ "ACTIVE_TRANSIT", "ACTIVE", "FAILED", "NOT_CONFIGURED", "NOT_ATTEMPTED" ], "type": "string", "description": "Profile group override state" }, "ProfileType": { "title": "ProfileType", "enum": [ "ELAN", "CLINE", "ELINE", "IES", "L3VPN" ], "type": "string", "description": "The service type associated with the Mediation profile" }, "ProtectionState": { "title": "ProtectionState", "enum": [ "ACTIVE", "INACTIVE", "UNKNOWN" ], "type": "string", "description": "Path protection/redundancy activity state" }, "ProtectionStatus": { "title": "ProtectionStatus", "enum": [ "reversion_failed", "normal", "reversion_started", "recovery_unavailable", "recovery_admin", "recovery_succeeded", "recovery_failed", "recovery_started", "wait_to_restore" ], "type": "string", "description": "Protection status." }, "ProtectionType": { "title": "ProtectionType", "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" ], "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." }, "ProtectionType1": { "title": "ProtectionType1", "enum": [ "SECONDARY", "STANDBY", "PRIMARY", "UNKNOWN" ], "type": "string", "description": "Path protection/redundancy type" }, "ProtectionType2": { "title": "ProtectionType2", "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" ], "type": "string", "description": "Protection type" }, "ProtectionType3": { "title": "ProtectionType3", "enum": [ "working", "protection" ], "type": "string", "description": "Specifies the protection type of the port" }, "ProtectionType5": { "title": "ProtectionType5", "enum": [ "working", "protection" ], "type": "string", "description": "Specifies the protection type of the port. This only applies to client optical ports." }, "ProtectionType6": { "title": "ProtectionType6", "enum": [ "SECONDARY", "STANDBY", "PRIMARY", "UNKNOWN" ], "type": "string", "description": "Specifies path protection type. Protection path is pre-signalled and available for immediate recovery after a primary path failure." }, "ProtectionType7": { "title": "ProtectionType7", "enum": [ "SECONDARY", "STANDBY", "PRIMARY", "UNKNOWN" ], "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" }, "Protocol": { "title": "Protocol", "enum": [ "OSPFv2", "ISIS", "BGP", "ANY", "STATIC" ], "type": "string", "description": "The protocol that this area was defined in" }, "Protocol1": { "title": "Protocol1", "enum": [ "OSPFv2", "ISIS", "BGP", "ANY", "STATIC" ], "type": "string", "description": "The protocol which IGP router is using" }, "provider": { "title": "provider", "enum": [ "KEYSTONE", "SSO" ], "type": "string" }, "QueueType": { "title": "QueueType", "enum": [ "Policer", "Queue" ], "type": "string", "description": "The type of the queue override. Default is Queue." }, "RateType": { "title": "RateType", "enum": [ "kbps", "percent" ], "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" }, "RateType1": { "title": "RateType1", "enum": [ "kbps", "percent" ], "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" }, "ReferenceChangePolicy": { "title": "ReferenceChangePolicy", "enum": [ "no_action", "cascade", "not_allowed" ], "type": "string", "description": "This attribute specifies the action taken to a configuration node that has a reference to this template." }, "RemoteChassisIdType": { "title": "RemoteChassisIdType", "enum": [ "INTERFACE_ALIAS", "INTERFACE_NAME", "SUBNET", "NETWORK_ADDRESS", "PORT_COMPONENT", "LOCAL", "CHASSIS_COMPONENT", "MAC_ADDRESS" ], "type": "string", "description": "The remote chassis id type" }, "RemotePeerType": { "title": "RemotePeerType", "enum": [ "NEAREST_NON_TPMR", "NEAREST_CUSTOMER", "NEAREST_BRIDGE" ], "type": "string", "description": "The remote peer type" }, "RemotePortIdType": { "title": "RemotePortIdType", "enum": [ "INTERFACE_ALIAS", "INTERFACE_NAME", "NETWORK_ADDRESS", "PORT_COMPONENT", "LOCAL", "AGENT_CIRCUIT_ID", "MAC_ADDRESS" ], "type": "string", "description": "The remote port id type" }, "RequestedEndState": { "title": "RequestedEndState", "enum": [ "Saved", "Deployed" ], "type": "string", "description": "Specifies the desired end state for this request, generally Saved, Deployed, etc" }, "requestType": { "title": "requestType", "enum": [ "MOVED", "INCOMING", "OUTGOING" ], "type": "string" }, "resourceType": { "title": "resourceType", "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" ], "type": "string" }, "Restoration": { "title": "Restoration", "enum": [ "SBR", "GR", "None" ], "type": "string", "description": "Specifies the recovery technique of a path after failure." }, "RestorationCoordinateType": { "title": "RestorationCoordinateType", "enum": [ "HOLD_OFF_TIME", "NO_COORDINATE", "WAIT_FOR_NOTIFICATION" ], "type": "string", "description": "The coordination mechanism between multi-layers." }, "RestorationPolicy": { "title": "RestorationPolicy", "enum": [ "NA", "PER_DOMAIN_RESTORATION", "END_TO_END_RESTORATION" ], "type": "string", "description": "Restoration policy" }, "RestorationStatus": { "title": "RestorationStatus", "enum": [ "reversion_failed", "normal", "reversion_started", "recovery_unavailable", "recovery_admin", "recovery_succeeded", "recovery_failed", "recovery_started", "wait_to_restore" ], "type": "string", "description": "Restoration status." }, "ReversionMode": { "title": "ReversionMode", "enum": [ "softauto", "auto", "manual" ], "type": "string", "description": "Specifies how the path switches from the recovery to the the working path previously under failure condition." }, "ReversionMode2": { "title": "ReversionMode2", "enum": [ "NON_REVERTIVE", "REVERTIVE" ], "type": "string", "description": "Indcates whether the protection scheme is revertive or non-revertive." }, "ReversionMode4": { "title": "ReversionMode4", "enum": [ "revertive", "non_revertive" ], "type": "string", "description": "Reversion mode" }, "Role": { "title": "Role", "enum": [ "OPERATOR", "ADMIN", "USER" ], "type": "string" }, "Role1": { "title": "Role1", "enum": [ "UNI", "NNI" ], "type": "string", "description": "Whether the port is a UNI or NNI port" }, "roleType": { "title": "roleType", "enum": [ "OPERATOR", "ADMIN", "USER" ], "type": "string" }, "RouteDirection": { "title": "RouteDirection", "enum": [ "UNDEFINED_OR_UNKNOWN", "BIDIRECTIONAL", "UNIDIRECTIONAL" ], "type": "string", "description": "Route direction" }, "RouteObjectiveFunction": { "title": "RouteObjectiveFunction", "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" ], "type": "string", "description": "Route objective function" }, "RouteType": { "title": "RouteType", "enum": [ "black_hole", "next_hop" ], "type": "string", "description": "Specifies the type of static route" }, "SchedulerType": { "title": "SchedulerType", "enum": [ "Scheduler", "Arbiter" ], "type": "string", "description": "The type of the scheduler override. Default is Scheduler." }, "SegmentRouteType": { "title": "SegmentRouteType", "enum": [ "NODEIPV4", "NODEIPV6", "ADJIPV6", "ADJUNUMIPV4", "ADJIPV4" ], "type": "string", "description": "Segment route type" }, "ServicePlaneType": { "title": "ServicePlaneType", "enum": [ "controlPlane", "mixedPlane", "mrn", "managementPlane" ], "type": "string", "description": "Specifies whether the service is Control Plane or Management Plane." }, "ServiceStep": { "title": "ServiceStep", "enum": [ "preupdate", "postupdate_success", "postupdate_failure", "postcreate_success", "postcreate_failure", "predelete", "postdelete_failure", "precreate", "postdelete_success" ], "type": "string", "description": "The service action step for which Workflow profile has to be applied." }, "ServiceType1": { "title": "ServiceType1", "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" ], "type": "string", "description": "The type of the service" }, "ServiceType3": { "title": "ServiceType3", "enum": [ "ROOTED_MULTIPOINT_CONNECTIVITY", "POINT_TO_MULTIPOINT_CONNECTIVITY", "MULTIPOINT_CONNECTIVITY", "POINT_TO_POINT_CONNECTIVITY" ], "type": "string", "description": "Type of service" }, "serviceType5": { "title": "serviceType5", "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" ], "type": "string" }, "SidHopType": { "title": "SidHopType", "enum": [ "ANYCAST_NODE", "NODE", "ADJSET", "ADJSID" ], "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." }, "SidProtectionStrategy": { "title": "SidProtectionStrategy", "enum": [ "UNPROTECTED_PREFERRED", "UNPROTECTED_ONLY", "STANDARD", "PROTECTED_ONLY" ], "type": "string", "description": "The strategy to use when computing a path in regards to segment ID protection" }, "SignalMode": { "title": "SignalMode", "enum": [ "SIGNAL_MODE_CAS", "SIGNAL_MODE_NONE" ], "type": "string" }, "Source1": { "title": "Source1", "enum": [ "mdm", "nfmp" ], "type": "string", "description": "The source of the traffic collection data. Options are: mdm, nfmp." }, "SrlgUploadPolicy": { "title": "SrlgUploadPolicy", "enum": [ "auto", "manual" ], "type": "string", "description": "Policy to indicate how the SRLG changes in optical network need to be uploaded to IP Controller app" }, "State2": { "title": "State2", "enum": [ "Delete", "PartiallyDeployed", "Deploying", "Undeployed", "Routing", "Planned", "Deployed", "DeploymentFailed", "WaitingForDeployment", "RoutedAndSaved", "RoutingFailed", "Saved", "Undeploy" ], "type": "string", "description": "The state of the life cycle object" }, "Status": { "title": "Status", "enum": [ "DOWN", "ACTIVE", "UNKNOWN" ], "type": "string", "description": "Status of this switch" }, "TargetType": { "title": "TargetType", "enum": [ "import_export", "exp", "imp" ], "type": "string", "description": "The type of route target that is defined for the service. Can be either import or export" }, "TimeUnit": { "title": "TimeUnit", "enum": [ "milliseconds", "seconds", "hours", "minutes" ], "type": "string", "description": "Unit" }, "TunnelType": { "title": "TunnelType", "enum": [ "sr_pcc_initiated", "sr_isis", "sr_te_strict", "pcc_initiated", "sr_te_loose", "rsvp_strict", "ldp", "rsvp_loose", "bgp", "sr_ospf", "gre" ], "type": "string", "description": "The type of the tunnel" }, "UnderlyingTransport": { "title": "UnderlyingTransport", "enum": [ "ODU", "VXLAN", "ERP", "L2TPV3", "IPV4", "UNKNOWN", "GRE", "VLAN", "ANY", "MPLS" ], "type": "string", "description": "The transport of the tunnel" }, "UnidirectionalAvailableBandwidth": { "title": "UnidirectionalAvailableBandwidth", "enum": [ "normal", "abnormal", "unknown" ], "type": "string", "description": "Available bandwidth normality." }, "UnidirectionalDelay": { "title": "UnidirectionalDelay", "enum": [ "normal", "abnormal", "unknown" ], "type": "string", "description": "Delay normality." }, "UnidirectionalDelayVariation": { "title": "UnidirectionalDelayVariation", "enum": [ "normal", "abnormal", "unknown" ], "type": "string", "description": "Delay variation normality." }, "UnidirectionalMaxDelay": { "title": "UnidirectionalMaxDelay", "enum": [ "normal", "abnormal", "unknown" ], "type": "string", "description": "Maximum delay or latency normality." }, "UnidirectionalMinDelay": { "title": "UnidirectionalMinDelay", "enum": [ "normal", "abnormal", "unknown" ], "type": "string", "description": "Minimum delay or latency normality." }, "UnidirectionalPacketLoss": { "title": "UnidirectionalPacketLoss", "enum": [ "normal", "abnormal", "unknown" ], "type": "string", "description": "Packet loss normality." }, "UnidirectionalResidualBandwidth": { "title": "UnidirectionalResidualBandwidth", "enum": [ "normal", "abnormal", "unknown" ], "type": "string", "description": "Residual bandwidth normality." }, "UnidirectionalUtilizedBandwidth": { "title": "UnidirectionalUtilizedBandwidth", "enum": [ "normal", "abnormal", "unknown" ], "type": "string", "description": "Bandwidth utilization normality." }, "Unit": { "title": "Unit", "enum": [ "MB", "TBPS", "KB", "GHz", "KBPS", "GB", "MBPS", "TB", "MHz", "GBPS" ], "type": "string", "description": "none" }, "VcType": { "title": "VcType", "enum": [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ], "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)" }, "VcType2": { "title": "VcType2", "enum": [ "SATOP_E1", "SATOP_T1", "SATOP_E3", "ETHERNET", "CESOPSN", "SATOP_T3", "CESOPSN_CAS", "ETHERNET_TAGGED_MODE" ], "type": "string", "description": "The type of the pseudowire. Must match with far-end." }, "VendorType": { "title": "VendorType", "enum": [ "OTHER", "NOKIA", "ALCATEL" ], "type": "string", "description": "Vendor of this switch" }, "Waveshape": { "title": "Waveshape", "enum": [ "single", "_super", "system_assigned", "alien" ], "type": "string", "description": "Specifies the shape of the optical signal to be used" }, "Affinities": { "title": "Affinities", "type": "object", "properties": { "excludeAny": { "$ref": "#/components/schemas/ExcludeAny" }, "includeAll": { "$ref": "#/components/schemas/IncludeAll" }, "includeAny": { "$ref": "#/components/schemas/IncludeAny" } }, "description": "Affinity constraints on the computed dynamic path" }, "ApplicationSpecificData": { "title": "ApplicationSpecificData", "type": "object", "properties": { "administrativeGroup": { "$ref": "#/components/schemas/AdministrativeGroup" }, "anomalousMinMaxUnidirectionalLinkDelay": { "type": "boolean", "description": "Measured value of this parameter exceeds its configured maximum threshold" }, "anomalousUnidirectionalLinkDelay": { "type": "boolean", "description": "Measured value of this parameter exceeds its configured maximum threshold" }, "applicationType": { "$ref": "#/components/schemas/ApplicationType" }, "maxUnidirectionalLinkDelay": { "type": "integer", "description": "Max delay value between two directly connected neighbors in microseconds", "format": "int32" }, "minUnidirectionalLinkDelay": { "type": "integer", "description": "Min delay value between two directly connected neighbors in microseconds", "format": "int32" }, "srlgValue": { "type": "array", "items": { "$ref": "#/components/schemas/Srlg" }, "description": "A list of SRLG values" }, "teMetric": { "type": "integer", "description": "Traffic Engineering Metric", "format": "int64" }, "unidirectionalLinkDelay": { "type": "integer", "description": "The average link delay value between two directly connected neighbors in microseconds", "format": "int32" } }, "description": "Application specific attributes" }, "AssocGroupConfig": { "title": "AssocGroupConfig", "type": "object", "properties": { "defaultSourceIpAddress": { "$ref": "#/components/schemas/DefaultSourceIpAddress" } }, "description": "Grouping of all association group related parameters for IP/MPLS optimization." }, "AssociationGroup": { "title": "AssociationGroup", "type": "object", "properties": { "associationGroupDiversity": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationGroupDiversityObject" }, "description": "" }, "associationGroupPolicy": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationGroupPolicyObject" }, "description": "" } }, "description": "Association groups" }, "AssociationGroupDiversity": { "title": "AssociationGroupDiversity", "required": [ "id", "type" ], "type": "object", "properties": { "associationKey": { "type": "string", "description": "Association key used to identify a specific association in the list. It will be generated automatically and is unique based on the combination of (type, id, source)" }, "disjointType": { "$ref": "#/components/schemas/DisjointType" }, "id": { "type": "integer", "description": "Association identifier. The association ID is used to help form the association group with the other attributes. If the association type is POLICY, then the association ID will be used to perform a lookup against a Path Profile definition. Currently an ID is limited to one per association type. If multiple association groups exist, the association with the lowest ID will be used", "format": "int32" }, "source": { "$ref": "#/components/schemas/Source3" }, "type": { "$ref": "#/components/schemas/Type" } } }, "AssociationGroupDiversityObject": { "title": "AssociationGroupDiversityObject", "required": [ "id", "type" ], "type": "object", "properties": { "associationKey": { "type": "string", "description": "Association key used to identify a specific association in the list. It will be generated automatically and is unique based on the combination of (type, id, source)" }, "disjointType": { "$ref": "#/components/schemas/DisjointType" }, "id": { "type": "integer", "description": "Association identifier. The association ID is used to help form the association group with the other attributes. If the association type is POLICY, then the association ID will be used to perform a lookup against a Path Profile definition. Currently an ID is limited to one per association type. If multiple association groups exist, the association with the lowest ID will be used", "format": "int32" }, "source": { "$ref": "#/components/schemas/Source3" }, "type": { "$ref": "#/components/schemas/Type" } }, "description": "Association group DISJOINT" }, "AssociationGroupPolicy": { "title": "AssociationGroupPolicy", "required": [ "id", "type" ], "type": "object", "properties": { "associationKey": { "type": "string", "description": "Association key used to identify a specific association in the list. It will be generated automatically and is unique based on the combination of (type, id, source)" }, "id": { "type": "integer", "description": "Association identifier. The association ID is used to help form the association group with the other attributes. If the association type is POLICY, then the association ID will be used to perform a lookup against a Path Profile definition. Currently an ID is limited to one per association type. If multiple association groups exist, the association with the lowest ID will be used", "format": "int32" }, "source": { "$ref": "#/components/schemas/Source3" }, "type": { "$ref": "#/components/schemas/Type" } } }, "AssociationGroupPolicyObject": { "title": "AssociationGroupPolicyObject", "required": [ "id", "type" ], "type": "object", "properties": { "associationKey": { "type": "string", "description": "Association key used to identify a specific association in the list. It will be generated automatically and is unique based on the combination of (type, id, source)" }, "id": { "type": "integer", "description": "Association identifier. The association ID is used to help form the association group with the other attributes. If the association type is POLICY, then the association ID will be used to perform a lookup against a Path Profile definition. Currently an ID is limited to one per association type. If multiple association groups exist, the association with the lowest ID will be used", "format": "int32" }, "source": { "$ref": "#/components/schemas/Source3" }, "type": { "$ref": "#/components/schemas/Type" } }, "description": "Association group POLICY" }, "AutobindTunnel": { "title": "AutobindTunnel", "type": "object", "properties": { "resolution": { "$ref": "#/components/schemas/Resolution" }, "resolutionFilter": { "$ref": "#/components/schemas/ResolutionFilter" } } }, "AvoidedData": { "title": "AvoidedData", "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/EntityType" }, "name": { "type": "string", "description": "Avoided entity name" }, "reason": { "type": "string", "description": "Reason is a fixed string identifier for why this resource is avoided, such as Maintenance, Congestion behaviours" }, "uuid": { "type": "string", "description": "UUID: An identifier for an entity avoided in the path. This UUID may correspond to entities such as Links, Nodes or logical grouping entities such as Adjacency Sets, Binding SID." }, "weightUsed": { "type": "number", "description": "Weight used for the avoided entity" } }, "description": "Avoided data which was attempted to be avoided but not excluded from the path search" }, "BindingSid_properties": { "title": "BindingSid_properties", "type": "object", "properties": { "dataplane": { "$ref": "#/components/schemas/Dataplane" }, "value": { "$ref": "#/components/schemas/Value" } }, "description": "Binding SID properties grouping" }, "Bounds": { "title": "Bounds", "type": "object", "properties": { "igpMetricBound": { "type": "integer", "description": "Path is invalid if its IGP metric exceeds this value", "format": "int64" }, "latencyMetricBound": { "type": "integer", "description": "Path is invalid if its latency exceeds this value", "format": "int64" }, "maxHops": { "type": "integer", "description": "Path maximum hops constraint. 0 and 255 means no limit.", "format": "int64" }, "segmentBound": { "type": "integer", "description": "Path is invalid if it has more segments than this value", "format": "int64" }, "teMetricBound": { "type": "integer", "description": "Path is invalid if its TE metric exceeds this value", "format": "int64" } }, "description": "Upper-bound constraints on the computed dynamic path" }, "Bsid": { "title": "Bsid", "type": "object", "properties": { "bindingSid_properties": { "$ref": "#/components/schemas/BindingSidProperties1" } } }, "BsidGenerationConfig": { "title": "BsidGenerationConfig", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Toggle whether NRCP should support BSID generation." }, "tunnelTypePreference": { "$ref": "#/components/schemas/TunnelTypePreference" } } }, "CandidatePath": { "title": "CandidatePath", "required": [ "preference" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "Candidate Path active status, true for active, false for inactive. Each SR Policy only has one active Candidate Path" }, "adminState": { "$ref": "#/components/schemas/AdminState9" }, "candidatePathParamsConfig": { "$ref": "#/components/schemas/CandidatePathParamsConfig" }, "candidatePathParamsState": { "$ref": "#/components/schemas/CandidatePathParamsState" }, "candidatePathType": { "$ref": "#/components/schemas/CandidatePathType2" }, "description": { "type": "string", "description": "Candidate Path description" }, "distinguisher": { "type": "integer", "description": "Distinguisher in the context of BGP when combined with endpoint and color must be unique", "format": "int64" }, "forwardingPaths": { "$ref": "#/components/schemas/ForwardingPaths3" }, "id": { "type": "string", "description": "An identifier to uniquely identify a Candidate Path" }, "inSync": { "type": "boolean", "description": "in-sync is turn when Candidate Path is in sync with the network" }, "lifecycleState": { "$ref": "#/components/schemas/LifecycleState" }, "name": { "type": "string", "description": "Candidate Path name" }, "operationalState": { "$ref": "#/components/schemas/OperationalState8" }, "originator": { "type": "string", "description": "NOTE:NRC-P Server will ignore user provided value and fill in its own value. Identifier (concatenation of ASN and node-address) of the node that signalled/instantiated the Candidate Path on headend" }, "parentId": { "type": "string", "description": "An identifier to uniquely identify (SR Policy) the parent of the Candidate Path" }, "pathErrorCode": { "$ref": "#/components/schemas/PathErrorCode" }, "preference": { "type": "integer", "description": "The preference of the candidate path is used to select the best candidate path for an SR Policy", "format": "int64" }, "protocolOrigin": { "$ref": "#/components/schemas/ProtocolOrigin" } } }, "CandidatePathConfigType": { "title": "CandidatePathConfigType", "type": "object", "properties": { "dynamic": { "$ref": "#/components/schemas/Dynamic2" }, "explicit": { "$ref": "#/components/schemas/Explicit2" } }, "description": "Candidate Path config type grouping" }, "CandidatePathParamsConfig": { "title": "CandidatePathParamsConfig", "type": "object", "properties": { "candidatePathProperties": { "$ref": "#/components/schemas/CandidatePathProperties1" } } }, "CandidatePathParamsState": { "title": "CandidatePathParamsState", "type": "object", "properties": { "candidatePathProperties": { "$ref": "#/components/schemas/CandidatePathProperties1" } } }, "CandidatePathProperties": { "title": "CandidatePathProperties", "type": "object", "properties": { "bandwidth": { "type": "integer", "description": "Bandwidth capacity. Unit kbps. For a candidate path with multiple segment-lists, the bandiwdth value is applied to each segment list relative to the weight value associated to the segment-list", "format": "int64" }, "bsid": { "$ref": "#/components/schemas/Bsid" } }, "description": "Candidate Path properties grouping" }, "CandidatePathType": { "title": "CandidatePathType", "type": "object", "properties": { "dynamicParamsConfig": { "$ref": "#/components/schemas/DynamicParamsConfig2" }, "dynamicParamsState": { "$ref": "#/components/schemas/DynamicParamsState2" }, "explicitParamsConfig": { "$ref": "#/components/schemas/ExplicitParamsConfig2" } }, "description": "Candidate Path type grouping" }, "CandidatePaths": { "title": "CandidatePaths", "type": "object", "properties": { "candidatePaths": { "$ref": "#/components/schemas/CandidatePaths1" } }, "description": "SR Policy Candidate Path grouping" }, "CandidatePathsConfig": { "title": "CandidatePathsConfig", "type": "object", "properties": { "candidatePath": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CandidatePathsConfigCandidatePath" } } }, "description": "SR Policy Candidate Path(s)" }, "CandidatePathsConfigCandidatePath": { "title": "CandidatePathsConfigCandidatePath", "required": [ "distinguisher", "preference", "protocolOrigin" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "candidatePathConfigType": { "$ref": "#/components/schemas/CandidatePathConfigType1" }, "candidatePathProperties": { "$ref": "#/components/schemas/CandidatePathProperties1" }, "description": { "type": "string", "description": "Candidate Path description" }, "distinguisher": { "type": "integer", "description": "Distinguisher in the context of BGP with combined with endpoint and color must be unique", "format": "int64" }, "name": { "type": "string", "description": "Candidate Path name" }, "originator": { "type": "string", "description": "NOTE:NRC-P Server will ignore user provided value and fill in its own value. Identifier (concatenation of ASN and node-address) of the node that signalled/instantiated the Candidate Path on headend." }, "preference": { "type": "integer", "description": "The preference of the candidate path is used to select the best candidate path for an SR Policy", "format": "int64" }, "protocolOrigin": { "$ref": "#/components/schemas/ProtocolOrigin" } } }, "CandidatePathsMember": { "title": "CandidatePathsMember", "type": "object", "properties": { "candidatePath": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CandidatePath" } } }, "description": "SR Policy Candidate Path(s)" }, "CandidatePathsUpdateRequest": { "title": "CandidatePathsUpdateRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "description": { "type": "string", "description": "Description for Candidate Path" }, "paramsConfig": { "$ref": "#/components/schemas/ParamsConfig1" }, "preference": { "type": "integer", "description": "The preference of the candidate path is used to select the best candidate path for an SR Policy", "format": "int64" } } }, "ConnectionProfile": { "title": "ConnectionProfile", "type": "object", "properties": { "description": { "type": "string", "description": "the description of the connection profile" }, "id": { "type": "string", "description": "The connection profile id" } }, "description": "connection profile information" }, "ConstraintData": { "title": "ConstraintData", "type": "object", "properties": { "constraint": { "type": "string", "description": "Constraint name" }, "newValue": { "type": "object", "description": "New value of the constraint" }, "oldValue": { "type": "object", "description": "Old value of the constraint" } }, "description": "Constraint data" }, "Constraints": { "title": "Constraints", "type": "object", "properties": { "affinities": { "$ref": "#/components/schemas/Affinities1" } }, "description": "Constraints for the dynamic path computation" }, "Consumer": { "title": "Consumer", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for Candidate Path or LSP path" }, "object": { "$ref": "#/components/schemas/Object" } } }, "ConsumerCountResult": { "title": "ConsumerCountResult", "type": "object", "properties": { "candidatePathCount": { "type": "integer", "description": "Number of Candidate Path consumers", "format": "int64" }, "consumer": { "type": "array", "items": { "$ref": "#/components/schemas/Consumer" }, "description": "" }, "pceSrPathCount": { "type": "integer", "description": "Number of LSP Path consumers", "format": "int64" } } }, "DeviceNameMappingConfig": { "title": "DeviceNameMappingConfig", "type": "object", "properties": { "deviceNamePriority": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeviceNamePriority" } }, "externalMapping": { "type": "boolean", "description": "Enable/Disable external ip address and device name mapping service" }, "priorityEnabled": { "type": "boolean", "description": "Enable/Disable apps ip address and device name write priority" } }, "description": "Group of all device and name mapping related parameters for IP/MPLS optimization." }, "DeviceNamePriority": { "title": "DeviceNamePriority", "type": "object", "properties": { "appType": { "$ref": "#/components/schemas/AppType" }, "priority": { "type": "integer", "description": "Priority of the APP, 1 is hightest and 4 is lowest", "format": "int32" } } }, "Dynamic": { "title": "Dynamic", "type": "object", "properties": { "dynamicPathProperties": { "$ref": "#/components/schemas/DynamicPathProperties1" } }, "description": "Candidate Path with dynamic computed segment-lists configuration parameters" }, "DynamicParamsConfig": { "title": "DynamicParamsConfig", "type": "object", "properties": { "dynamicPathProperties": { "$ref": "#/components/schemas/DynamicPathProperties1" } }, "description": "Candidate Path with dynamic computed segment-lists configuration parameters" }, "DynamicParamsState": { "title": "DynamicParamsState", "type": "object", "properties": { "dynamicPathProperties": { "$ref": "#/components/schemas/DynamicPathProperties1" } }, "description": "Candidate Path with dynamic computed segment-lists state parameters" }, "DynamicPathProperties": { "title": "DynamicPathProperties", "type": "object", "properties": { "bounds": { "$ref": "#/components/schemas/Bounds1" }, "constraints": { "$ref": "#/components/schemas/Constraints2" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "pathProfileId": { "type": "integer", "description": "Path profile identifier", "format": "int64" }, "sidDataplaneType": { "$ref": "#/components/schemas/SidDataplaneType" } }, "description": "Dynamic path properties of the Candidate Path" }, "ElineEndpointRequest": { "title": "ElineEndpointRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "connectionProfileId": { "type": "string", "description": "The id of the connection-profile" }, "connectionProfileVlanTag": { "$ref": "#/components/schemas/ConnectionProfileVlanTag" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/EncapType" }, "id": { "type": "string", "description": "The UUID of the port" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "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." }, "localAcName": { "type": "string", "description": "the local attachement circuit name" }, "localEthTag": { "type": "integer", "description": "ethernet tag of the local attachement circuit", "format": "int32" }, "name": { "type": "string", "description": "The name of the endpoint" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portMode": { "$ref": "#/components/schemas/PortMode" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" }, "remoteAcName": { "type": "string", "description": "the remote attachement circuit name" }, "remoteEthTag": { "type": "integer", "description": "ethernet tag of the remote attachement circuit", "format": "int32" }, "siteServiceQosProfile": { "$ref": "#/components/schemas/SiteServiceQosProfile1" } } }, "EvpnIfl": { "title": "EvpnIfl", "type": "object", "properties": { "autobindTunnel": { "$ref": "#/components/schemas/AutobindTunnel" }, "routeDistinguisher": { "type": "string", "description": "Specifies the route distinguisher assigned to the EVPN IFL" }, "routeTargets": { "type": "array", "items": { "$ref": "#/components/schemas/RouteTarget" }, "description": "" } } }, "Explicit": { "title": "Explicit", "type": "object", "properties": { "segmentListsConfigRequest": { "$ref": "#/components/schemas/SegmentListsConfigRequest2" } }, "description": "Candidate Path with explicitly defined set/s of segment-lists configuration parameters" }, "ExplicitParamsConfig": { "title": "ExplicitParamsConfig", "type": "object", "properties": { "explicitPathProperties": { "$ref": "#/components/schemas/ExplicitPathProperties2" } }, "description": "Candidate Path with explicitly defined set/s of segment-lists configuration parameters" }, "ExplicitPathProperties": { "title": "ExplicitPathProperties", "type": "object", "properties": { "segmentLists": { "$ref": "#/components/schemas/SegmentLists3" } }, "description": "Explicit path properties of the candidate path" }, "ExplicitRouteStrategyBsidSettings": { "title": "ExplicitRouteStrategyBsidSettings", "type": "object", "properties": { "emplacementPreference": { "$ref": "#/components/schemas/EmplacementPreference" }, "runPermutation": { "type": "boolean", "description": "A given strategy made have various potential permutations on where a BSID made be placed to achieve label stack reduction. For example, in a multi area topology with an area splitting strategy the algorithm may have an option to place a BSID in Area 1, or Area 0, or both. When the value is set to false, the computation will program a BSID in all split areas feasible. When the value is set to true, the computation will attempt different permutations and determine a subset result to achieve label stack reduction, using the emplacement-preference setting to give preference for the final result given multiple equal options" }, "stopOnFirstResult": { "type": "boolean", "description": "The BSID generation algorithm computes using a sequence of strategies. This option determines if the calculation should stop after a result is found, or continue attempting additional strategies for a potentially more optimal result" } }, "description": "Only applicable to Explicit Route Strategy with a value of containing BSID (Binding Segment). Controls settings regarding BSID selection and/or BSID generation rules when computing a path result" }, "ExplicitRouteStrategyCompressedSettings": { "title": "ExplicitRouteStrategyCompressedSettings", "type": "object", "properties": { "fallbackIgpNoTe": { "type": "boolean", "description": "If the path calculation fails to find a feasible result that satisfies MSD, this flag will permit the calculation to fallback to computing a path based on Objective COST without respecting traffic engineering constraints such as bandwidth or any of the cumulative constraints. Admin groups, diversity and bi-directional feature sets are respected and enforced. The goal of this is to permit the path calculation to fallback to a managed PCE computed path based on the IGP SPF which is more likely to succeed in satisfying MSD requirements. Due to potential ECMP options in the topology it may also be unable to compress a computed path. The default value is false. It is recommended to be enabled only if operator preference is for a tunnel to remain operationally up rather than respecting all traffic engineering requirements" }, "fallbackIgpTe": { "type": "boolean", "description": "If the path calculation fails to find a feasible result that satisfies MSD, this flag will permit the calculation to fallback to computing a traffic engineered path with Objective COST. The default value is true and is recommended to be true" }, "fallbackLooseHop": { "type": "boolean", "description": "If the path calculation fails to find a new feasible TE path that satisfies MSD, this flag will permit provisioning the path with only a Node SID to the destination, without any traffic engineering constraints or ECMP validation. This causes the tunnel to behave in a similar manner on the PCC as a locally computed non-cspf SR-ISIS or SR-OSPF path, thus allowing the tunnel to stay operationally up instead of go operationally down. This option does not support bidirectional strict or diversity routed paths. If this option is used, the PCE loses all path tracking visibility thus limiting feature capabilities and support, and potentially inaccurate bandwidth utilization tracking. The default value is false. If this option is enabled, it is strongly recommended that option fallback-status-quo is also enabled" }, "fallbackStatusQuo": { "type": "boolean", "description": "If the path calculation fails to find a new feasible TE path that satisfies MSD, this flag will permit an established tunnel to remain on the previously calculated path, if the current path is still a viable path that satisfies all constraints, rather than proceeding to the next fallback option, the path will be kept active on it's previously calculated path instead of re-routing. In addition to keeping the path fully managed, this option aids in de-risking and mitigating potential bandwidth related oscillation issues caused by fallback-loose-hop due to loss of path tracking. The default value is true and recommended to be true" } }, "description": "Only applicable to Explicit Route Strategy with a value of Compressed. These options further tune the behaviour of the Compressed strategy. The fallback options provide relaxation extensions for scenarios where PCE computes a new traffic engineered path but is unable to be compress to satisfy the max segment depth (MSD) constraint. The purpose of these options is to control relxation behavior in an effort to find a result and keep the tunnel operationally up. The order of operations for the fallback at runtime is: fallbackIgpTe, fallbackIgpNoTe, fallbackStatusQuo, fallbackLooseHop" }, "ForwardingPath": { "title": "ForwardingPath", "type": "object", "properties": { "computedBandwidth": { "type": "integer", "description": "Computed bandwidth capacity. Unit kbps. This bandwidth is calculated based on Candidate Path bandwidth and the segment-list weight value", "format": "int64" }, "forwardingPathProperties": { "$ref": "#/components/schemas/ForwardingPathProperties" }, "hasMissingResource": { "type": "boolean", "description": "True if segment list has invalid SID value" }, "hopsData": { "$ref": "#/components/schemas/HopsData2" }, "id": { "type": "string", "description": "An identifier to uniquely identify the segment-list" }, "name": { "type": "string", "description": "Segment-list name" }, "operationalState": { "$ref": "#/components/schemas/OperationalState7" }, "segments": { "$ref": "#/components/schemas/Segments1" }, "weight": { "type": "integer", "description": "Segment-list weighted loadshare. Default weight is 1. Formula: bandwidth * weight / sumOfWeight", "format": "int64" } } }, "ForwardingPathProperties": { "title": "ForwardingPathProperties", "type": "object", "properties": { "pathSearchBehaviorsInvoked": { "type": "array", "items": { "$ref": "#/components/schemas/PathSearchBehaviorsInvoked" }, "description": "A list of behaviors invoked on the path during the last path calculation" } } }, "ForwardingPaths": { "title": "ForwardingPaths", "type": "object", "properties": { "forwardingPaths": { "$ref": "#/components/schemas/ForwardingPaths1" } }, "description": "Forwarding paths grouping for forwarding state of paths" }, "ForwardingPathsMember": { "title": "ForwardingPathsMember", "type": "object", "properties": { "forwardingPath": { "type": "array", "items": { "$ref": "#/components/schemas/ForwardingPath" }, "description": "" } }, "description": "forwarding-paths properties" }, "HopData": { "title": "HopData", "type": "object", "properties": { "hopDataParamsState": { "$ref": "#/components/schemas/HopDataParamsState2" }, "hopId": { "type": "integer", "description": "Hop index", "format": "int32" } } }, "HopDataParamsState": { "title": "HopDataParamsState", "type": "object", "properties": { "hopDataProperties": { "$ref": "#/components/schemas/HopDataProperties2" } }, "description": "Hop data for state" }, "HopDataProperties": { "title": "HopDataProperties", "type": "object", "properties": { "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "Unique resource identifiers for the hop" }, "sid": { "type": "integer", "description": "Sid index", "format": "int32" }, "sidHopType": { "$ref": "#/components/schemas/SidHopType" }, "sourceSiteId": { "type": "string", "description": "Source ip address of the hop" } }, "description": "NSP hop data grouping" }, "HopsData": { "title": "HopsData", "type": "object", "properties": { "hopData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/HopData" } } }, "description": "Hops for given segment list" }, "LatencyTest": { "title": "LatencyTest", "type": "object", "properties": { "destination": { "type": "string", "description": "Destination IP address for latency test" }, "session": { "type": "string", "description": "Session name of latency test on the node" }, "source": { "type": "string", "description": "Source IP address for latency test" } }, "description": "Object representing a single latency test" }, "LspBsidGenerationConfig": { "title": "LspBsidGenerationConfig", "type": "object", "properties": { "deploymentType": { "$ref": "#/components/schemas/DeploymentType" }, "enabled": { "type": "boolean", "description": "Toggle whether NRCP should support LSP BSID generation." } }, "description": "Define LSP related configuration." }, "LspPathsFetchRequestParameters": { "title": "LspPathsFetchRequestParameters", "type": "object", "properties": { "pathType": { "$ref": "#/components/schemas/PathType2" }, "sourceAddress": { "$ref": "#/components/schemas/SourceAddress" }, "tunnelId": { "type": "integer", "description": "Path tunnel identifier", "format": "int64" } }, "description": "Group of attributes to identify LSP paths by source-address, tunnel-id and path-type" }, "MplsLabel": { "title": "MplsLabel", "type": "object", "properties": { "int32": { "type": "integer", "format": "int32" } }, "description": "Segment identifier, value -1 implies auto-assign for NRC-P. Value zero implies auto-assign on node, but is unsupported until we get BGP-LS discovery" }, "MultilinkPortInfo": { "title": "MultilinkPortInfo", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the port" }, "name": { "type": "string", "description": "The name of the port" }, "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" } }, "description": "The parameters of a multipoint link port" }, "MultipointLink": { "title": "MultipointLink", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "name": { "type": "string", "description": "The name of the multipoint link" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "ports": { "type": "array", "items": { "$ref": "#/components/schemas/MultilinkPortInfo" }, "description": "" } }, "description": "A multipoint link represents a link connecting multiple ports." }, "NodeFlag": { "title": "NodeFlag", "type": "object", "properties": { "b": { "type": "boolean" }, "e": { "type": "boolean" }, "o": { "type": "boolean" }, "r": { "type": "boolean" }, "t": { "type": "boolean" }, "v": { "type": "boolean" } } }, "NodeFlagData": { "title": "NodeFlagData", "type": "object", "properties": { "nodeFlagsData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NodeFlag" } } }, "description": "A list of topology protocol and its node flag" }, "NrcpHistorical": { "title": "NrcpHistorical", "type": "object", "properties": { "historicalIgpTopologyEnabled": { "type": "boolean", "description": "Toggle whether NRCP should publish IGP topology events for historical use or not. The NRCP Historical Application will consume the messages and persist records to the database." }, "historicalLspStatsEnabled": { "type": "boolean", "description": "Toggle whether NRCP should publish LSP statistics events for historical use or not. The NRCP Historical Application will consume the messages and persist records to the database." }, "historicalPathEnabled": { "type": "boolean", "description": "Toggle whether NRCP should publish LSP path events for historical use or not. The NRCP Historical Application will consume the messages and persist records to the database." } }, "description": "Grouping of all historical related parameters for IP/MPLS optimization." }, "PathAttempt": { "title": "PathAttempt", "type": "object", "properties": { "description": { "type": "string", "description": "Description of the attempt" }, "objective": { "$ref": "#/components/schemas/Objective19" }, "paths": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PointToPointPathData" } }, "relaxedConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/ConstraintData" }, "description": "" } }, "description": "Attempt info to help identify why/what paths are found or not found" }, "PathProfileOverrideRequest": { "title": "PathProfileOverrideRequest", "type": "object", "properties": { "extendedId": { "type": "integer", "description": "Path extended identifier. An identifier for profile association/grouping", "format": "int64" }, "pathIds": { "type": "array", "items": { "type": "string" }, "description": "IDs: List of unique LSP path identifiers" }, "profileId": { "type": "integer", "description": "Path profile identifier. An identifier of a predefined profile. 0 means no path profile assigned. -1 deletes the path profile override", "format": "int64" } } }, "PathRequest": { "title": "PathRequest", "type": "object", "properties": { "pathTeParams": { "$ref": "#/components/schemas/PathTeParams2" } }, "description": "Path request contains path type and all the path tool TE parameters" }, "PathResource": { "title": "PathResource", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Type6" }, "uuid": { "type": "string", "description": "Path resource uuid" } }, "description": "Path Resource" }, "PathTeParams": { "title": "PathTeParams", "type": "object", "properties": { "adminGroupExcludeAny": { "$ref": "#/components/schemas/AdminGroupExcludeAny" }, "adminGroupIncludeAll": { "$ref": "#/components/schemas/AdminGroupIncludeAll" }, "adminGroupIncludeAny": { "$ref": "#/components/schemas/AdminGroupIncludeAny" }, "bandwidth": { "type": "integer", "description": "Path bandwidth capacity. Units in Kbps", "format": "int32" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional22" }, "diversity": { "$ref": "#/components/schemas/Diversity" }, "excludeRouteObjects": { "type": "array", "items": { "$ref": "#/components/schemas/IpAddress" }, "description": "Excluded Route Objects. Path must not contain any of the entities which correspond to the IP Addresses in this set" }, "explicitRouteStrategy": { "$ref": "#/components/schemas/ExplicitRouteStrategy1" }, "explicitRouteStrategyBsidSettings": { "$ref": "#/components/schemas/ExplicitRouteStrategyBsidSettings1" }, "explicitRouteStrategyCompressedSettings": { "$ref": "#/components/schemas/ExplicitRouteStrategyCompressedSettings1" }, "explicitRouteStrategyEcmpPreference": { "$ref": "#/components/schemas/ExplicitRouteStrategyEcmpPreference1" }, "includeRouteObjects": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IroHop" } }, "ipAddressTypeStrategy": { "$ref": "#/components/schemas/IpAddressTypeStrategy" }, "maxCost": { "type": "integer", "description": "Path maximum cost constraint", "format": "int64" }, "maxHops": { "type": "integer", "description": "Path maximum hops constraint. 0 and 255 means no limit.", "format": "int64" }, "maxLatency": { "type": "number", "description": "Path maximum latency constraint (in microseconds)" }, "maxTeMetric": { "type": "integer", "description": "Path maximum TE metric constraint", "format": "int64" }, "msd": { "type": "integer", "description": "Path maximum SID depth. The advertised MSD from the source node will be used if msd is set to 0", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective26" }, "pathProfileId": { "type": "integer", "description": "Path profile identifier. An identifier of a predefined profile. 0 means no path profile assigned. NOTE: Path diagnosis behaves like LSP diagnosis, the path profile takes precedence for constraints of [objective, bidirectional, diversity, includeRouteObjects, excludeRouteObjects, explicitRouteStrategy, explicitRouteStrategyEcmpPreference], and other individual path TE params will not be override by the path profile if non-default values are provided. But for the regular IP Path finding request, the individual Path TE params take precedence if values are provided to allow more tuning and customization, otherwise, values will come from path profile or set to default values.", "format": "int64" }, "reverseBandwidth": { "type": "integer", "description": "Reverse Path bandwidth capacity. Units in Kbps", "format": "int32" }, "srAlgorithm": { "type": "integer", "description": "Algorithm number, 0 is SPF based on link metric. 128..255 is Flex Algo defined by operator on a per deployment basis.", "format": "int64" } }, "description": "Path tool parameters" }, "PathToolHop": { "title": "PathToolHop", "type": "object", "properties": { "hopId": { "type": "integer", "description": "Path hop identifier", "format": "int32" }, "hopResourceIds": { "type": "array", "items": { "type": "string" }, "description": "Unique identifiers of hop resources, note that it's only the directly consumed IP resources, not recursion" }, "hopType": { "$ref": "#/components/schemas/HopType" }, "localInterfaceIndex": { "type": "integer", "description": "Local path hop interface index. This value used as local identifier for unnumbered interface", "format": "int32" }, "localInterfaceIp": { "$ref": "#/components/schemas/LocalInterfaceIp" }, "localRouterId": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteInterfaceIndex": { "type": "integer", "description": "Remote path hop interface index. This value used as remote identifier for unnumbered interface", "format": "int32" }, "remoteInterfaceIp": { "$ref": "#/components/schemas/RemoteInterfaceIp" }, "segmentProperty": { "$ref": "#/components/schemas/SegmentProperty2" }, "segmentRouteType": { "$ref": "#/components/schemas/SegmentRouteType" }, "sidHopType": { "$ref": "#/components/schemas/SidHopType2" } }, "description": "Path hop" }, "PointToPointPathData": { "title": "PointToPointPathData", "type": "object", "properties": { "destNodeUuid": { "type": "string", "description": "ID: Unique identifier of the destination router" }, "name": { "type": "string", "description": "Path name, a fixed source-destination name for each path" }, "pathHops": { "type": "array", "items": { "$ref": "#/components/schemas/PathToolHop" }, "description": "" }, "pathMetrics": { "type": "object", "additionalProperties": { "type": "object" } }, "pathResources": { "type": "array", "items": { "$ref": "#/components/schemas/PathResource" }, "description": "" }, "srcNodeUuid": { "type": "string", "description": "ID: Unique identifier of the source router" }, "time": { "type": "integer", "description": "Time spent performing calculation (in microseconds)", "format": "int64" } }, "description": "Path data for path finding result" }, "PointToPointPathRequest": { "title": "PointToPointPathRequest", "required": [ "destinationAddress", "sourceAddress" ], "type": "object", "properties": { "destinationAddress": { "$ref": "#/components/schemas/DestinationAddress" }, "pathRequest": { "$ref": "#/components/schemas/PathRequest1" }, "pathType": { "$ref": "#/components/schemas/PathType3" }, "secondaryDestinationAddress": { "$ref": "#/components/schemas/SecondaryDestinationAddress" }, "secondarySourceAddress": { "$ref": "#/components/schemas/SecondarySourceAddress" }, "sourceAddress": { "$ref": "#/components/schemas/SourceAddress" } }, "description": "Point to point path request, which supports path finding from one source to one destination, and optional secondary source/destination" }, "PointToPointPathResult": { "title": "PointToPointPathResult", "type": "object", "properties": { "avoidedResources": { "type": "array", "items": { "$ref": "#/components/schemas/AvoidedData" }, "description": "" }, "errorMsg": { "type": "string", "description": "Error message" }, "pathSearchBehaviorsInvoked": { "type": "array", "items": { "$ref": "#/components/schemas/PathSearchBehaviorsInvoked" }, "description": "A list of behaviors invoked on the path during the last path calculation" }, "paths": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PointToPointPathData" } }, "rejections": { "type": "array", "items": { "$ref": "#/components/schemas/RejectionRunData" }, "description": "" } }, "description": "Point to point path finding result, note that rejections is not supported for diverse paths (i.e. secondary source/destination may not return rejections)" }, "Policies": { "title": "Policies", "type": "object", "properties": { "policies": { "$ref": "#/components/schemas/Policies1" } }, "description": "NSP segment routing policies grouping" }, "PoliciesMember": { "title": "PoliciesMember", "type": "object", "properties": { "srPolicy": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SrPolicy" } } }, "description": "SR Policy container" }, "PolicyParamsConfig": { "title": "PolicyParamsConfig", "type": "object", "properties": { "policyProperties": { "$ref": "#/components/schemas/PolicyProperties1" } }, "description": "Policy parameters configuration" }, "PolicyParamsState": { "title": "PolicyParamsState", "type": "object", "properties": { "policyProperties": { "$ref": "#/components/schemas/PolicyProperties1" } }, "description": "Policy parameters states" }, "PolicyProperties": { "title": "PolicyProperties", "type": "object", "properties": { "ownership": { "$ref": "#/components/schemas/Ownership" }, "priority": { "type": "integer", "description": "Unsupported - Priority considered when policy is recomputed due to topology changes. Range from 0 to 255. Value 0 is the highest priority", "format": "int32" } }, "description": "Sr Policy properties" }, "PrefixSidsInfo": { "title": "PrefixSidsInfo", "type": "object", "properties": { "algorithm": { "type": "integer", "description": "This field contains the identifier of the algorithm the router MUST use in order to compute reachability to the range of prefixes. Currently we only support algorithm 0 (Shortest Path First)", "format": "int32" }, "flags": { "$ref": "#/components/schemas/PrefixSidFlags" }, "segmentValue": { "type": "integer", "description": "The actual sid label", "format": "int64" }, "sid": { "type": "integer", "description": "The segment index", "format": "int64" } } }, "RejectionData": { "title": "RejectionData", "type": "object", "properties": { "actualValue": { "type": "object", "description": "The value which was found on the resource and was compared to the required value. This value may be null" }, "description": { "type": "string", "description": "Rejection description contains a brief explanation for why an entity was excluded during the path search" }, "entityType": { "$ref": "#/components/schemas/EntityType1" }, "name": { "type": "string", "description": "Rejection name" }, "rejectionKey": { "type": "string", "description": "Rejection key is a fixed string identifier for the type of rejection" }, "requiredValue": { "type": "object", "description": "The value required in the path calculation which was not satisfied and was compared to the actual value. This value may be null" }, "uuid": { "type": "string", "description": "UUID: An identifier for an entity rejected in the path. This UUID may correspond to entities such as Links, Nodes or logical grouping entities such as Adjacency Sets, Binding SID." } }, "description": "Rejection Data" }, "RejectionRunData": { "title": "RejectionRunData", "type": "object", "properties": { "description": { "type": "string", "description": "A text which tries to summarize why the rejection run data may have ran or which iteration. This is an unstructured description to try to give user indication why this execution may have occurred or for what purpose" }, "id": { "type": "string", "description": "An identifier string that is unique within the context of this path search request" }, "parentId": { "type": "string", "description": "Path calculations may perform many searches that could be nested. A rejection run data is a nested search when its parentId is not null. The parentId corresponds to the id field in this same collection." }, "rejectionData": { "type": "array", "items": { "$ref": "#/components/schemas/RejectionData" }, "description": "" } }, "description": "Rejection Run Data" }, "RequestAssocGroupConfig": { "title": "RequestAssocGroupConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data108" } } }, "RequestBsidGenerationConfig": { "title": "RequestBsidGenerationConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BsidGenerationConfig" } } }, "RequestCandidatePathsUpdateRequest": { "title": "RequestCandidatePathsUpdateRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CandidatePathsUpdateRequest" } } }, "RequestDeviceNameMappingConfig": { "title": "RequestDeviceNameMappingConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data109" } } }, "RequestElineEndpointRequest": { "title": "RequestElineEndpointRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ElineEndpointRequest" } } }, "RequestListSrPoliciesConfigRequest": { "title": "RequestListSrPoliciesConfigRequest", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SrPoliciesConfigRequest" }, "description": "" } } }, "RequestLspBsidGenerationConfig": { "title": "RequestLspBsidGenerationConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data110" } } }, "RequestLspPathsFetchRequestParameters": { "title": "RequestLspPathsFetchRequestParameters", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data111" } } }, "RequestNodeParams": { "title": "RequestNodeParams", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data112" } } }, "RequestNrcpHistorical": { "title": "RequestNrcpHistorical", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data113" } } }, "RequestPathProfileOverrideRequest": { "title": "RequestPathProfileOverrideRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PathProfileOverrideRequest" } } }, "RequestPointToPointPathRequest": { "title": "RequestPointToPointPathRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data114" } } }, "RequestSrPoliciesUpdateRequest": { "title": "RequestSrPoliciesUpdateRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SrPoliciesUpdateRequest" } } }, "RequestSrPolicyConfig": { "title": "RequestSrPolicyConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data115" } } }, "RequestTerminationPointParams": { "title": "RequestTerminationPointParams", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data116" } } }, "ResolutionFilter": { "title": "ResolutionFilter", "type": "object", "properties": { "bgp": { "type": "boolean", "description": "Set BGP type for auto bind tunnel" }, "ldp": { "type": "boolean", "description": "Enable/disable setting LDP type for auto-bind-tunnel" }, "mplsFwdPolicy": { "type": "boolean", "description": "Enable/disable setting MPLS Forwarding Policy type for auto-bind-tunnel" }, "ribApi": { "type": "boolean", "description": "Enable/disable setting RIB API type for auto-bind-tunnel" }, "rsvp": { "type": "boolean", "description": "Enable/disable setting RSVP-TE type for auto-bind-tunnel" }, "srIsis": { "type": "boolean", "description": "Enable/disable setting SR-ISIS type for auto-bind-tunnel" }, "srOspf": { "type": "boolean", "description": "Enable/disable setting SR-OSPF type for auto-bind-tunnel" }, "srOspf3": { "type": "boolean", "description": "Use segment routing ospf3 for next hop resolution." }, "srPolicy": { "type": "boolean", "description": "Enable/disable setting SR Policy type for auto-bind-tunnel" }, "srTe": { "type": "boolean", "description": "Enable/disable setting SR-TE type for auto-bind-tunnel" }, "udp": { "type": "boolean", "description": "Set UDP type for auto-bind-tunnel" } } }, "ResponseDataAssocGroupConfig": { "title": "ResponseDataAssocGroupConfig", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseAssocGroupConfig" } } }, "ResponseDataAssociationGroup": { "title": "ResponseDataAssociationGroup", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseAssociationGroup" } } }, "ResponseDataBsidGenerationConfig": { "title": "ResponseDataBsidGenerationConfig", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseBsidGenerationConfig" } } }, "ResponseDataCandidatePaths": { "title": "ResponseDataCandidatePaths", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseCandidatePaths" } } }, "ResponseDataCandidatePath": { "title": "ResponseDataCandidatePath", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseCandidatePath" } } }, "ResponseDataConsumerCountResult": { "title": "ResponseDataConsumerCountResult", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseConsumerCountResult" } } }, "ResponseDataDeviceNameMappingConfig": { "title": "ResponseDataDeviceNameMappingConfig", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseDeviceNameMappingConfig" } } }, "ResponseDataListConnectionProfile": { "title": "ResponseDataListConnectionProfile", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListConnectionProfile" } } }, "ResponseDataListLink": { "title": "ResponseDataListLink", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListLink" } } }, "ResponseDataListMultipointLink": { "title": "ResponseDataListMultipointLink", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListMultipointLink" } } }, "ResponseDataListPathAttempt": { "title": "ResponseDataListPathAttempt", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseListPathAttempt" } } }, "ResponseDataLspBsidGenerationConfig": { "title": "ResponseDataLspBsidGenerationConfig", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseLspBsidGenerationConfig" } } }, "ResponseDataMultipointLink": { "title": "ResponseDataMultipointLink", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseMultipointLink" } } }, "ResponseDataNrcpHistorical": { "title": "ResponseDataNrcpHistorical", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseNrcpHistorical" } } }, "ResponseDataPointToPointPathResult": { "title": "ResponseDataPointToPointPathResult", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponsePointToPointPathResult" } } }, "ResponseDataPolicies": { "title": "ResponseDataPolicies", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponsePolicies" } } }, "ResponseDataSrPolicyConfig": { "title": "ResponseDataSrPolicyConfig", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseSrPolicyConfig" } } }, "ResponseDataSrPolicy": { "title": "ResponseDataSrPolicy", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ResponseSrPolicy" } } }, "ResponseAssocGroupConfig": { "title": "ResponseAssocGroupConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data108" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseAssociationGroup": { "title": "ResponseAssociationGroup", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data118" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseBsidGenerationConfig": { "title": "ResponseBsidGenerationConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BsidGenerationConfig" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseCandidatePaths": { "title": "ResponseCandidatePaths", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data119" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseCandidatePath": { "title": "ResponseCandidatePath", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CandidatePath" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseConsumerCountResult": { "title": "ResponseConsumerCountResult", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConsumerCountResult" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseDeviceNameMappingConfig": { "title": "ResponseDeviceNameMappingConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data109" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListConnectionProfile": { "title": "ResponseListConnectionProfile", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionProfile" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListLink": { "title": "ResponseListLink", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Link" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListMultipointLink": { "title": "ResponseListMultipointLink", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MultipointLink" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseListPathAttempt": { "title": "ResponseListPathAttempt", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PathAttempt" }, "description": "" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseLspBsidGenerationConfig": { "title": "ResponseLspBsidGenerationConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data110" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseMultipointLink": { "title": "ResponseMultipointLink", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data122" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseNrcpHistorical": { "title": "ResponseNrcpHistorical", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data113" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponsePointToPointPathResult": { "title": "ResponsePointToPointPathResult", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data124" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponsePolicies": { "title": "ResponsePolicies", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data125" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseSrPolicyConfig": { "title": "ResponseSrPolicyConfig", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data115" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "ResponseSrPolicy": { "title": "ResponseSrPolicy", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SrPolicy" }, "endRow": { "type": "integer", "format": "int64" }, "startRow": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" } } }, "Rvpls": { "title": "Rvpls", "type": "object", "properties": { "evpnTunnel": { "type": "boolean", "description": "Whether the connected VPLS is EVPN tunnelled" }, "vplsName": { "type": "string", "description": "The name of the VPLS to which this endpoint connects to" } } }, "Segment": { "title": "Segment", "type": "object", "properties": { "index": { "type": "integer", "description": "Segment index", "format": "int64" }, "segmentParamsState": { "$ref": "#/components/schemas/SegmentParamsState2" } } }, "SegmentList": { "title": "SegmentList", "type": "object", "properties": { "name": { "type": "string", "description": "Segment-list name" }, "segments": { "$ref": "#/components/schemas/Segments3" }, "weight": { "type": "integer", "description": "Segment-list weighted loadshare. Default weight is 1. Formula: bandwidth * weight / sumOfWeight", "format": "int64" } } }, "SegmentListSegments": { "title": "SegmentListSegments", "type": "object", "properties": { "segment": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SegmentListSegmentsSegment" } } }, "description": "Segments for given segment list" }, "SegmentListSegmentsSegment": { "title": "SegmentListSegmentsSegment", "type": "object", "properties": { "index": { "type": "integer", "description": "Segment index", "format": "int64" }, "segmentParamsConfig": { "$ref": "#/components/schemas/SegmentParamsConfig2" } } }, "SegmentLists": { "title": "SegmentLists", "type": "object", "properties": { "segmentLists": { "$ref": "#/components/schemas/SegmentLists1" } }, "description": "Segment lists grouping" }, "SegmentListsConfig": { "title": "SegmentListsConfig", "type": "object", "properties": { "segmentList": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentListsConfigSegmentList" }, "description": "" } }, "description": "Segment-lists properties" }, "SegmentListsConfigRequest": { "title": "SegmentListsConfigRequest", "type": "object", "properties": { "segmentListsConfig": { "$ref": "#/components/schemas/SegmentListsConfig2" } }, "description": "Segment lists grouping" }, "SegmentListsConfigSegmentList": { "title": "SegmentListsConfigSegmentList", "type": "object", "properties": { "name": { "type": "string", "description": "Segment-list name" }, "segmentsConfig": { "$ref": "#/components/schemas/SegmentsConfig2" }, "weight": { "type": "integer", "description": "Segment-list weighted loadshare. Default weight is 1. Formula: bandwidth * weight / sumOfWeight", "format": "int64" } } }, "SegmentListsMember": { "title": "SegmentListsMember", "type": "object", "properties": { "segmentList": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentList" }, "description": "" } }, "description": "Segment-lists properties" }, "SegmentParamsConfig": { "title": "SegmentParamsConfig", "type": "object", "properties": { "segmentProperties": { "$ref": "#/components/schemas/SegmentProperties1" } }, "description": "Segment properties configuration" }, "SegmentParamsState": { "title": "SegmentParamsState", "type": "object", "properties": { "segmentProperties": { "$ref": "#/components/schemas/SegmentProperties1" } }, "description": "Segment properties state" }, "SegmentProperties": { "title": "SegmentProperties", "type": "object", "properties": { "segmentTypes": { "$ref": "#/components/schemas/SegmentTypes1" }, "type": { "$ref": "#/components/schemas/Type4" }, "validate": { "type": "boolean", "description": "Unsupported -Indicates whether the segment should be validated. The default applies to all segments other than the first segment. For the first segment, validation is always done" } }, "description": "Segment properties grouping" }, "SegmentProperty": { "title": "SegmentProperty", "type": "object", "properties": { "segmentTypes": { "$ref": "#/components/schemas/SegmentTypes1" }, "type": { "$ref": "#/components/schemas/Type4" } }, "description": "Segment property" }, "SegmentType1": { "title": "SegmentType1", "type": "object", "properties": { "sidValue": { "$ref": "#/components/schemas/SidValue" } }, "description": "Segment declared by MPLS label" }, "SegmentType10": { "title": "SegmentType10", "type": "object", "properties": { "localInterfaceIdentifier": { "type": "integer", "description": "Local interface identifier", "format": "int64" }, "localIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteInterfaceIdentifier": { "type": "integer", "description": "Remote interface identifier", "format": "int64" }, "remoteIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Unsupported - Segment declared by IPv6 Prefix and Interface ID for link endpoints as Local, Remote pair for SRv6" }, "SegmentType11": { "title": "SegmentType11", "type": "object", "properties": { "localIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Unsupported - Segment declared by IPv6 Addresses for link endpoints as Local, Remote pair for SRv6" }, "SegmentType2": { "title": "SegmentType2", "type": "object", "properties": { "sidValue": { "$ref": "#/components/schemas/SidValue1" } }, "description": "Unsupported - Segment declared by SRv6 SID value" }, "SegmentType3": { "title": "SegmentType3", "type": "object", "properties": { "algorithm": { "type": "integer", "description": "Prefix SID algorithm identifier", "format": "int32" }, "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Unsupported - Segment declared by IPv4 Prefix with optional SR Algorithm" }, "SegmentType4": { "title": "SegmentType4", "type": "object", "properties": { "algorithm": { "type": "integer", "description": "Prefix SID algorithm identifier", "format": "int32" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Unsupported - Segment declared by IPv6 Global Prefix with optional SR Algorithm for SR-MPLS" }, "SegmentType5": { "title": "SegmentType5", "type": "object", "properties": { "interfaceIdentifier": { "type": "integer", "description": "local interface identifier", "format": "int64" }, "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Unsupported - Segment declared by IPv4 Prefix with Local Interface ID" }, "SegmentType6": { "title": "SegmentType6", "type": "object", "properties": { "localIpv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteIpv4Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Segment declared by IPv4 Addresses for link endpoints as Local, Remote pair" }, "SegmentType7": { "title": "SegmentType7", "type": "object", "properties": { "localInterfaceIdentifier": { "type": "integer", "description": "Local interface identifier", "format": "int64" }, "localIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteInterfaceIdentifier": { "type": "integer", "description": "Remote interface identifier", "format": "int64" }, "remoteIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Unsupported - Segment declared by IPv6 Prefix and Interface ID for link endpoints as Local, Remote pair for SR-MPLS" }, "SegmentType8": { "title": "SegmentType8", "type": "object", "properties": { "localIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Unsupported - Segment declared by IPv6 Addresses for link endpoints as Local, Remote pair for SR-MPLS" }, "SegmentType9": { "title": "SegmentType9", "type": "object", "properties": { "algorithm": { "type": "integer", "description": "Prefix SID algorithm identifier", "format": "int32" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "Unsupported - Segment declared by IPv6 Global Prefix with optional SR Algorithm for SRv6" }, "SegmentTypes": { "title": "SegmentTypes", "type": "object", "properties": { "segmentType1": { "$ref": "#/components/schemas/SegmentType13" }, "segmentType10": { "$ref": "#/components/schemas/SegmentType72" }, "segmentType11": { "$ref": "#/components/schemas/SegmentType82" }, "segmentType2": { "$ref": "#/components/schemas/SegmentType22" }, "segmentType3": { "$ref": "#/components/schemas/SegmentType32" }, "segmentType4": { "$ref": "#/components/schemas/SegmentType42" }, "segmentType5": { "$ref": "#/components/schemas/SegmentType52" }, "segmentType6": { "$ref": "#/components/schemas/SegmentType62" }, "segmentType7": { "$ref": "#/components/schemas/SegmentType72" }, "segmentType8": { "$ref": "#/components/schemas/SegmentType82" }, "segmentType9": { "$ref": "#/components/schemas/SegmentType42" } }, "description": "Types of segments" }, "Segments": { "title": "Segments", "type": "object", "properties": { "segment": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Segment" } } }, "description": "Segments for given segment list" }, "SegmentsConfig": { "title": "SegmentsConfig", "type": "object", "properties": { "segment": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SegmentProperties" } } }, "description": "Segments for given segment list" }, "SidValueType": { "title": "SidValueType", "type": "object", "properties": { "mplsLabel": { "$ref": "#/components/schemas/MplsLabel2" }, "srv6Sid": { "$ref": "#/components/schemas/Srv6Sid2" } }, "description": "The SID value type. The only supported value is mpls-label" }, "SrPoliciesConfigRequest": { "title": "SrPoliciesConfigRequest", "required": [ "color", "endpoint", "headend" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState41" }, "candidatePathsConfig": { "$ref": "#/components/schemas/CandidatePathsConfig1" }, "color": { "type": "integer", "description": "Color associated with the policy", "format": "int64" }, "description": { "type": "string", "description": "Description of the policy" }, "endpoint": { "type": "string", "description": "Policy end point IP address" }, "headend": { "type": "string", "description": "Policy headend IP address" }, "name": { "type": "string", "description": "SR Policy name" }, "policyParamsConfig": { "$ref": "#/components/schemas/PolicyParamsConfig2" } } }, "SrPoliciesConfigRequestPolicyParamsConfig": { "title": "SrPoliciesConfigRequestPolicyParamsConfig", "type": "object", "properties": { "policyProperties": { "$ref": "#/components/schemas/PolicyProperties1" } }, "description": "Policy parameters configuration" }, "SrPoliciesUpdateRequest": { "title": "SrPoliciesUpdateRequest", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState41" }, "candidatePathsConfig": { "$ref": "#/components/schemas/CandidatePathsConfig1" }, "description": { "type": "string", "description": "Description of the policy" }, "policyParamsConfig": { "$ref": "#/components/schemas/PolicyParamsConfig2" } } }, "SrPoliciesUpdateRequestPolicyParamsConfig": { "title": "SrPoliciesUpdateRequestPolicyParamsConfig", "type": "object", "properties": { "policyProperties": { "$ref": "#/components/schemas/PolicyProperties1" } }, "description": "Policy parameters configuration" }, "SrPolicy": { "title": "SrPolicy", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState41" }, "candidatePaths": { "$ref": "#/components/schemas/CandidatePaths1" }, "color": { "type": "integer", "description": "Color associated with the policy", "format": "int64" }, "description": { "type": "string", "description": "Description of the policy" }, "endpoint": { "type": "string", "description": "Policy end point IP address" }, "headend": { "type": "string", "description": "Policy headend IP address" }, "id": { "type": "string", "description": "An identifier to uniquely identify the SR Policy" }, "name": { "type": "string", "description": "SR Policy name" }, "operationalState": { "$ref": "#/components/schemas/OperationalState12" }, "ownershipState": { "$ref": "#/components/schemas/OwnershipState2" }, "policyParamsConfig": { "$ref": "#/components/schemas/PolicyParamsConfig2" }, "policyParamsState": { "$ref": "#/components/schemas/PolicyParamsState2" } } }, "SrPolicyConfig": { "title": "SrPolicyConfig", "type": "object", "properties": { "bsidGenerationEnabled": { "type": "boolean", "description": "Toggle whether automatic BSID generation feature is permitted. This can be used to disable auto generation of SR Policies that may occur during label stack compression scenarios" }, "defaultBsidRangeEnd": { "type": "integer", "description": "Default end value of binding SID range", "format": "int32" }, "defaultBsidRangeStart": { "type": "integer", "description": "Default start value of binding SID range", "format": "int32" }, "defaultColorRangeEnd": { "type": "integer", "description": "Default end value of color range", "format": "int64" }, "defaultColorRangeStart": { "type": "integer", "description": "Default start value of color range", "format": "int64" }, "deploymentType": { "$ref": "#/components/schemas/DeploymentType1" } }, "description": "Grouping of all SR policy related parameters for IP/MPLS optimization." }, "Srv6Sid": { "title": "Srv6Sid", "type": "object", "properties": { "ipv6Prefix": { "$ref": "#/components/schemas/UrlSafeString" } }, "description": "This type defines a SID value in SRv6" }, "Timeout": { "title": "Timeout", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/disable latency timeout behaviour." }, "expiredTtl": { "type": "integer", "description": "Time-to-live (in seconds) for an OAM latency before it will be considered no longer valid and will be avoided during path calculations if possible. When set to 0, this avoidance behaviour will not be invoked. Default is 1800s (30mins), must always be greater than or equal to stale unless set to 0", "format": "int32" }, "staleTtl": { "type": "integer", "description": "Time-to-live (in seconds) for an OAM latency before it will be considered out-dated and an alarm will be raised. Default is 300s, must always be less than or equal to expired unless expired is set to 0", "format": "int32" } }, "description": "Grouping of parameters that defines latency timeout behaviour. If enabled, when an OAM latency value's age reaches each defined time-to-live stages, their respective behaviours will be invoked. When stale time-to-live is reached, an alarm will be raised to alert the user that there may be a problem with latency collection on that link. When expired time-to-live is reached, the path calculation algorithm will attempt to avoid the link when possible but won't bring down an LSP because of it. This avoidance behaviour can be removed by setting expired to 0." }, "AdminState41": { "title": "AdminState41", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "An enum for administrative state of an SR policy" }, "adminState46": { "title": "adminState46", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string" }, "AdminStatus2": { "title": "AdminStatus2", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "The administrative state of the node" }, "ApplicationType": { "title": "ApplicationType", "enum": [ "LEGACY_TE", "LFA", "RSVP", "SR" ], "type": "string", "description": "Application identifier type" }, "AppType": { "title": "AppType", "enum": [ "nsp_api", "external", "bgp_ls", "inventory" ], "type": "string", "description": "App type enum to write the device name to NRCP" }, "associationGroupType": { "title": "associationGroupType", "enum": [ "POLICY", "PROTECTION", "DISJOINT" ], "type": "string" }, "Bidirectional22": { "title": "Bidirectional22", "enum": [ "SYMMETRIC_LOOSE", "NO", "ASYMMETRIC_STRICT", "ASYMMETRIC_LOOSE", "ANY_REVERSE_ROUTE", "SYMMETRIC_STRICT" ], "type": "string", "description": "The Bidirectional Mode to be used in path computation. When any value other than Bidirectional.NO is applied, path calculation will perform a cost function evaluation for the links in the forward and reverse directions. When the objective is Star Weight, the forward and reverse values will be used in a Max() function. For all other Objective types, the forward and reverse values will be used in an Average Function. For example, with an Objective of Latency or TE Metric, if the link in the forward direction has a value of 3, and the link in the reverse direction has a value of 7, the value of the link used during path search will be considered as a value of 5. When a disjoint value is provided other than None and Bidirectional is NO, the bidirectional value is interpreted as SYMMETRIC_LOOSE. When the explicit route strategy is ECMP, the bidirectional value is treated as SYMMETRIC_LOOSE - no support for strict bidirectional. If not provided, value will come from path profile or default to NO. Note that ASYMMETRIC_STRICT / ASYMMETRIC_LOOSE are not supported in this release." }, "ConnectionProfileVlanTag": { "title": "ConnectionProfileVlanTag", "enum": [ "UNDEFINED", "OUTER", "INNER" ], "type": "string", "description": "The vlan tag of the connection profile" }, "Dataplane": { "title": "Dataplane", "enum": [ "mpls", "srv6" ], "type": "string", "description": "Binding SID dataplane type" }, "DeploymentType": { "title": "DeploymentType", "enum": [ "pcep" ], "type": "string", "description": "Type of deployment to be used by LSP BSID deployment. Option is PCEP." }, "DeploymentType1": { "title": "DeploymentType1", "enum": [ "bgp" ], "type": "string", "description": "Type of deployment used by SR policy. Option is BGP" }, "DisjointType": { "title": "DisjointType", "enum": [ "NO", "NODE_STRICT_AND_SRLG", "NODE_STRICT", "LINK_LOOSE", "LINK_STRICT_AND_SRLG", "NODE_LOOSE", "SRLG", "LINK_STRICT" ], "type": "string", "description": "The type of disjointness for a DISJOINT association group. Applicable only for association group DISJOINT type" }, "Diversity": { "title": "Diversity", "enum": [ "NO", "NODE_STRICT_AND_SRLG", "NODE_STRICT", "LINK_LOOSE", "LINK_STRICT_AND_SRLG", "NODE_LOOSE", "SRLG", "LINK_STRICT" ], "type": "string", "description": "The Disjoint Mode to be used in path computation. When the value is set as anything other than No then the bidirectional value is considered as SYMMETRIC_LOOSE unless explicitly set to something other than None. Note that NODE_LOOSE / LINK_LOOSE are not supported in this release and will return the same results as NODE_STRICT / LINK_STRICT. If not provided, value will come from path profile or default to NO." }, "EmplacementPreference": { "title": "EmplacementPreference", "enum": [ "CORE", "EDGE" ], "type": "string", "description": "This setting is applicable when run-permutation is set to true. Given a potential combination of results, this option controls where in the network relative topology should the BSID be placed. For example, the option CORE will prefer to place BSIDs in the center of the topology (such as Area 0), where as EDGE will prefer to place BSIDs closer to the edge/destination of the path such as a non backbone area" }, "EndpointAdminState": { "title": "EndpointAdminState", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "The administrative state required for the service." }, "EntityType": { "title": "EntityType", "enum": [ "BSID", "NODE", "ADJSET", "LINK" ], "type": "string", "description": "Entity type of the avoided entities, such as Link, Node or logical grouping entities such as Adjacency Sets, Binding SID." }, "EntityType1": { "title": "EntityType1", "enum": [ "BSID", "NODE", "ADJSET", "LINK" ], "type": "string", "description": "Entity type of the rejection entities, such as Link, Node or logical grouping entities such as Adjacency Sets, Binding SID." }, "ExplicitRouteStrategy1": { "title": "ExplicitRouteStrategy1", "enum": [ "LOOSE_HOP_ANYCAST_PREFERRED", "ECMP", "LOOSE_HOP_BSID_PREFERRED", "STANDARD_BSID_PREFERRED", "COMPRESSED", "LOOSE_HOP", "STANDARD" ], "type": "string", "description": "The strategy to use when computing the explicit route objects. The supported strategy options include STANDARD, LOOSE_HOP, LOOSE_HOP_ANYCAST_PREFERRED, LOOSE_HOP_BSID_PREFERRED, STANDARD_BSID_PREFERRED, COMPRESSED, ECMP. If not provided, value will come from path profile or default to STANDARD. NOTE: Explicit Route Strategy BSID Preferred or Loose hop BSID preferred may not return a viable path result. The algorithm will find and use existing binding SIDs in the topology but will not determine if new binding SIDs are required, and thus may ignore the MSD requirements of the request. Automatic Binding SID computation is only supported by Stateful Tunnel management and not supported in the path finder." }, "ExplicitRouteStrategyEcmpPreference1": { "title": "ExplicitRouteStrategyEcmpPreference1", "enum": [ "ADJACENCY_SID", "NODE_SID" ], "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. If not provided, value will come from path profile or default to ADJACENCY_SID." }, "IpAddressTypeStrategy": { "title": "IpAddressTypeStrategy", "enum": [ "IPV6", "IPV4", "ANY" ], "type": "string", "description": "Permitted IP Address Type. If not provided, default to IPV4" }, "NonIpProtocol": { "title": "NonIpProtocol", "enum": [ "RSVP", "SR" ], "type": "string" }, "Object": { "title": "Object", "enum": [ "CANDIDATE_PATH", "SRTE_LSP" ], "type": "string", "description": "Object signalling type" }, "Objective4": { "title": "Objective4", "enum": [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ], "type": "string", "description": "Specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency Hops, TE Metric and Star Weight are the supported values." }, "Objective26": { "title": "Objective26", "enum": [ "TE_METRIC", "COST", "DISTANCE", "STAR_WEIGHT", "LATENCY", "HOPS" ], "type": "string", "description": "Path metric objective, specifies the primary goal for identifying resources and/or paths for service creation. Cost, Latency, Hops, TE Metric and Star Weight are the supported values. If not provided, value will come from path profile or default to COST." }, "OperationalState8": { "title": "OperationalState8", "enum": [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ], "type": "string", "description": "Candidate Path operational state" }, "OperationalState12": { "title": "OperationalState12", "enum": [ "PARTIALLY_DOWN", "TRANSITION", "DOWN", "DEGRADED", "UNKNOWN", "UP" ], "type": "string", "description": "SR Policy operational state" }, "PathErrorCode1": { "title": "PathErrorCode1", "enum": [ "SR_POLICY_ADMIN_DOWN", "BINDING_INCONSISTENT_TYPE", "PCC_NOT_READY", "INVALID_PLSPID", "PROTO_DISCONNECTED", "PATH_NAME_IN_USE", "UNACCEPTABLE_PARAM", "BINDING_VAL_CANNOT_REMOVE", "VSR_NOT_EXSIST", "TERTIARY_PATH_DOWN", "PCC_NOT_CAPABLE", "PATH_NOT_FOUND", "NSP_INTERNAL", "UNDEFINED_PATH_ERR", "PCE_NOT_FOUND", "INVALID_BINDING_VAL", "ADMIN_DOWN", "NO_ERROR", "PCE_NOT_READY", "PCC_DISCONNECTED", "BINDING_VAL_CANNOT_ALLOCATE", "UNKNOWN_REASON", "SRC_NOT_EXIST", "INCOMPATIBLE_ASSOC_GROUP", "NO_RESPONSE", "PCC_INTERNAL_ERROR", "VSR_NOT_CAPABLE", "INTERNAL_ERROR", "PATH_PROFILE_NOT_FOUND", "LSP_BAD_PARAM", "SYNC_DELETE", "SRC_NOT_UNIQUE", "UNKNOWN_PLSPID", "BINDING_VAL_ALLOC_FAIL", "SIGNALLING", "ROM_CHANNEL_DISCONNECTED", "LIMIT_RCHD", "PCC_NOT_EXIST", "MULTI_SAME_TYPE_ASSOC_GROUP", "PCC_ADMIN_DOWN", "CIRCULAR_PATH_FOUND" ], "type": "string", "description": "The error code of path status" }, "PathSearchBehaviorsInvoked": { "title": "PathSearchBehaviorsInvoked", "enum": [ "COMPRESSED_FALLBACK_LOOSE_HOP", "DISJOINT_FAILED_FAST", "COMPRESSED_FALLBACK_IGP_TE", "COMPRESSED_FALLBACK_STATUS_QUO", "BIDIRECTIONAL_COROUTED", "COMPRESSED_FALLBACK_IGP_NO_TE", "TELEMETRY_CONGESTION_PATHSTAR_OBJECTIVE", "BIDIRECTIONAL_UNIROUTED" ], "type": "string" }, "PathType2": { "title": "PathType2", "enum": [ "SRTE", "UNKNOWN", "RSVP" ], "type": "string", "description": "LSP path signaling type" }, "PathType3": { "title": "PathType3", "enum": [ "SRTE", "UNKNOWN", "RSVP" ], "type": "string", "description": "Path type denoting signaling type. If not provided, default to RSVP" }, "PreferredRestorationLayer": { "title": "PreferredRestorationLayer", "enum": [ "ODU", "PHOTONIC_MEDIA", "DSR", "ETH" ], "type": "string", "description": "Indicate which layer this resilience parameters package configured for." }, "ProtocolOrigin": { "title": "ProtocolOrigin", "enum": [ "pcep", "bgp", "node_configuration", "bgp_discovered" ], "type": "string", "description": "Instantiation mechanism used to create the Candidate Path" }, "Resolution": { "title": "Resolution", "enum": [ "filter", "disabled", "any" ], "type": "string", "description": "Resolution method for EVPN IFL tunnel selection." }, "SidDataplaneType": { "title": "SidDataplaneType", "enum": [ "mpls", "srv6" ], "type": "string", "description": "The dataplane type for the sid" }, "SidHopType1": { "title": "SidHopType1", "enum": [ "PEER_NODE", "BSID", "ANYCAST_NODE", "PEER_ADJSID", "NODE", "ADJSET", "ADJSID" ], "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." }, "SidHopType2": { "title": "SidHopType2", "enum": [ "PEER_NODE", "BSID", "ANYCAST_NODE", "PEER_ADJSID", "NODE", "ADJSET", "ADJSID" ], "type": "string", "description": "SID Hop Type. This value is determined after post-processing the hops in the path. For original signalling type see Segment Route Type attribute." }, "TrafficEngineering": { "title": "TrafficEngineering", "enum": [ "TRUE", "FALSE", "NO_Value" ], "type": "string", "description": "NO_Value: No traffic Engineering value configured TRUE: Traffic-Engineering set to true FALSE: Traffic-Engineering set to false" }, "TunnelTypePreference": { "title": "TunnelTypePreference", "enum": [ "lsp", "sr_policy" ], "type": "string", "description": "Define what kind of tunnel type to be used for BSID generation. Options are lsp and sr-policy (default)" }, "Type": { "title": "Type", "enum": [ "POLICY", "PROTECTION", "DISJOINT" ], "type": "string", "description": "Association type. DISJOINT and POLICY are supported. PCE-init LSP only support POLICY type" }, "Type4": { "title": "Type4", "enum": [ "segment_type_7", "segment_type_8", "segment_type_5", "segment_type_6", "segment_type_3", "segment_type_4", "segment_type_1", "segment_type_2", "segment_type_10", "segment_type_11", "segment_type_9" ], "type": "string", "description": "Segment type" }, "Type6": { "title": "Type6", "enum": [ "SR_POLICY", "PREFIX", "NODE", "LINK" ], "type": "string", "description": "Type of the resource entity referred by the uuid" }, "AccessLtpId": { "title": "AccessLtpId", "type": "object", "properties": { "ipAddress": { "$ref": "#/components/schemas/IpAddress1" }, "uint32": { "type": "integer", "format": "int64" } } }, "AccessNodeId": { "title": "AccessNodeId", "type": "object", "properties": { "dottedQuad": { "$ref": "#/components/schemas/UrlSafeString" } } }, "AdjacencySegmentId1": { "title": "AdjacencySegmentId1", "type": "object", "properties": { "adjacencySegmentIdsInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdjacencySegmentIdsInfo" } } } }, "AdjacencySegmentIdData1": { "title": "AdjacencySegmentIdData1", "type": "object", "properties": { "adjacencySegmentIdsData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdjacencySegmentIdsData" } } } }, "AdminGroup1": { "title": "AdminGroup1", "type": "object", "properties": { "binary": { "type": "string" } } }, "AdminGroupExcludeAny": { "title": "AdminGroupExcludeAny", "type": "object", "properties": { "adminGroup": { "$ref": "#/components/schemas/AdminGroup1" }, "extendedAdminGroup": { "$ref": "#/components/schemas/ExtendedAdminGroup2" } } }, "AdminGroupIncludeAll": { "title": "AdminGroupIncludeAll", "type": "object", "properties": { "adminGroup": { "$ref": "#/components/schemas/AdminGroup1" }, "extendedAdminGroup": { "$ref": "#/components/schemas/ExtendedAdminGroup2" } } }, "AdminGroupIncludeAny": { "title": "AdminGroupIncludeAny", "type": "object", "properties": { "adminGroup": { "$ref": "#/components/schemas/AdminGroup1" }, "extendedAdminGroup": { "$ref": "#/components/schemas/ExtendedAdminGroup2" } } }, "AdministrativeGroup": { "title": "AdministrativeGroup", "type": "object", "properties": { "adminGroup": { "$ref": "#/components/schemas/AdminGroup1" }, "extendedAdminGroup": { "$ref": "#/components/schemas/ExtendedAdminGroup2" } } }, "adminState461": { "title": "adminState461", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "Candidate path administrative state, UP for enabled, DOWN for disabled, Maintenance is not supported" }, "adminState463": { "title": "adminState463", "enum": [ "MAINTENANCE", "DOWN", "UP" ], "type": "string", "description": "SR Policy administrative state, UP for enabled, DOWN for disabled, Maintenance is not supported" }, "Affinities1": { "title": "Affinities1", "type": "object", "properties": { "excludeAny": { "$ref": "#/components/schemas/ExcludeAny" }, "includeAll": { "$ref": "#/components/schemas/IncludeAll" }, "includeAny": { "$ref": "#/components/schemas/IncludeAny" } } }, "AsNumber1": { "title": "AsNumber1", "type": "object", "properties": { "uint32": { "type": "integer", "format": "int64" } } }, "associationGroupType1": { "title": "associationGroupType1", "enum": [ "POLICY", "PROTECTION", "DISJOINT" ], "type": "string", "description": "Association group type" }, "AsymmetricalOperation1": { "title": "AsymmetricalOperation1", "type": "object", "properties": { "egress": { "$ref": "#/components/schemas/Egress2" }, "ingress": { "$ref": "#/components/schemas/Ingress2" } } }, "AugmentationMetaInput2": { "title": "AugmentationMetaInput2", "required": [ "pathName", "templateName" ], "type": "object", "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" } } }, "AugmentationMetaJsonFileName2": { "title": "AugmentationMetaJsonFileName2", "type": "object", "properties": { "jsonFileName": { "type": "string", "description": "The json file name" } } }, "BandwidthProfiles2": { "title": "BandwidthProfiles2", "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." } } }, "BaseEndpointRequest2": { "title": "BaseEndpointRequest2", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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" } } }, "BaseService1": { "title": "BaseService1", "required": [ "bidirectional", "objective" ], "type": "object", "properties": { "actualEndState": { "$ref": "#/components/schemas/ActualEndState" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional1" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpointExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndPointExtension" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/BaseServiceEndpoint" }, "description": "" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "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": { "$ref": "#/components/schemas/LifeCycle3" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "name": { "type": "string", "description": "The name of the service" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service. Populated only when same node service identifier is used across all sites.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "pathProfileId": { "type": "string", "description": "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "requestedEndState": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "serviceType": { "$ref": "#/components/schemas/ServiceType1" }, "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." } } }, "BaseServiceHierarchy1": { "title": "BaseServiceHierarchy1", "type": "object", "properties": { "baseService": { "$ref": "#/components/schemas/BaseService1" }, "serviceTunnels": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTunnel" }, "description": "" } } }, "BindingSidProperties1": { "title": "BindingSidProperties1", "type": "object", "properties": { "dataplane": { "$ref": "#/components/schemas/Dataplane" }, "value": { "$ref": "#/components/schemas/Value" } } }, "Bounds1": { "title": "Bounds1", "type": "object", "properties": { "igpMetricBound": { "type": "integer", "description": "Path is invalid if its IGP metric exceeds this value", "format": "int64" }, "latencyMetricBound": { "type": "integer", "description": "Path is invalid if its latency exceeds this value", "format": "int64" }, "maxHops": { "type": "integer", "description": "Path maximum hops constraint. 0 and 255 means no limit.", "format": "int64" }, "segmentBound": { "type": "integer", "description": "Path is invalid if it has more segments than this value", "format": "int64" }, "teMetricBound": { "type": "integer", "description": "Path is invalid if its TE metric exceeds this value", "format": "int64" } } }, "BundledLinks1": { "title": "BundledLinks1", "type": "object", "properties": { "bundledLink": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BundledLink" } } } }, "CandidatePathConfigType1": { "title": "CandidatePathConfigType1", "type": "object", "properties": { "dynamic": { "$ref": "#/components/schemas/Dynamic2" }, "explicit": { "$ref": "#/components/schemas/Explicit2" } } }, "CandidatePathProperties1": { "title": "CandidatePathProperties1", "type": "object", "properties": { "bandwidth": { "type": "integer", "description": "Bandwidth capacity. Unit kbps. For a candidate path with multiple segment-lists, the bandiwdth value is applied to each segment list relative to the weight value associated to the segment-list", "format": "int64" }, "bsid": { "$ref": "#/components/schemas/Bsid" } } }, "CandidatePaths1": { "title": "CandidatePaths1", "type": "object", "properties": { "candidatePath": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CandidatePath" } } } }, "CandidatePathsConfig1": { "title": "CandidatePathsConfig1", "type": "object", "properties": { "candidatePath": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CandidatePathsConfigCandidatePath" } } } }, "CandidatePathType2": { "title": "CandidatePathType2", "type": "object", "properties": { "dynamicParamsConfig": { "$ref": "#/components/schemas/DynamicParamsConfig2" }, "dynamicParamsState": { "$ref": "#/components/schemas/DynamicParamsState2" }, "explicitParamsConfig": { "$ref": "#/components/schemas/ExplicitParamsConfig2" } } }, "Capacity1": { "title": "Capacity1", "type": "object", "properties": { "capacityValue": { "$ref": "#/components/schemas/CapacityValue2" } } }, "CapacityValue2": { "title": "CapacityValue2", "type": "object", "properties": { "unit": { "$ref": "#/components/schemas/Unit" }, "value": { "type": "integer", "description": "none", "format": "int32" } } }, "ClientId": { "title": "ClientId", "type": "object", "properties": { "uint32": { "type": "integer", "format": "int64" } } }, "ComponentLinks1": { "title": "ComponentLinks1", "type": "object", "properties": { "componentLink": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ComponentLink" } } } }, "ComputedHops1": { "title": "ComputedHops1", "type": "object", "properties": { "pathHops": { "$ref": "#/components/schemas/PathHops1" } } }, "Config1": { "title": "Config1", "type": "object", "properties": { "teLinkConfig": { "$ref": "#/components/schemas/TeLinkConfig1" } } }, "Config2": { "title": "Config2", "type": "object", "properties": { "teNodeConfig": { "$ref": "#/components/schemas/TeNodeConfig1" } } }, "Config3": { "title": "Config3", "type": "object", "properties": { "teNodeTunnelTerminationCapability": { "$ref": "#/components/schemas/TeNodeTunnelTerminationCapability1" } } }, "Config4": { "title": "Config4", "type": "object", "properties": { "teTerminationPointConfig": { "$ref": "#/components/schemas/TeTerminationPointConfig1" } } }, "Config5": { "title": "Config5", "type": "object", "properties": { "teTopologyConfig": { "$ref": "#/components/schemas/TeTopologyConfig1" } } }, "ConnectivityConstraint1": { "title": "ConnectivityConstraint1", "type": "object", "properties": { "capacity": { "$ref": "#/components/schemas/Capacity1" }, "connectivityDirection": { "$ref": "#/components/schemas/ConnectivityDirection" }, "schedule": { "$ref": "#/components/schemas/Schedule1" }, "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": { "$ref": "#/components/schemas/ServiceType3" } } }, "ConnectivityLabelRestrictionList1": { "title": "ConnectivityLabelRestrictionList1", "type": "object", "properties": { "labelRestriction": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LabelRestriction" } } } }, "Constraints2": { "title": "Constraints2", "type": "object", "properties": { "affinities": { "$ref": "#/components/schemas/Affinities1" } } }, "Content-Type": { "title": "Content-Type", "enum": [ "application/json" ], "type": "string" }, "Data1": { "title": "Data1", "type": "object", "properties": { "jsonFileName": { "type": "string", "description": "The json file name" } } }, "Data2": { "title": "Data2", "type": "object", "properties": { "augmentationMetaInput": { "$ref": "#/components/schemas/AugmentationMetaInput2" }, "augmentationMetaJsonFileName": { "$ref": "#/components/schemas/AugmentationMetaJsonFileName2" } } }, "Data3": { "title": "Data3", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/NspEthtSvcAccessParameters" }, "description": "" }, "ethtSvcDescr": { "type": "string", "description": "Description of the ETH transport service." }, "ethtSvcName": { "type": "string", "description": "Name of the p2p ETH transport service." }, "ethtSvcType": { "$ref": "#/components/schemas/UrlSafeString" }, "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", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "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", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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" } } }, "Data4": { "title": "Data4", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "cemUseRtpHeader": { "type": "boolean", "description": "Enable the inclusion of RTP header. It is disabled by default." }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "monitorBandwidth": { "type": "boolean", "description": "Specifies whether or not the service bandwidth should be monitored" }, "mtu": { "type": "integer", "description": "The MTU for the service. The valid values are between 0 and 9194.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "The ID of the Workflow Profile associated with the service" }, "workflowValidate": { "type": "string", "description": "Workflow to run for service validation" } } }, "Data5": { "title": "Data5", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "cemUseRtpHeader": { "type": "boolean", "description": "Enable the inclusion of RTP header. It is disabled by default." }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/TdmEndpointRequest" }, "description": "" }, "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", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data6": { "title": "Data6", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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" } } }, "Data7": { "title": "Data7", "type": "object", "properties": { "adjacencies": { "type": "array", "items": { "$ref": "#/components/schemas/Adjacency" }, "description": "" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndpointRequest" }, "description": "" }, "mtu": { "type": "integer", "description": "The MTU for the service. Must match with far-end.", "format": "int64" }, "name": { "type": "string", "description": "The name of the service" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" }, "requestedEndState": { "$ref": "#/components/schemas/RequestedEndState" }, "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": { "$ref": "#/components/schemas/VcType2" } } }, "Data8": { "title": "Data8", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autoBindType": { "$ref": "#/components/schemas/AutoBindType" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "extensionTemplate": { "$ref": "#/components/schemas/EndpointExtensionTemplate" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "monitorBandwidth": { "type": "boolean", "description": "Specifies whether or not the service bandwidth should be monitored" }, "mtu": { "type": "integer", "description": "The MTU for the service. The valid values are between 0 and 9194.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "The ID of the Workflow Profile associated with the service" }, "workflowValidate": { "type": "string", "description": "Workflow to run for service validation" } } }, "Data9": { "title": "Data9", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autoBindType": { "$ref": "#/components/schemas/AutoBindType1" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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": "#/components/schemas/L2EndpointExtensionRequest" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndpointRequest" }, "description": "" }, "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", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "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", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data10": { "title": "Data10", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autoBindType": { "$ref": "#/components/schemas/AutoBindType2" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "extensionTemplate": { "$ref": "#/components/schemas/EndpointExtensionTemplate" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "monitorBandwidth": { "type": "boolean", "description": "Specifies whether or not the service bandwidth should be monitored" }, "mtu": { "type": "integer", "description": "The MTU for the service. The valid values are between 0 and 9194.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "The ID of the Workflow Profile associated with the service" }, "workflowValidate": { "type": "string", "description": "Workflow to run for service validation" } } }, "Data11": { "title": "Data11", "type": "object", "properties": { "context": { "$ref": "#/components/schemas/Context" }, "id": { "type": "string", "description": "The local identifier used on the entity." }, "location": { "type": "array", "items": { "type": "string" }, "description": "The entity instance that is managing this external-id. This may be an IP address or a DNS name." } } }, "Data12": { "title": "Data12", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState19" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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" } } }, "Data13": { "title": "Data13", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autoBindType": { "$ref": "#/components/schemas/AutoBindType3" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpointExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndpointExtensionRequest" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndpointRequest" }, "description": "" }, "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", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data14": { "title": "Data14", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L3EndpointRequest" }, "description": "" }, "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": "#/components/schemas/LoopbackEndpointRequest" }, "description": "" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data15": { "title": "Data15", "required": [ "bidirectional", "connectivity", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autobind": { "$ref": "#/components/schemas/Autobind" }, "backhaulMtu": { "type": "integer", "description": "The MTU to used for the backhaul service connectivity", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "connectivity": { "$ref": "#/components/schemas/Connectivity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "dcEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L3DcEndpointRequest" }, "description": "" }, "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", "description": "Maximum ECMP configuration to deploy on the service for tunnel binding", "format": "int64" }, "encryption": { "type": "boolean", "description": "Specifies whether or not Network Group Encryption is enabled for the service" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/L3EndpointRequest" }, "description": "" }, "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": "#/components/schemas/LoopbackEndpointRequest" }, "description": "" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data16": { "title": "Data16", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autobind": { "$ref": "#/components/schemas/Autobind" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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": "#/components/schemas/L3EndpointNormalizedRequest" }, "description": "" }, "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": "#/components/schemas/LoopbackEndpointRequest" }, "description": "" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data17": { "title": "Data17", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "autobind": { "$ref": "#/components/schemas/Autobind" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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": "#/components/schemas/L3EndpointRequest" }, "description": "" }, "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": "#/components/schemas/LoopbackEndpointRequest" }, "description": "" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data18": { "title": "Data18", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/LatencyUploadPolicy" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "srlgUploadPolicy": { "$ref": "#/components/schemas/SrlgUploadPolicy" } } }, "Data19": { "title": "Data19", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autobind": { "$ref": "#/components/schemas/Autobind3" }, "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", "description": "Maximum ECMP configuration to deploy on the service for tunnel binding", "format": "int64" }, "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "nameGenerationMaxLength": { "type": "integer", "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", "format": "int64" }, "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" } } }, "Data20": { "title": "Data20", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/EncapType" }, "id": { "type": "string", "description": "The UUID of the port" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "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", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portMode": { "$ref": "#/components/schemas/PortMode" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" }, "siteServiceQosProfile": { "$ref": "#/components/schemas/SiteServiceQosProfile1" } } }, "Data21": { "title": "Data21", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState9" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "description": "The maximum latency. The value must be greater than or equal to 0." }, "meta": { "type": "array", "items": { "type": "string" }, "description": "Meta data associated with template" }, "monitorBandwidth": { "type": "boolean", "description": "Specifies whether or not the service bandwidth should be monitored" }, "mtu": { "type": "integer", "description": "The MTU for the service. The valid values are between 0 and 9194.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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": { "$ref": "#/components/schemas/VcType" }, "workflowProfileId": { "type": "string", "description": "The ID of the Workflow Profile associated with the service" }, "workflowValidate": { "type": "string", "description": "Workflow to run for service validation" } } }, "Data22": { "title": "Data22", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState19" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autobind": { "$ref": "#/components/schemas/Autobind3" }, "backhaulMtu": { "type": "integer", "description": "The MTU to used for the backhaul service connectivity", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "connectivity": { "$ref": "#/components/schemas/Connectivity" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "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", "description": "Maximum ECMP configuration to deploy on the service for tunnel binding", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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" } } }, "Data23": { "title": "Data23", "required": [ "name" ], "type": "object", "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", "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", "format": "int64" }, "maxAssignedForRt": { "type": "integer", "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", "format": "int64" }, "maxAssignedForRtExtranet": { "type": "integer", "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", "format": "int64" }, "minAssignedForRd": { "type": "integer", "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", "format": "int64" }, "minAssignedForRt": { "type": "integer", "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", "format": "int64" }, "minAssignedForRtExtranet": { "type": "integer", "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", "format": "int64" }, "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": { "$ref": "#/components/schemas/PolicyType" }, "rdAS": { "type": "integer", "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", "format": "int64" }, "rdType": { "type": "integer", "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", "format": "int32" }, "rtAS": { "type": "integer", "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", "format": "int64" }, "rtExtranetAS": { "type": "integer", "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", "format": "int64" }, "rtExtranetType": { "type": "integer", "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", "format": "int32" }, "rtType": { "type": "integer", "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", "format": "int32" } } }, "Data24": { "title": "Data24", "required": [ "name" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState19" }, "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "autobind": { "$ref": "#/components/schemas/Autobind3" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "innerTag": { "type": "integer", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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", "items": { "type": "string" }, "description": "Meta data associated with template" }, "mtu": { "type": "integer", "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.", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "portFilter": { "type": "array", "items": { "$ref": "#/components/schemas/PortFilter" }, "description": "" }, "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" } } }, "Data25": { "title": "Data25", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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", "items": { "type": "string" }, "description": "A list of destination service endpoints" }, "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": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "facility": { "type": "integer", "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", "format": "int32" }, "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": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "lambda": { "type": "number", "description": "Unsupported - Specifies the lambda to be used for the service" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "modulation": { "$ref": "#/components/schemas/Modulation" }, "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", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "pathProfileId": { "type": "string", "description": "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "phaseEncoding": { "$ref": "#/components/schemas/PhaseEncoding" }, "protection": { "type": "boolean", "description": "Unsupported - Specifies whether a protection path should be created" }, "protectionExcludeRouteObject": { "type": "array", "items": { "$ref": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "protectionIncludeRouteObject": { "type": "array", "items": { "$ref": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "protectionType": { "$ref": "#/components/schemas/ProtectionType" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "restoration": { "$ref": "#/components/schemas/Restoration" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "reversionMode": { "$ref": "#/components/schemas/ReversionMode" }, "servicePlaneType": { "$ref": "#/components/schemas/ServicePlaneType" }, "sourceTimeslot": { "type": "string", "description": "Applies timeslots to the port represented in a comma seperated value" }, "sources": { "type": "array", "items": { "type": "string" }, "description": "A list of source service endpoints" }, "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": { "$ref": "#/components/schemas/Waveshape" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data26": { "title": "Data26", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bandwidth": { "type": "integer", "description": "Specifies the bandwidth required for LAG service creation", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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": { "$ref": "#/components/schemas/Objective3" }, "reverseBandwidth": { "type": "integer", "description": "Specifies the reverse bandwidth required for LAG service creation", "format": "int64" } } }, "Data27": { "title": "Data27", "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": "#/components/schemas/TwampTest" }, "description": "" } } }, "Data28": { "title": "Data28", "type": "object", "properties": { "accessType": { "$ref": "#/components/schemas/AccessType1" }, "adminStatus": { "$ref": "#/components/schemas/AdminStatus1" }, "administrativeGroup": { "$ref": "#/components/schemas/AdministrativeGroup" }, "igpMetric": { "type": "integer", "description": "IGP topology Metric", "format": "int32" }, "isAbstract": { "type": "object", "description": "Present if the link is abstract" }, "latency": { "type": "number", "description": "Delay or latency in micro seconds. The value must be greater than or equal to 0" }, "maxResvLinkBandwidth": { "type": "integer", "description": "Maximum amount of bandwidth that can be reserved in this direction in this link. Units in kbps", "format": "int64" }, "measuredIpBw": { "type": "number", "description": "Measured IP bandwidth. Units in Mbps. The value must be greater than or equal to 0" }, "measuredMplsBw": { "type": "number", "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", "items": { "$ref": "#/components/schemas/Srlg" }, "description": "A list of SRLG values" }, "teMetric": { "type": "integer", "description": "Traffic Engineering Metric", "format": "int64" }, "unreservedBandwidth": { "type": "integer", "description": "Unreserved bandwidth. Units in kbps", "format": "int64" } } }, "Data29": { "title": "Data29", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/PrimaryAddress" }, "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." } } }, "Data30": { "title": "Data30", "required": [ "neId", "pathName" ], "type": "object", "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": { "$ref": "#/components/schemas/ServiceType1" }, "templateId": { "type": "string", "description": "The identifier of the template associated to the augmentation." } } }, "Data31": { "title": "Data31", "required": [ "name" ], "type": "object", "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": "#/components/schemas/MediationInfo" }, "description": "" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "profileType": { "$ref": "#/components/schemas/ProfileType" } } }, "Data32": { "title": "Data32", "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" } } }, "Data33": { "title": "Data33", "type": "object", "properties": { "accessLtpId": { "$ref": "#/components/schemas/AccessLtpId" }, "accessNodeId": { "$ref": "#/components/schemas/AccessNodeId" }, "bandwidthProfiles": { "$ref": "#/components/schemas/BandwidthProfiles2" }, "baseEndpointRequest": { "$ref": "#/components/schemas/BaseEndpointRequest2" }, "outerTag": { "$ref": "#/components/schemas/OuterTag1" }, "secondTag": { "$ref": "#/components/schemas/SecondTag1" }, "serviceClassificationType": { "type": "object", "description": "Service classification." }, "splitHorizonGroup": { "type": "string", "description": "Identify a split horizon group" }, "vlanOperations": { "$ref": "#/components/schemas/NspEthtSvcAccessParametersVlanOperations" } } }, "Data34": { "title": "Data34", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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": { "$ref": "#/components/schemas/Objective3" }, "restoration": { "$ref": "#/components/schemas/Restoration" }, "reversionMode": { "$ref": "#/components/schemas/ReversionMode" } } }, "Data35": { "title": "Data35", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bandwidth": { "type": "integer", "description": "Specifies the bandwidth required for ODU creation", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional3" }, "customerId": { "type": "integer", "description": "The ID of a customer associated with service", "format": "int64" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "maxCost": { "type": "number", "description": "The maximum cost. The value must be greater than or equal to 0." }, "maxHops": { "type": "integer", "description": "The maximum hops. The value must be greater than or equal to 0.", "format": "int32" }, "maxLatency": { "type": "number", "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": { "$ref": "#/components/schemas/Objective3" }, "reverseBandwidth": { "type": "integer", "description": "Specifies the reverse bandwidth required for ODU creation", "format": "int64" } } }, "Data36": { "title": "Data36", "type": "object", "properties": { "flowIds": { "type": "array", "items": { "type": "string" }, "description": "List of flows' unique identifers" } } }, "Data37": { "title": "Data37", "required": [ "datapathId" ], "type": "object", "properties": { "applicationGroupId": { "type": "integer", "description": "The identification of the application group, used by the application to categorize this flow", "format": "int64" }, "applicationId": { "type": "integer", "description": "The identification number of the application which deployed the flow", "format": "int32" }, "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": { "$ref": "#/components/schemas/OpenflowMatch1" }, "priority": { "type": "integer", "description": "The priority of the flow", "format": "int64" }, "tableId": { "type": "integer", "description": "The table id number within the switch", "format": "int64" } } }, "Data38": { "title": "Data38", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "connectivityConstraint": { "$ref": "#/components/schemas/ConnectivityConstraint1" }, "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" } } }, "Data39": { "title": "Data39", "required": [ "name" ], "type": "object", "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", "items": { "type": "string" }, "description": "Resilience constraint template ids" }, "routingConstraintTemplateId": { "type": "string", "description": "Routing constraint template id" } } }, "Data40": { "title": "Data40", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/ResilienceConstraint2" } } }, "Data41": { "title": "Data41", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/RoutingConstraint2" } } }, "Data42": { "title": "Data42", "required": [ "bidirectional", "name", "objective" ], "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "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", "items": { "type": "string" }, "description": "A list of destination service endpoints" }, "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": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "facility": { "type": "integer", "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", "format": "int32" }, "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": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "lambda": { "type": "number", "description": "Unsupported - Specifies the lambda to be used for the service" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "modulation": { "$ref": "#/components/schemas/Modulation" }, "name": { "type": "string", "description": "Specifies the name of the service" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service (Optional). Not applicable for multi-domain services.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "pathProfileId": { "type": "string", "description": "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "phaseEncoding": { "$ref": "#/components/schemas/PhaseEncoding" }, "protection": { "type": "boolean", "description": "Unsupported - Specifies whether a protection path should be created" }, "protectionExcludeRouteObject": { "type": "array", "items": { "$ref": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "protectionIncludeRouteObject": { "type": "array", "items": { "$ref": "#/components/schemas/NspOpticsExplicitRoute" }, "description": "" }, "protectionType": { "$ref": "#/components/schemas/ProtectionType" }, "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": { "$ref": "#/components/schemas/RequestedEndState" }, "restoration": { "$ref": "#/components/schemas/Restoration" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "reversionMode": { "$ref": "#/components/schemas/ReversionMode" }, "servicePlaneType": { "$ref": "#/components/schemas/ServicePlaneType" }, "sourceTimeslot": { "type": "string", "description": "Applies timeslots to the port represented in a comma seperated value" }, "sources": { "type": "array", "items": { "type": "string" }, "description": "A list of source service endpoints" }, "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": { "$ref": "#/components/schemas/Waveshape" }, "workflowProfileId": { "type": "string", "description": "Specifies the Workflow Profile to used for this service" } } }, "Data43": { "title": "Data43", "required": [ "name", "profileId" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bandwidthStrategy": { "$ref": "#/components/schemas/BandwidthStrategy" }, "bidirection": { "$ref": "#/components/schemas/Bidirection" }, "bwSplitMonitoringTime": { "type": "integer", "description": "Time in seconds to watch measured bandwidth before sending LSP split trigger", "format": "int32" }, "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", "format": "int32" }, "bwSplitWorkflowName": { "type": "string", "description": "The name of workflow for LSP bandwidth split" }, "controlRerouteStrategy": { "$ref": "#/components/schemas/ControlRerouteStrategy" }, "disjoint": { "$ref": "#/components/schemas/Disjoint" }, "excludeRouteObjects": { "type": "array", "items": { "$ref": "#/components/schemas/IpAddress" }, "description": "The hops to be excluded from the path" }, "explicitRouteStrategy": { "$ref": "#/components/schemas/ExplicitRouteStrategy" }, "explicitRouteStrategyEcmpPreference": { "$ref": "#/components/schemas/ExplicitRouteStrategyEcmpPreference" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "includeRouteObjects": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IroHop" } }, "latencyThreshold": { "type": "number", "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", "description": "The Max Cost constraint to be used in path computation", "format": "int64" }, "maxHops": { "type": "integer", "description": "The Max Hops constraint to be used in path computation", "format": "int64" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in microseconds) to consider for the path calculation" }, "maxTeMetric": { "type": "integer", "description": "The Max TE Metric constraint to be used in the path computation", "format": "int64" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "objective": { "$ref": "#/components/schemas/Objective23" }, "profileId": { "type": "integer", "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", "format": "int64" }, "sidProtectionStrategy": { "$ref": "#/components/schemas/SidProtectionStrategy" } } }, "Data44": { "title": "Data44", "required": [ "uuid" ], "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Destination2" }, "erpInstance": { "type": "integer", "description": "The Instance number of ERP", "format": "int64" }, "minBandwidth": { "type": "integer", "description": "The minimum bandwidth to maintain for the service", "format": "int64" }, "source": { "$ref": "#/components/schemas/Source7" }, "uuid": { "type": "string", "description": "The UUID of the service" }, "vlanId": { "$ref": "#/components/schemas/VlanId2" } } }, "Data45": { "title": "Data45", "type": "object", "properties": { "protectionType": { "$ref": "#/components/schemas/ProtectionType5" } } }, "Data46": { "title": "Data46", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "egressCosMappingTable": { "type": "array", "items": { "$ref": "#/components/schemas/CosMapping" }, "description": "" }, "egressParam": { "$ref": "#/components/schemas/EgressParam2" }, "egressPolicyList": { "type": "array", "items": { "type": "string" }, "description": "The list of policy names as discovered from the network element. These policies don't need to be discovered yet." }, "egressQueueConfigurationTable": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "ingressCosMappingTable": { "type": "array", "items": { "$ref": "#/components/schemas/CosMapping" }, "description": "" }, "ingressParam": { "$ref": "#/components/schemas/IngressParam2" }, "ingressPolicyList": { "type": "array", "items": { "type": "string" }, "description": "The list of policy names as discovered from the network element. These policies don't need to be discovered yet." }, "ingressQueueConfigurationTable": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" } } }, "Data47": { "title": "Data47", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "egressParam": { "$ref": "#/components/schemas/EgressParam2" }, "egressQueueOverride": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the template" }, "ingressParam": { "$ref": "#/components/schemas/IngressParam2" }, "ingressQueueOverride": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "name": { "type": "string", "description": "The name of the template" }, "objectDescription": { "type": "string", "description": "The description for this object" }, "qosProfile": { "type": "integer", "description": "The ID of the default Generic QoS profile associated with the quality of service template", "format": "int64" } } }, "Data48": { "title": "Data48", "required": [ "name", "systemId" ], "type": "object", "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": { "$ref": "#/components/schemas/PccAddress" }, "routerInfos": { "type": "array", "items": { "$ref": "#/components/schemas/RouterInfo" }, "description": "" }, "systemId": { "$ref": "#/components/schemas/SystemId" }, "systemName": { "type": "string", "description": "The system name." } } }, "Data49": { "title": "Data49", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/ReversionPolicy2" }, "switchPolicy": { "$ref": "#/components/schemas/SwitchPolicy2" } } }, "Data50": { "title": "Data50", "type": "object", "properties": { "availableBw": { "type": "integer", "description": "Specifies the available bandwidth on the service", "format": "int64" }, "ownership": { "$ref": "#/components/schemas/Ownership" }, "steeringParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" } } }, "Data51": { "title": "Data51", "required": [ "policyEnabled" ], "type": "object", "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" } } }, "Data52": { "title": "Data52", "required": [ "name" ], "type": "object", "properties": { "name": { "$ref": "#/components/schemas/UrlSafeString" } } }, "Data53": { "title": "Data53", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/SiteServiceQosProfile1" }, "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" } } }, "Data54": { "title": "Data54", "type": "object", "properties": { "bundledLinks": { "$ref": "#/components/schemas/BundledLinks1" }, "componentLinks": { "$ref": "#/components/schemas/ComponentLinks1" }, "teLinkAttributes": { "$ref": "#/components/schemas/TeLinkAttributes1" }, "teLinkTemplate": { "type": "array", "items": { "type": "string" }, "description": "The reference to a TE link template." }, "template": { "type": "object", "description": "This feature indicates that the system supports template configuration." } } }, "Data55": { "title": "Data55", "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", "description": "The customer-id associated with the tenant", "format": "int64" }, "phoneNumber": { "type": "string", "description": "The phone number for the tenant" } } }, "Data56": { "title": "Data56", "required": [ "tenantName" ], "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", "description": "The customer-id associated with the tenant. This is optional and default value is 1", "format": "int64" }, "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" } } }, "Data57": { "title": "Data57", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Toggle whether NSP traffic collection is enabled or not." }, "flowCollection": { "$ref": "#/components/schemas/FlowCollection1" }, "linkBwTargetThreshold": { "type": "integer", "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.", "format": "int32" }, "linkBwTriggerThreshold": { "type": "integer", "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.", "format": "int32" }, "source": { "$ref": "#/components/schemas/Source1" } } }, "Data58": { "title": "Data58", "required": [ "name" ], "type": "object", "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": { "$ref": "#/components/schemas/ProtectionType6" } } }, "Data59": { "title": "Data59", "required": [ "name" ], "type": "object", "properties": { "appId": { "type": "string", "description": "The client-defined custom Application ID for this object" }, "bgpPriority": { "type": "integer", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "looseRsvpPriority": { "type": "integer", "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]", "format": "int32" }, "looseSrTePriority": { "type": "integer", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "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", "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]", "format": "int32" }, "pccInitiatedSrTePriority": { "type": "integer", "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]", "format": "int32" }, "protection": { "type": "boolean", "description": "Specifies whether or not the tunnel has a protection path. Only applicable when creating a new LSP" }, "protectionType": { "$ref": "#/components/schemas/ProtectionType7" }, "shouldAvoidOperStateDown": { "type": "boolean", "description": "Specifies whether or not the policy should avoid resource which their operational state is down" }, "srIsisPriority": { "type": "integer", "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]", "format": "int32" }, "srOspfPriority": { "type": "integer", "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]", "format": "int32" }, "steeringParametersExcluded": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" }, "steeringParametersIncluded": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" }, "strictRsvpPriority": { "type": "integer", "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]", "format": "int32" }, "strictSrTePriority": { "type": "integer", "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]", "format": "int32" }, "targetIpAddressInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/TargetIpAddressInfo" }, "description": "" } } }, "Data60": { "title": "Data60", "required": [ "name" ], "type": "object", "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": "#/components/schemas/WorkflowProfileInfo" }, "description": "" } } }, "Data62": { "title": "Data62", "type": "object", "properties": { "expires": { "type": "integer", "description": "Specifies the expiry date of the token in milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" }, "description": "The role(s) this User has relative to their Tenant" }, "tenant": { "$ref": "#/components/schemas/Tenant2" }, "user": { "$ref": "#/components/schemas/User2" } } }, "Data63": { "title": "Data63", "required": [ "bidirectional", "objective" ], "type": "object", "properties": { "actualEndState": { "$ref": "#/components/schemas/ActualEndState" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional1" }, "bw": { "type": "integer", "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)", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "endpointExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndPointExtension" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/BaseServiceEndpoint" }, "description": "" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "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": { "$ref": "#/components/schemas/LifeCycle3" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "name": { "type": "string", "description": "The name of the service" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service. Populated only when same node service identifier is used across all sites.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "pathProfileId": { "type": "string", "description": "Specifies the identifier of the path profile to apply to the service. This only applies to optical services" }, "requestedEndState": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "serviceType": { "$ref": "#/components/schemas/ServiceType1" }, "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." } } }, "Data66": { "title": "Data66", "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", "description": "The unique identifier for the customer", "format": "int64" }, "phoneNumber": { "type": "string", "description": "The phone number for the customer" } } }, "Data78": { "title": "Data78", "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Destination2" }, "linkId": { "$ref": "#/components/schemas/LinkId2" }, "nspLink": { "$ref": "#/components/schemas/NspLink2" }, "source": { "$ref": "#/components/schemas/Source7" }, "supportingLink": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SupportingLink" } } } }, "Data79": { "title": "Data79", "type": "object", "properties": { "administrativeFailureErrorCode": { "$ref": "#/components/schemas/AdministrativeFailureErrorCode" }, "administrativeState": { "$ref": "#/components/schemas/AdministrativeState" }, "computationState": { "$ref": "#/components/schemas/ComputationState" }, "computedHops": { "$ref": "#/components/schemas/ComputedHops1" }, "creationType": { "$ref": "#/components/schemas/CreationType" }, "destinationAddress": { "$ref": "#/components/schemas/DestinationAddress" }, "destinationId": { "type": "string", "description": "ID: Unique identifier of the destination topology link/tp" }, "destinationNetworkName": { "type": "array", "items": { "type": "string" }, "description": "Path destination network topology name" }, "latency": { "type": "number", "description": "Path latency" }, "lifecycleState": { "$ref": "#/components/schemas/LifecycleState" }, "lspId": { "type": "string", "description": "ID: Unique identifier of the parent LSP" }, "maintenanceAffected": { "$ref": "#/components/schemas/MaintenanceAffected" }, "operationalState": { "$ref": "#/components/schemas/OperationalState7" }, "ownershipState": { "$ref": "#/components/schemas/OwnershipState2" }, "paramsConfig": { "$ref": "#/components/schemas/ParamsConfig1" }, "paramsState": { "$ref": "#/components/schemas/ParamsState2" }, "pathErrorCode": { "$ref": "#/components/schemas/PathErrorCode" }, "pathId": { "type": "string", "description": "ID: Unique identifier of the path" }, "pathName": { "type": "string", "description": "Path name" }, "pathType": { "$ref": "#/components/schemas/PathType" }, "protectionState": { "$ref": "#/components/schemas/ProtectionState" }, "protectionType": { "$ref": "#/components/schemas/ProtectionType1" }, "provisionedHops": { "$ref": "#/components/schemas/ProvisionedHops2" }, "recordedHops": { "$ref": "#/components/schemas/RecordedHops2" }, "sourceAddress": { "$ref": "#/components/schemas/SourceAddress" }, "sourceId": { "type": "string", "description": "ID: Unique identifier of the source topology link/tp" }, "sourceNetworkName": { "type": "array", "items": { "type": "string" }, "description": "Path source network topology name" }, "sourceRouterAddress": { "$ref": "#/components/schemas/SourceRouterAddress" }, "tunnelId": { "type": "integer", "description": "Path tunnel identifier", "format": "int64" } } }, "Data80": { "title": "Data80", "type": "object", "properties": { "externalId": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/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", "format": "int32" }, "paths": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LspPath" } }, "tunnelId": { "type": "integer", "description": "LSP tunnel identifier", "format": "int64" } } }, "Data82": { "title": "Data82", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "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": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "items": { "type": "string" }, "description": "The custom properties of the network element" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "geoLocation": { "$ref": "#/components/schemas/GeoLocation1" }, "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": { "$ref": "#/components/schemas/NeDeploymentState" }, "nspDbFdn": { "type": "string", "description": "FDN of the network element used for this object in the NSP DB" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "platform": { "$ref": "#/components/schemas/Platform2" }, "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" } } }, "Data83": { "title": "Data83", "type": "object", "properties": { "link": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Link" } }, "networkId": { "$ref": "#/components/schemas/NetworkId2" }, "networkTypes": { "type": "object", "description": "Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container." }, "node": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Node" } }, "nspNetwork": { "$ref": "#/components/schemas/NspNetwork2" }, "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" }, "description": "" } } }, "Data91": { "title": "Data91", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "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": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "linkCost": { "$ref": "#/components/schemas/LinkCost" }, "lxcontainer": { "$ref": "#/components/schemas/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": { "$ref": "#/components/schemas/NeDeploymentState" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "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" }, "description": "" } } }, "Data92": { "title": "Data92", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "availableEgressBandwidth": { "type": "integer", "description": "Specifies the available egress bandwidth associated with a port", "format": "int64" }, "availableIngressBandwidth": { "type": "integer", "description": "Specifies the available ingress bandwidth associated with a port", "format": "int64" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": { "$ref": "#/components/schemas/Dc1" }, "description": { "type": "string", "description": "A textual description of the port." }, "ethernet": { "$ref": "#/components/schemas/Ethernet1" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "interfaceId": { "type": "integer", "description": "The id of the port/interface", "format": "int64" }, "name": { "type": "string", "description": "The name of the port" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "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": { "$ref": "#/components/schemas/OperationalState" }, "optics": { "$ref": "#/components/schemas/Optics1" }, "portCapability": { "$ref": "#/components/schemas/PortCapabilityType" }, "portSpeed": { "type": "integer", "description": "The interface speed of the port", "format": "int64" }, "portType": { "type": "string", "description": "The type of port. Supported values are defined in RFC7224" }, "role": { "$ref": "#/components/schemas/Role1" }, "tdm": { "$ref": "#/components/schemas/Tdm2" } } }, "Data97": { "title": "Data97", "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" } } }, "Data98": { "title": "Data98", "type": "object", "properties": { "baseServiceHierarchy": { "$ref": "#/components/schemas/BaseServiceHierarchy1" } } }, "Data99": { "title": "Data99", "required": [ "bidirectional", "objective" ], "type": "object", "properties": { "actualEndState": { "$ref": "#/components/schemas/ActualEndState" }, "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "availableBw": { "type": "integer", "description": "Specifies the available bandwidth on the service", "format": "int64" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional1" }, "bw": { "type": "integer", "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)", "format": "int64" }, "cost": { "type": "number", "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": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The ID of a customer associated with service", "format": "int64" }, "description": { "type": "string", "description": "A textual description of the service." }, "destinationEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTunnelEndpoint" }, "description": "" }, "destinationNodeId": { "$ref": "#/components/schemas/DestinationNodeId" }, "endpointExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/L2EndPointExtension" }, "description": "" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/BaseServiceEndpoint" }, "description": "" }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalId" }, "description": "" }, "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", "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.", "format": "int32" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "latency": { "type": "number", "description": "The latency of the tunnel in microseconds. The value of 2147483647 indicates infinite latency on the tunnel." }, "lifeCycle": { "$ref": "#/components/schemas/LifeCycle3" }, "maxCost": { "type": "number", "description": "Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services" }, "maxHops": { "type": "integer", "description": "Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services", "format": "int32" }, "maxLatency": { "type": "number", "description": "Specifies the maximum latency (in ms) to consider for the service." }, "name": { "type": "string", "description": "The name of the service" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "nodeServiceId": { "type": "integer", "description": "Specifies the node identifier of the service. Populated only when same node service identifier is used across all sites.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "ownership": { "$ref": "#/components/schemas/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": "#/components/schemas/PhysicalLink" }, "description": "" }, "requestedEndState": { "$ref": "#/components/schemas/RequestedEndState" }, "reverseBW": { "type": "integer", "description": "Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services", "format": "int64" }, "serviceType": { "$ref": "#/components/schemas/ServiceType1" }, "sourceEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTunnelEndpoint" }, "description": "" }, "sourceNodeId": { "$ref": "#/components/schemas/SourceNodeId" }, "steeringParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SteeringParameter" }, "description": "" }, "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": { "$ref": "#/components/schemas/TunnelType" }, "underlyingTransport": { "$ref": "#/components/schemas/UnderlyingTransport" } } }, "Data105": { "title": "Data105", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The usergroup name" } } }, "Data108": { "title": "Data108", "type": "object", "properties": { "defaultSourceIpAddress": { "$ref": "#/components/schemas/DefaultSourceIpAddress" } } }, "Data109": { "title": "Data109", "type": "object", "properties": { "deviceNamePriority": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeviceNamePriority" } }, "externalMapping": { "type": "boolean", "description": "Enable/Disable external ip address and device name mapping service" }, "priorityEnabled": { "type": "boolean", "description": "Enable/Disable apps ip address and device name write priority" } } }, "Data110": { "title": "Data110", "type": "object", "properties": { "deploymentType": { "$ref": "#/components/schemas/DeploymentType" }, "enabled": { "type": "boolean", "description": "Toggle whether NRCP should support LSP BSID generation." } } }, "Data111": { "title": "Data111", "type": "object", "properties": { "pathType": { "$ref": "#/components/schemas/PathType2" }, "sourceAddress": { "$ref": "#/components/schemas/SourceAddress" }, "tunnelId": { "type": "integer", "description": "Path tunnel identifier", "format": "int64" } } }, "Data112": { "title": "Data112", "type": "object", "properties": { "areaId": { "type": "array", "items": { "type": "string" }, "description": "" }, "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": { "$ref": "#/components/schemas/NodeId1" }, "operStatus": { "$ref": "#/components/schemas/OperStatus1" }, "srStartLabel": { "type": "integer", "description": "MPLS label range start value", "format": "int64" } } }, "Data113": { "title": "Data113", "type": "object", "properties": { "historicalIgpTopologyEnabled": { "type": "boolean", "description": "Toggle whether NRCP should publish IGP topology events for historical use or not. The NRCP Historical Application will consume the messages and persist records to the database." }, "historicalLspStatsEnabled": { "type": "boolean", "description": "Toggle whether NRCP should publish LSP statistics events for historical use or not. The NRCP Historical Application will consume the messages and persist records to the database." }, "historicalPathEnabled": { "type": "boolean", "description": "Toggle whether NRCP should publish LSP path events for historical use or not. The NRCP Historical Application will consume the messages and persist records to the database." } } }, "Data114": { "title": "Data114", "required": [ "destinationAddress", "sourceAddress" ], "type": "object", "properties": { "destinationAddress": { "$ref": "#/components/schemas/DestinationAddress" }, "pathRequest": { "$ref": "#/components/schemas/PathRequest1" }, "pathType": { "$ref": "#/components/schemas/PathType3" }, "secondaryDestinationAddress": { "$ref": "#/components/schemas/SecondaryDestinationAddress" }, "secondarySourceAddress": { "$ref": "#/components/schemas/SecondarySourceAddress" }, "sourceAddress": { "$ref": "#/components/schemas/SourceAddress" } } }, "Data115": { "title": "Data115", "type": "object", "properties": { "bsidGenerationEnabled": { "type": "boolean", "description": "Toggle whether automatic BSID generation feature is permitted. This can be used to disable auto generation of SR Policies that may occur during label stack compression scenarios" }, "defaultBsidRangeEnd": { "type": "integer", "description": "Default end value of binding SID range", "format": "int32" }, "defaultBsidRangeStart": { "type": "integer", "description": "Default start value of binding SID range", "format": "int32" }, "defaultColorRangeEnd": { "type": "integer", "description": "Default end value of color range", "format": "int64" }, "defaultColorRangeStart": { "type": "integer", "description": "Default start value of color range", "format": "int64" }, "deploymentType": { "$ref": "#/components/schemas/DeploymentType1" } } }, "Data116": { "title": "Data116", "type": "object", "properties": { "adjacencySegmentId": { "$ref": "#/components/schemas/AdjacencySegmentId1" }, "adjacencySegmentIdData": { "$ref": "#/components/schemas/AdjacencySegmentIdData1" }, "areaIds": { "type": "array", "items": { "type": "string" }, "description": "Identify the area in the network" }, "isisLevel": { "$ref": "#/components/schemas/IsisLevel" }, "prefixSid": { "$ref": "#/components/schemas/PrefixSid" }, "tpId": { "$ref": "#/components/schemas/TpId3" } } }, "Data118": { "title": "Data118", "type": "object", "properties": { "associationGroupDiversity": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationGroupDiversityObject" }, "description": "" }, "associationGroupPolicy": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationGroupPolicyObject" }, "description": "" } } }, "Data119": { "title": "Data119", "type": "object", "properties": { "candidatePaths": { "$ref": "#/components/schemas/CandidatePaths1" } } }, "Data122": { "title": "Data122", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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": "#/components/schemas/ExternalId" }, "description": "" }, "id": { "type": "string", "description": "The unique identifier of the entity" }, "name": { "type": "string", "description": "The name of the multipoint link" }, "neDeploymentState": { "$ref": "#/components/schemas/NeDeploymentState" }, "operationalState": { "$ref": "#/components/schemas/OperationalState" }, "ports": { "type": "array", "items": { "$ref": "#/components/schemas/MultilinkPortInfo" }, "description": "" } } }, "Data124": { "title": "Data124", "type": "object", "properties": { "avoidedResources": { "type": "array", "items": { "$ref": "#/components/schemas/AvoidedData" }, "description": "" }, "errorMsg": { "type": "string", "description": "Error message" }, "pathSearchBehaviorsInvoked": { "type": "array", "items": { "$ref": "#/components/schemas/PathSearchBehaviorsInvoked" }, "description": "A list of behaviors invoked on the path during the last path calculation" }, "paths": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PointToPointPathData" } }, "rejections": { "type": "array", "items": { "$ref": "#/components/schemas/RejectionRunData" }, "description": "" } } }, "Data125": { "title": "Data125", "type": "object", "properties": { "policies": { "$ref": "#/components/schemas/Policies1" } } }, "Data127": { "title": "Data127", "type": "object", "properties": { "errorReports": { "$ref": "#/components/schemas/ErrorReports" }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Descriptive message of one or many errors" } } }, "Dc1": { "title": "Dc1", "type": "object", "properties": { "l3DomainTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/L3DcDomainTemplate" }, "description": "" } } }, "DefaultSourceIpAddress": { "title": "DefaultSourceIpAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "Destination1": { "title": "Destination1", "type": "object", "properties": { "ipv4Prefix": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Prefix": { "$ref": "#/components/schemas/UrlSafeString" } } }, "Destination2": { "title": "Destination2", "required": [ "destNode" ], "type": "object", "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." } } }, "DestinationAddress": { "title": "DestinationAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "DestinationNodeId": { "title": "DestinationNodeId", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "DestIpAddress": { "title": "DestIpAddress", "type": "object", "properties": { "ipv4Prefix": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Prefix": { "$ref": "#/components/schemas/UrlSafeString" } } }, "Dscp1": { "title": "Dscp1", "type": "object", "properties": { "uint8": { "type": "integer", "format": "int32" } } }, "Dynamic2": { "title": "Dynamic2", "type": "object", "properties": { "dynamicPathProperties": { "$ref": "#/components/schemas/DynamicPathProperties1" } } }, "DynamicParamsConfig2": { "title": "DynamicParamsConfig2", "type": "object", "properties": { "dynamicPathProperties": { "$ref": "#/components/schemas/DynamicPathProperties1" } } }, "DynamicParamsState2": { "title": "DynamicParamsState2", "type": "object", "properties": { "dynamicPathProperties": { "$ref": "#/components/schemas/DynamicPathProperties1" } } }, "DynamicPathProperties1": { "title": "DynamicPathProperties1", "type": "object", "properties": { "bounds": { "$ref": "#/components/schemas/Bounds1" }, "constraints": { "$ref": "#/components/schemas/Constraints2" }, "objective": { "$ref": "#/components/schemas/Objective3" }, "pathProfileId": { "type": "integer", "description": "Path profile identifier", "format": "int64" }, "sidDataplaneType": { "$ref": "#/components/schemas/SidDataplaneType" } } }, "Egress2": { "title": "Egress2", "type": "object", "properties": { "vlanOperations": { "$ref": "#/components/schemas/VlanOperations1" } } }, "EgressParam2": { "title": "EgressParam2", "type": "object", "properties": { "tier1Scheduler": { "$ref": "#/components/schemas/Tier1Scheduler1" } } }, "Ethernet1": { "title": "Ethernet1", "type": "object", "properties": { "encapType": { "$ref": "#/components/schemas/EncapType" }, "lag": { "$ref": "#/components/schemas/Lag2" }, "lldpConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/LldpConfigurationInfo" }, "description": "" }, "lldpRemotePeers": { "type": "array", "items": { "$ref": "#/components/schemas/LldpRemotePeerInfo" }, "description": "" }, "portMode": { "$ref": "#/components/schemas/PortMode1" } } }, "ExcludeAny": { "title": "ExcludeAny", "type": "object", "properties": { "adminGroup": { "$ref": "#/components/schemas/AdminGroup1" }, "extendedAdminGroup": { "$ref": "#/components/schemas/ExtendedAdminGroup2" } } }, "Explicit2": { "title": "Explicit2", "type": "object", "properties": { "segmentListsConfigRequest": { "$ref": "#/components/schemas/SegmentListsConfigRequest2" } } }, "ExplicitParamsConfig2": { "title": "ExplicitParamsConfig2", "type": "object", "properties": { "explicitPathProperties": { "$ref": "#/components/schemas/ExplicitPathProperties2" } } }, "ExplicitPathProperties2": { "title": "ExplicitPathProperties2", "type": "object", "properties": { "segmentLists": { "$ref": "#/components/schemas/SegmentLists3" } } }, "ExplicitRouteStrategyBsidSettings1": { "title": "ExplicitRouteStrategyBsidSettings1", "type": "object", "properties": { "emplacementPreference": { "$ref": "#/components/schemas/EmplacementPreference" }, "runPermutation": { "type": "boolean", "description": "A given strategy made have various potential permutations on where a BSID made be placed to achieve label stack reduction. For example, in a multi area topology with an area splitting strategy the algorithm may have an option to place a BSID in Area 1, or Area 0, or both. When the value is set to false, the computation will program a BSID in all split areas feasible. When the value is set to true, the computation will attempt different permutations and determine a subset result to achieve label stack reduction, using the emplacement-preference setting to give preference for the final result given multiple equal options" }, "stopOnFirstResult": { "type": "boolean", "description": "The BSID generation algorithm computes using a sequence of strategies. This option determines if the calculation should stop after a result is found, or continue attempting additional strategies for a potentially more optimal result" } } }, "ExplicitRouteStrategyCompressedSettings1": { "title": "ExplicitRouteStrategyCompressedSettings1", "type": "object", "properties": { "fallbackIgpNoTe": { "type": "boolean", "description": "If the path calculation fails to find a feasible result that satisfies MSD, this flag will permit the calculation to fallback to computing a path based on Objective COST without respecting traffic engineering constraints such as bandwidth or any of the cumulative constraints. Admin groups, diversity and bi-directional feature sets are respected and enforced. The goal of this is to permit the path calculation to fallback to a managed PCE computed path based on the IGP SPF which is more likely to succeed in satisfying MSD requirements. Due to potential ECMP options in the topology it may also be unable to compress a computed path. The default value is false. It is recommended to be enabled only if operator preference is for a tunnel to remain operationally up rather than respecting all traffic engineering requirements" }, "fallbackIgpTe": { "type": "boolean", "description": "If the path calculation fails to find a feasible result that satisfies MSD, this flag will permit the calculation to fallback to computing a traffic engineered path with Objective COST. The default value is true and is recommended to be true" }, "fallbackLooseHop": { "type": "boolean", "description": "If the path calculation fails to find a new feasible TE path that satisfies MSD, this flag will permit provisioning the path with only a Node SID to the destination, without any traffic engineering constraints or ECMP validation. This causes the tunnel to behave in a similar manner on the PCC as a locally computed non-cspf SR-ISIS or SR-OSPF path, thus allowing the tunnel to stay operationally up instead of go operationally down. This option does not support bidirectional strict or diversity routed paths. If this option is used, the PCE loses all path tracking visibility thus limiting feature capabilities and support, and potentially inaccurate bandwidth utilization tracking. The default value is false. If this option is enabled, it is strongly recommended that option fallback-status-quo is also enabled" }, "fallbackStatusQuo": { "type": "boolean", "description": "If the path calculation fails to find a new feasible TE path that satisfies MSD, this flag will permit an established tunnel to remain on the previously calculated path, if the current path is still a viable path that satisfies all constraints, rather than proceeding to the next fallback option, the path will be kept active on it's previously calculated path instead of re-routing. In addition to keeping the path fully managed, this option aids in de-risking and mitigating potential bandwidth related oscillation issues caused by fallback-loose-hop due to loss of path tracking. The default value is true and recommended to be true" } } }, "ExtendedAdminGroup2": { "title": "ExtendedAdminGroup2", "type": "object", "properties": { "binary": { "type": "string" } } }, "ExternalDomain2": { "title": "ExternalDomain2", "type": "object", "properties": { "plugId": { "type": "integer", "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.", "format": "int64" }, "remoteTeLinkTpId": { "$ref": "#/components/schemas/RemoteTeLinkTpId" }, "remoteTeNodeId": { "$ref": "#/components/schemas/RemoteTeNodeId" } } }, "FarEndIpAddress": { "title": "FarEndIpAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "FlowCollection1": { "title": "FlowCollection1", "type": "object", "properties": { "mplsLabelStackQueryRate": { "type": "integer", "description": "Interval in seconds between each query of KPI-engine for cflowd statistics.", "format": "int32" }, "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", "description": "Interval in seconds between checks for stale cflowd stats.", "format": "int32" }, "statsTimeToLive": { "type": "integer", "description": "Time to live in seconds for stats before they become stale.", "format": "int32" } } }, "ForwardingPaths1": { "title": "ForwardingPaths1", "type": "object", "properties": { "forwardingPath": { "type": "array", "items": { "$ref": "#/components/schemas/ForwardingPath" }, "description": "" } } }, "ForwardingPaths3": { "title": "ForwardingPaths3", "type": "object", "properties": { "forwardingPaths": { "$ref": "#/components/schemas/ForwardingPaths1" } } }, "From2": { "title": "From2", "type": "object", "properties": { "tpRef": { "type": "string", "description": "Relative reference to source termination point." } } }, "GeoLocation1": { "title": "GeoLocation1", "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude of the geographical location in degrees" }, "longitude": { "type": "number", "description": "The longitude of the geographical location in degrees" } } }, "HopDataParamsState2": { "title": "HopDataParamsState2", "type": "object", "properties": { "hopDataProperties": { "$ref": "#/components/schemas/HopDataProperties2" } } }, "HopDataProperties2": { "title": "HopDataProperties2", "type": "object", "properties": { "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "Unique resource identifiers for the hop" }, "sid": { "type": "integer", "description": "Sid index", "format": "int32" }, "sidHopType": { "$ref": "#/components/schemas/SidHopType" }, "sourceSiteId": { "type": "string", "description": "Source ip address of the hop" } } }, "HopsData2": { "title": "HopsData2", "type": "object", "properties": { "hopData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/HopData" } } } }, "IncludeAll": { "title": "IncludeAll", "type": "object", "properties": { "adminGroup": { "$ref": "#/components/schemas/AdminGroup1" }, "extendedAdminGroup": { "$ref": "#/components/schemas/ExtendedAdminGroup2" } } }, "IncludeAny": { "title": "IncludeAny", "type": "object", "properties": { "adminGroup": { "$ref": "#/components/schemas/AdminGroup1" }, "extendedAdminGroup": { "$ref": "#/components/schemas/ExtendedAdminGroup2" } } }, "InformationSourceAttributes1": { "title": "InformationSourceAttributes1", "type": "object", "properties": { "informationSource": { "$ref": "#/components/schemas/InformationSource" }, "informationSourceState": { "$ref": "#/components/schemas/InformationSourceState2" } } }, "InformationSourceState2": { "title": "InformationSourceState2", "type": "object", "properties": { "credibilityPreference": { "type": "integer", "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.", "format": "int32" }, "routingInstance": { "type": "string", "description": "When applicable, this is the name of a routing instance from which the information is learned." }, "topology": { "$ref": "#/components/schemas/Topology2" } } }, "Ingress2": { "title": "Ingress2", "type": "object", "properties": { "vlanOperations": { "$ref": "#/components/schemas/VlanOperations1" } } }, "IngressParam2": { "title": "IngressParam2", "type": "object", "properties": { "tier1Scheduler": { "$ref": "#/components/schemas/Tier1Scheduler1" } } }, "InterfaceSwitchingCapabilityList2": { "title": "InterfaceSwitchingCapabilityList2", "type": "object", "properties": { "interfaceSwitchingCapability": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/InterfaceSwitchingCapability" } } } }, "Ip": { "title": "Ip", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "IpAddress1": { "title": "IpAddress1", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "LabelEnd": { "title": "LabelEnd", "type": "object", "properties": { "binary": { "type": "string" } } }, "LabelStart": { "title": "LabelStart", "type": "object", "properties": { "binary": { "type": "string" } } }, "Lag2": { "title": "Lag2", "type": "object", "properties": { "lagId": { "type": "integer", "description": "The Id of the LAG", "format": "int32" }, "lagMembers": { "type": "array", "items": { "$ref": "#/components/schemas/LagMemberInfo" }, "description": "" } } }, "LifeCycle3": { "title": "LifeCycle3", "type": "object", "properties": { "phase": { "$ref": "#/components/schemas/Phase" }, "reason": { "type": "string", "description": "The reason for the current phase/state of the life cycle object" }, "state": { "$ref": "#/components/schemas/State2" } } }, "LinkConfig2": { "title": "LinkConfig2", "type": "object", "properties": { "linkParams": { "$ref": "#/components/schemas/LinkParams1" } } }, "LinkId2": { "title": "LinkId2", "type": "object", "properties": { "uri": { "$ref": "#/components/schemas/UrlSafeString" } } }, "LinkParams1": { "title": "LinkParams1", "type": "object", "properties": { "accessType": { "$ref": "#/components/schemas/AccessType1" }, "adminStatus": { "$ref": "#/components/schemas/AdminStatus1" }, "administrativeGroup": { "$ref": "#/components/schemas/AdministrativeGroup" }, "igpMetric": { "type": "integer", "description": "IGP topology Metric", "format": "int32" }, "isAbstract": { "type": "object", "description": "Present if the link is abstract" }, "latency": { "type": "number", "description": "Delay or latency in micro seconds. The value must be greater than or equal to 0" }, "maxResvLinkBandwidth": { "type": "integer", "description": "Maximum amount of bandwidth that can be reserved in this direction in this link. Units in kbps", "format": "int64" }, "measuredIpBw": { "type": "number", "description": "Measured IP bandwidth. Units in Mbps. The value must be greater than or equal to 0" }, "measuredMplsBw": { "type": "number", "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", "items": { "$ref": "#/components/schemas/Srlg" }, "description": "A list of SRLG values" }, "teMetric": { "type": "integer", "description": "Traffic Engineering Metric", "format": "int64" }, "unreservedBandwidth": { "type": "integer", "description": "Unreserved bandwidth. Units in kbps", "format": "int64" } } }, "LinkState2": { "title": "LinkState2", "type": "object", "properties": { "linkParams": { "$ref": "#/components/schemas/LinkParams1" }, "operStatus": { "$ref": "#/components/schemas/OperStatus" } } }, "LocalInterfaceIp": { "title": "LocalInterfaceIp", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "Measurement2": { "title": "Measurement2", "type": "object", "properties": { "performanceMetricAttributes": { "$ref": "#/components/schemas/PerformanceMetricAttributes1" } } }, "MplsLabel2": { "title": "MplsLabel2", "type": "object", "properties": { "int32": { "type": "integer", "format": "int32" } } }, "NetworkConfig2": { "title": "NetworkConfig2", "type": "object", "properties": { "networkParams": { "$ref": "#/components/schemas/NetworkParams1" } } }, "NetworkId2": { "title": "NetworkId2", "type": "object", "properties": { "uri": { "$ref": "#/components/schemas/UrlSafeString" } } }, "NetworkIdentifier": { "title": "NetworkIdentifier", "type": "object", "properties": { "uint32": { "type": "integer", "format": "int64" } } }, "NetworkParams1": { "title": "NetworkParams1", "type": "object", "properties": { "area": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Area" } }, "preference": { "type": "integer", "description": "Specifies a preference for this topology. A lower number indicates a higher preference", "format": "int32" } } }, "NetworkState2": { "title": "NetworkState2", "type": "object", "properties": { "networkParams": { "$ref": "#/components/schemas/NetworkParams1" } } }, "NniPortConfig2": { "title": "NniPortConfig2", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "name": { "type": "string", "description": "The name of the endpoint" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" } } }, "NodeConfig2": { "title": "NodeConfig2", "type": "object", "properties": { "nodeParams": { "$ref": "#/components/schemas/NodeParams1" } } }, "NodeData1": { "title": "NodeData1", "type": "object", "properties": { "nspNode": { "$ref": "#/components/schemas/NspNode1" } } }, "NodeId1": { "title": "NodeId1", "type": "object", "properties": { "dottedQuad": { "$ref": "#/components/schemas/UrlSafeString" } } }, "NodeId3": { "title": "NodeId3", "type": "object", "properties": { "uri": { "$ref": "#/components/schemas/UrlSafeString" } } }, "NodeParams1": { "title": "NodeParams1", "type": "object", "properties": { "areaId": { "type": "array", "items": { "type": "string" }, "description": "" }, "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": { "$ref": "#/components/schemas/NodeId1" }, "operStatus": { "$ref": "#/components/schemas/OperStatus1" }, "srStartLabel": { "type": "integer", "description": "MPLS label range start value", "format": "int64" } } }, "NodeState2": { "title": "NodeState2", "type": "object", "properties": { "nodeParams": { "$ref": "#/components/schemas/NodeParams1" } } }, "Normality2": { "title": "Normality2", "type": "object", "properties": { "performanceMetricNormalityAttributes": { "$ref": "#/components/schemas/PerformanceMetricNormalityAttributes2" } } }, "NspLink2": { "title": "NspLink2", "type": "object", "properties": { "linkConfig": { "$ref": "#/components/schemas/LinkConfig2" }, "linkState": { "$ref": "#/components/schemas/LinkState2" } } }, "NspNetwork2": { "title": "NspNetwork2", "type": "object", "properties": { "networkConfig": { "$ref": "#/components/schemas/NetworkConfig2" }, "networkName": { "type": "string", "description": "The name of the network" }, "networkState": { "$ref": "#/components/schemas/NetworkState2" } } }, "NspNode1": { "title": "NspNode1", "type": "object", "properties": { "nodeConfig": { "$ref": "#/components/schemas/NodeConfig2" }, "nodeState": { "$ref": "#/components/schemas/NodeState2" } } }, "NspTerminationPoint2": { "title": "NspTerminationPoint2", "type": "object", "properties": { "terminationPointConfig": { "$ref": "#/components/schemas/TerminationPointConfig2" }, "terminationPointState": { "$ref": "#/components/schemas/TerminationPointState2" } } }, "OpenflowInstruction1": { "title": "OpenflowInstruction1", "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenflowAction" }, "description": "" }, "instructionType": { "$ref": "#/components/schemas/InstructionType" } } }, "OpenflowMatch1": { "title": "OpenflowMatch1", "type": "object", "properties": { "destIpAddress": { "$ref": "#/components/schemas/DestIpAddress" }, "destPort": { "type": "integer", "description": "Destination (TCP or UDP) port number", "format": "int64" }, "dscp": { "$ref": "#/components/schemas/Dscp1" }, "ethernetType": { "type": "string", "description": "Ethernet Type in hexadecimal (for example 0x800 for IPv4)" }, "inPort": { "type": "integer", "description": "Input port number", "format": "int64" }, "ipProtocolType": { "type": "integer", "description": "IP Protocol Type (for example 6 for TCP or 17 for UDP)", "format": "int32" }, "outerVlanId": { "type": "integer", "description": "Experimenter outer VlanId", "format": "int64" }, "sourceIpAddress": { "$ref": "#/components/schemas/SourceIpAddress" }, "sourcePort": { "type": "integer", "description": "Source (TCP or UDP) port number", "format": "int64" }, "vlanId": { "type": "integer", "description": "Dot1Q tag or inner QinQ tag VlanId", "format": "int64" } } }, "Optics1": { "title": "Optics1", "type": "object", "properties": { "protectionType": { "$ref": "#/components/schemas/ProtectionType3" } } }, "OuterTag1": { "title": "OuterTag1", "type": "object", "properties": { "vlanClassification": { "$ref": "#/components/schemas/VlanClassification1" } } }, "OuterTag3": { "title": "OuterTag3", "type": "object", "properties": { "vlanWrite": { "$ref": "#/components/schemas/VlanWrite1" } } }, "OwnershipState2": { "title": "OwnershipState2", "type": "object", "properties": { "ownership": { "$ref": "#/components/schemas/Ownership" } } }, "ParamsConfig1": { "title": "ParamsConfig1", "type": "object", "properties": { "pathParams": { "$ref": "#/components/schemas/PathParams1" } } }, "ParamsState2": { "title": "ParamsState2", "type": "object", "properties": { "pathParams": { "$ref": "#/components/schemas/PathParams1" } } }, "PathHops1": { "title": "PathHops1", "type": "object", "properties": { "pathHop": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PathHop" } } } }, "PathParams1": { "title": "PathParams1", "type": "object", "properties": { "adminGroupExcludeAny": { "$ref": "#/components/schemas/AdminGroupExcludeAny" }, "adminGroupIncludeAll": { "$ref": "#/components/schemas/AdminGroupIncludeAll" }, "adminGroupIncludeAny": { "$ref": "#/components/schemas/AdminGroupIncludeAny" }, "bandwidth": { "type": "integer", "description": "Path bandwidth capacity. Units in Kbps", "format": "int32" }, "maxCost": { "type": "integer", "description": "Path maximum cost constraint", "format": "int64" }, "maxHops": { "type": "integer", "description": "Path maximum hops constraint. 0 and 255 means no limit.", "format": "int64" }, "maxLatency": { "type": "number", "description": "Path maximum latency constraint" }, "maxTeMetric": { "type": "integer", "description": "Path maximum TE metric constraint", "format": "int64" }, "msd": { "type": "integer", "description": "Path maximum SID depth. 0 means no MSD.", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective19" }, "pathProfile": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PathProfile" } }, "pathProfileOverride": { "$ref": "#/components/schemas/PathProfileOverride2" }, "setupPriority": { "type": "integer", "description": "Path setup priority from 0 to 7. Value 0 is the highest priority", "format": "int32" }, "templateId": { "type": "integer", "description": "MPLS path template ID (PCE Initiated only)", "format": "int64" } } }, "PathProfileOverride2": { "title": "PathProfileOverride2", "type": "object", "properties": { "extendedId": { "type": "integer", "description": "Path extended identifier. An identifier for profile association/grouping", "format": "int64" }, "profileGroupOverrideState": { "$ref": "#/components/schemas/ProfileGroupOverrideState" }, "profileId": { "type": "integer", "description": "Path profile identifier. An identifier of a predefined profile. 0 means no path profile assigned. -1 deletes the path profile override.", "format": "int64" } } }, "PathRequest1": { "title": "PathRequest1", "type": "object", "properties": { "pathTeParams": { "$ref": "#/components/schemas/PathTeParams2" } } }, "PathTeParams2": { "title": "PathTeParams2", "type": "object", "properties": { "adminGroupExcludeAny": { "$ref": "#/components/schemas/AdminGroupExcludeAny" }, "adminGroupIncludeAll": { "$ref": "#/components/schemas/AdminGroupIncludeAll" }, "adminGroupIncludeAny": { "$ref": "#/components/schemas/AdminGroupIncludeAny" }, "bandwidth": { "type": "integer", "description": "Path bandwidth capacity. Units in Kbps", "format": "int32" }, "bidirectional": { "$ref": "#/components/schemas/Bidirectional22" }, "diversity": { "$ref": "#/components/schemas/Diversity" }, "excludeRouteObjects": { "type": "array", "items": { "$ref": "#/components/schemas/IpAddress" }, "description": "Excluded Route Objects. Path must not contain any of the entities which correspond to the IP Addresses in this set" }, "explicitRouteStrategy": { "$ref": "#/components/schemas/ExplicitRouteStrategy1" }, "explicitRouteStrategyBsidSettings": { "$ref": "#/components/schemas/ExplicitRouteStrategyBsidSettings1" }, "explicitRouteStrategyCompressedSettings": { "$ref": "#/components/schemas/ExplicitRouteStrategyCompressedSettings1" }, "explicitRouteStrategyEcmpPreference": { "$ref": "#/components/schemas/ExplicitRouteStrategyEcmpPreference1" }, "includeRouteObjects": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IroHop" } }, "ipAddressTypeStrategy": { "$ref": "#/components/schemas/IpAddressTypeStrategy" }, "maxCost": { "type": "integer", "description": "Path maximum cost constraint", "format": "int64" }, "maxHops": { "type": "integer", "description": "Path maximum hops constraint. 0 and 255 means no limit.", "format": "int64" }, "maxLatency": { "type": "number", "description": "Path maximum latency constraint (in microseconds)" }, "maxTeMetric": { "type": "integer", "description": "Path maximum TE metric constraint", "format": "int64" }, "msd": { "type": "integer", "description": "Path maximum SID depth. The advertised MSD from the source node will be used if msd is set to 0", "format": "int64" }, "objective": { "$ref": "#/components/schemas/Objective26" }, "pathProfileId": { "type": "integer", "description": "Path profile identifier. An identifier of a predefined profile. 0 means no path profile assigned. NOTE: Path diagnosis behaves like LSP diagnosis, the path profile takes precedence for constraints of [objective, bidirectional, diversity, includeRouteObjects, excludeRouteObjects, explicitRouteStrategy, explicitRouteStrategyEcmpPreference], and other individual path TE params will not be override by the path profile if non-default values are provided. But for the regular IP Path finding request, the individual Path TE params take precedence if values are provided to allow more tuning and customization, otherwise, values will come from path profile or set to default values.", "format": "int64" }, "reverseBandwidth": { "type": "integer", "description": "Reverse Path bandwidth capacity. Units in Kbps", "format": "int32" }, "srAlgorithm": { "type": "integer", "description": "Algorithm number, 0 is SPF based on link metric. 128..255 is Flex Algo defined by operator on a per deployment basis.", "format": "int64" } } }, "PccAddress": { "title": "PccAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "PeerIpAddress": { "title": "PeerIpAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "PerformanceMetric2": { "title": "PerformanceMetric2", "type": "object", "properties": { "measurement": { "$ref": "#/components/schemas/Measurement2" }, "normality": { "$ref": "#/components/schemas/Normality2" }, "tePerformanceMetric": { "type": "object", "description": "This feature indicates that the system supports TE performance metric." } } }, "PerformanceMetricAttributes1": { "title": "PerformanceMetricAttributes1", "type": "object", "properties": { "unidirectionalAvailableBandwidth": { "type": "number", "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", "description": "Delay or latency in micro seconds.", "format": "int64" }, "unidirectionalDelayVariation": { "type": "integer", "description": "Delay variation in micro seconds.", "format": "int64" }, "unidirectionalMaxDelay": { "type": "integer", "description": "Maximum delay or latency in micro seconds.", "format": "int64" }, "unidirectionalMinDelay": { "type": "integer", "description": "Minimum delay or latency in micro seconds.", "format": "int64" }, "unidirectionalPacketLoss": { "type": "number", "description": "Packet loss as a percentage of the total traffic sent over a configurable interval. The finest precision is 0.000003%." }, "unidirectionalResidualBandwidth": { "type": "number", "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", "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." } } }, "PerformanceMetricNormalityAttributes2": { "title": "PerformanceMetricNormalityAttributes2", "type": "object", "properties": { "unidirectionalAvailableBandwidth": { "$ref": "#/components/schemas/UnidirectionalAvailableBandwidth" }, "unidirectionalDelay": { "$ref": "#/components/schemas/UnidirectionalDelay" }, "unidirectionalDelayVariation": { "$ref": "#/components/schemas/UnidirectionalDelayVariation" }, "unidirectionalMaxDelay": { "$ref": "#/components/schemas/UnidirectionalMaxDelay" }, "unidirectionalMinDelay": { "$ref": "#/components/schemas/UnidirectionalMinDelay" }, "unidirectionalPacketLoss": { "$ref": "#/components/schemas/UnidirectionalPacketLoss" }, "unidirectionalResidualBandwidth": { "$ref": "#/components/schemas/UnidirectionalResidualBandwidth" }, "unidirectionalUtilizedBandwidth": { "$ref": "#/components/schemas/UnidirectionalUtilizedBandwidth" } } }, "PerformanceMetricThrottle2": { "title": "PerformanceMetricThrottle2", "type": "object", "properties": { "advertisementInterval": { "type": "integer", "description": "Interval in seconds to advertise the extended metric values.", "format": "int64" }, "measureInterval": { "type": "integer", "description": "Interval in seconds to measure the extended metric values.", "format": "int64" }, "suppressionInterval": { "type": "integer", "description": "Interval in seconds to suppress advertising the extended metric values.", "format": "int64" }, "tePerformanceMetric": { "type": "object", "description": "This feature indicates that the system supports TE performance metric." }, "thresholdAcceleratedAdvertisement": { "$ref": "#/components/schemas/ThresholdAcceleratedAdvertisement2" }, "thresholdIn": { "$ref": "#/components/schemas/ThresholdIn2" }, "thresholdOut": { "$ref": "#/components/schemas/ThresholdOut2" }, "unidirectionalDelayOffset": { "type": "integer", "description": "Offset value to be added to the measured delay value.", "format": "int64" } } }, "PerformanceMetricThrottleContainer2": { "title": "PerformanceMetricThrottleContainer2", "type": "object", "properties": { "performanceMetricThrottle": { "$ref": "#/components/schemas/PerformanceMetricThrottle2" } } }, "Platform2": { "title": "Platform2", "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." } } }, "pluginName1": { "title": "pluginName1", "enum": [ "VSR_NRC" ], "type": "string", "description": "The name of the plugin" }, "Policies1": { "title": "Policies1", "type": "object", "properties": { "srPolicy": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SrPolicy" } } } }, "PolicyParamsConfig2": { "title": "PolicyParamsConfig2", "type": "object", "properties": { "policyProperties": { "$ref": "#/components/schemas/PolicyProperties1" } } }, "PolicyParamsState2": { "title": "PolicyParamsState2", "type": "object", "properties": { "policyProperties": { "$ref": "#/components/schemas/PolicyProperties1" } } }, "PolicyProperties1": { "title": "PolicyProperties1", "type": "object", "properties": { "ownership": { "$ref": "#/components/schemas/Ownership" }, "priority": { "type": "integer", "description": "Unsupported - Priority considered when policy is recomputed due to topology changes. Range from 0 to 255. Value 0 is the highest priority", "format": "int32" } } }, "PostProcessedSourceId": { "title": "PostProcessedSourceId", "type": "object", "properties": { "dottedQuad": { "$ref": "#/components/schemas/UrlSafeString" } } }, "PostProcessedSourceInterface": { "title": "PostProcessedSourceInterface", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "PrimaryAddress": { "title": "PrimaryAddress", "type": "object", "properties": { "ipv4Prefix": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Prefix": { "$ref": "#/components/schemas/UrlSafeString" } } }, "provider1": { "title": "provider1", "enum": [ "KEYSTONE", "SSO" ], "type": "string", "description": "The Identity Provider in which to resynchronize data" }, "ProviderId": { "title": "ProviderId", "type": "object", "properties": { "uint32": { "type": "integer", "format": "int64" } } }, "ProvisionedHops2": { "title": "ProvisionedHops2", "type": "object", "properties": { "pathHops": { "$ref": "#/components/schemas/PathHops1" } } }, "PushTags2": { "title": "PushTags2", "type": "object", "properties": { "outerTag": { "$ref": "#/components/schemas/OuterTag3" }, "secondTag": { "$ref": "#/components/schemas/SecondTag3" } } }, "RecordedHops2": { "title": "RecordedHops2", "type": "object", "properties": { "pathHops": { "$ref": "#/components/schemas/PathHops1" } } }, "Recovery1": { "title": "Recovery1", "type": "object", "properties": { "protectionStatus": { "$ref": "#/components/schemas/ProtectionStatus" }, "restorationStatus": { "$ref": "#/components/schemas/RestorationStatus" } } }, "RemoteInterfaceIp": { "title": "RemoteInterfaceIp", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "RemoteTeLinkTpId": { "title": "RemoteTeLinkTpId", "type": "object", "properties": { "ipAddress": { "$ref": "#/components/schemas/IpAddress1" }, "uint32": { "type": "integer", "format": "int64" } } }, "RemoteTeNodeId": { "title": "RemoteTeNodeId", "type": "object", "properties": { "dottedQuad": { "$ref": "#/components/schemas/UrlSafeString" } } }, "requestType1": { "title": "requestType1", "enum": [ "MOVED", "INCOMING", "OUTGOING" ], "type": "string", "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." }, "requestType2": { "title": "requestType2", "enum": [ "MOVED", "INCOMING", "OUTGOING" ], "type": "string", "description": "OUTGOING: Return all SR Policies in the forward direction of the link which egress from this router. INCOMING: Return all SR Policies that ingress into the router on this link. SR Policies are unidirectional, however links form symmetric adjacencies/neighbours when point to point and it may be valuable to know which SR Policies flow across a given adjacency from the other router. For broadcast links, the termination point between a router and the subnet effectively carries SR Policy traffic in both directions. This option will return the list of SR Policies which transit through neighbor routers, the subnet and then to this router MOVED: Return all SR Policies moved off the link due to maintenance enabled." }, "ResilienceConstraint2": { "title": "ResilienceConstraint2", "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.", "format": "int32" }, "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.", "format": "int32" }, "resilienceType": { "$ref": "#/components/schemas/ResilienceType2" }, "restorationCoordinateType": { "$ref": "#/components/schemas/RestorationCoordinateType" }, "restorePriority": { "type": "integer", "description": "none", "format": "int32" }, "reversionMode": { "$ref": "#/components/schemas/ReversionMode2" }, "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.", "format": "int32" } } }, "ResilienceType2": { "title": "ResilienceType2", "type": "object", "properties": { "protectionType": { "$ref": "#/components/schemas/ProtectionType2" }, "restorationPolicy": { "$ref": "#/components/schemas/RestorationPolicy" } } }, "resourceType1": { "title": "resourceType1", "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" ], "type": "string", "description": "The resource type to be queried" }, "ReversionPolicy2": { "title": "ReversionPolicy2", "type": "object", "properties": { "reversionMode": { "$ref": "#/components/schemas/ReversionMode4" }, "waitToRevertTime": { "$ref": "#/components/schemas/WaitToRevertTime2" } } }, "roleType1": { "title": "roleType1", "enum": [ "OPERATOR", "ADMIN", "USER" ], "type": "string", "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." }, "RouterId": { "title": "RouterId", "type": "object", "properties": { "dottedQuad": { "$ref": "#/components/schemas/UrlSafeString" } } }, "RouterId1": { "title": "RouterId1", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "RoutingBgp1": { "title": "RoutingBgp1", "type": "object", "properties": { "routes": { "type": "array", "items": { "$ref": "#/components/schemas/EbgpRoute" }, "description": "" } } }, "RoutingConstraint2": { "title": "RoutingConstraint2", "type": "object", "properties": { "costCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/CostCharacteristic" }, "description": "" }, "diversityPolicy": { "$ref": "#/components/schemas/DiversityPolicy" }, "isExclusive": { "type": "boolean", "description": "To distinguish if the resources are to be exclusive to the service" }, "latencyCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/LatencyCharacteristic" }, "description": "" }, "riskDiversityCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/RiskCharacteristic" }, "description": "" }, "routeDirection": { "$ref": "#/components/schemas/RouteDirection" }, "routeObjectiveFunction": { "$ref": "#/components/schemas/RouteObjectiveFunction" } } }, "Schedule1": { "title": "Schedule1", "type": "object", "properties": { "timeRange": { "$ref": "#/components/schemas/TimeRange2" } } }, "Scheduler2": { "title": "Scheduler2", "type": "object", "properties": { "cir": { "type": "integer", "description": "Scheduler CIR override in either Kbps or percentage (0..100), where -3 is sum of CIR, -2 is no override, -1 is maximum", "format": "int64" }, "pir": { "type": "integer", "description": "Scheduler PIR override in either Kbps or percentage (1..100), where -2 is no override, -1 is maximum", "format": "int64" }, "rateType": { "$ref": "#/components/schemas/RateType1" }, "schedulerType": { "$ref": "#/components/schemas/SchedulerType" } } }, "Schedules1": { "title": "Schedules1", "type": "object", "properties": { "schedule": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Schedule" } } } }, "Schedules2": { "title": "Schedules2", "type": "object", "properties": { "schedules": { "$ref": "#/components/schemas/Schedules1" } } }, "SecondaryDestinationAddress": { "title": "SecondaryDestinationAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SecondarySourceAddress": { "title": "SecondarySourceAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SecondTag1": { "title": "SecondTag1", "type": "object", "properties": { "vlanClassification": { "$ref": "#/components/schemas/VlanClassification1" } } }, "SecondTag3": { "title": "SecondTag3", "type": "object", "properties": { "vlanWrite": { "$ref": "#/components/schemas/VlanWrite1" } } }, "SegmentLists1": { "title": "SegmentLists1", "type": "object", "properties": { "segmentList": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentList" }, "description": "" } } }, "SegmentLists3": { "title": "SegmentLists3", "type": "object", "properties": { "segmentLists": { "$ref": "#/components/schemas/SegmentLists1" } } }, "SegmentListsConfig2": { "title": "SegmentListsConfig2", "type": "object", "properties": { "segmentList": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentListsConfigSegmentList" }, "description": "" } } }, "SegmentListsConfigRequest2": { "title": "SegmentListsConfigRequest2", "type": "object", "properties": { "segmentListsConfig": { "$ref": "#/components/schemas/SegmentListsConfig2" } } }, "SegmentParamsConfig2": { "title": "SegmentParamsConfig2", "type": "object", "properties": { "segmentProperties": { "$ref": "#/components/schemas/SegmentProperties1" } } }, "SegmentParamsState2": { "title": "SegmentParamsState2", "type": "object", "properties": { "segmentProperties": { "$ref": "#/components/schemas/SegmentProperties1" } } }, "SegmentProperties1": { "title": "SegmentProperties1", "type": "object", "properties": { "segmentTypes": { "$ref": "#/components/schemas/SegmentTypes1" }, "type": { "$ref": "#/components/schemas/Type4" }, "validate": { "type": "boolean", "description": "Unsupported -Indicates whether the segment should be validated. The default applies to all segments other than the first segment. For the first segment, validation is always done" } } }, "SegmentProperty2": { "title": "SegmentProperty2", "type": "object", "properties": { "segmentTypes": { "$ref": "#/components/schemas/SegmentTypes1" }, "type": { "$ref": "#/components/schemas/Type4" } } }, "Segments1": { "title": "Segments1", "type": "object", "properties": { "segment": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Segment" } } } }, "Segments3": { "title": "Segments3", "type": "object", "properties": { "segment": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SegmentListSegmentsSegment" } } } }, "SegmentsConfig2": { "title": "SegmentsConfig2", "type": "object", "properties": { "segment": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SegmentProperties" } } } }, "SegmentType13": { "title": "SegmentType13", "type": "object", "properties": { "sidValue": { "$ref": "#/components/schemas/SidValue" } } }, "SegmentType22": { "title": "SegmentType22", "type": "object", "properties": { "sidValue": { "$ref": "#/components/schemas/SidValue1" } } }, "SegmentType32": { "title": "SegmentType32", "type": "object", "properties": { "algorithm": { "type": "integer", "description": "Prefix SID algorithm identifier", "format": "int32" }, "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SegmentType42": { "title": "SegmentType42", "type": "object", "properties": { "algorithm": { "type": "integer", "description": "Prefix SID algorithm identifier", "format": "int32" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SegmentType52": { "title": "SegmentType52", "type": "object", "properties": { "interfaceIdentifier": { "type": "integer", "description": "local interface identifier", "format": "int64" }, "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SegmentType62": { "title": "SegmentType62", "type": "object", "properties": { "localIpv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteIpv4Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SegmentType72": { "title": "SegmentType72", "type": "object", "properties": { "localInterfaceIdentifier": { "type": "integer", "description": "Local interface identifier", "format": "int64" }, "localIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteInterfaceIdentifier": { "type": "integer", "description": "Remote interface identifier", "format": "int64" }, "remoteIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SegmentType82": { "title": "SegmentType82", "type": "object", "properties": { "localIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" }, "remoteIpv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SegmentTypes1": { "title": "SegmentTypes1", "type": "object", "properties": { "segmentType1": { "$ref": "#/components/schemas/SegmentType13" }, "segmentType10": { "$ref": "#/components/schemas/SegmentType72" }, "segmentType11": { "$ref": "#/components/schemas/SegmentType82" }, "segmentType2": { "$ref": "#/components/schemas/SegmentType22" }, "segmentType3": { "$ref": "#/components/schemas/SegmentType32" }, "segmentType4": { "$ref": "#/components/schemas/SegmentType42" }, "segmentType5": { "$ref": "#/components/schemas/SegmentType52" }, "segmentType6": { "$ref": "#/components/schemas/SegmentType62" }, "segmentType7": { "$ref": "#/components/schemas/SegmentType72" }, "segmentType8": { "$ref": "#/components/schemas/SegmentType82" }, "segmentType9": { "$ref": "#/components/schemas/SegmentType42" } } }, "serviceType51": { "title": "serviceType51", "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" ], "type": "string", "description": "The service type for the port to be queried" }, "SidValue": { "title": "SidValue", "type": "object", "properties": { "int32": { "type": "integer", "format": "int32" } } }, "SidValue1": { "title": "SidValue1", "type": "object", "properties": { "ipv6Prefix": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SiteServiceQosProfile1": { "title": "SiteServiceQosProfile1", "type": "object", "properties": { "egressOverrideQueues": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "egressParam": { "$ref": "#/components/schemas/EgressParam2" }, "ingressOverrideQueues": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" }, "description": "" }, "ingressParam": { "$ref": "#/components/schemas/IngressParam2" }, "qosProfile": { "type": "integer", "description": "The ID reference to the Generic QoS Profile", "format": "int64" } } }, "Source3": { "title": "Source3", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "Source7": { "title": "Source7", "required": [ "sourceNode" ], "type": "object", "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." } } }, "SourceAddress": { "title": "SourceAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SourceIpAddress": { "title": "SourceIpAddress", "type": "object", "properties": { "ipv4Prefix": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Prefix": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SourceNodeId": { "title": "SourceNodeId", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SourceRouterAddress": { "title": "SourceRouterAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "Srv6Sid2": { "title": "Srv6Sid2", "type": "object", "properties": { "ipv6Prefix": { "$ref": "#/components/schemas/UrlSafeString" } } }, "State1": { "title": "State1", "type": "object", "properties": { "teLinkConfig": { "$ref": "#/components/schemas/TeLinkConfig1" }, "teLinkStateDerived": { "$ref": "#/components/schemas/TeLinkStateDerived2" } } }, "State3": { "title": "State3", "type": "object", "properties": { "teNodeConfig": { "$ref": "#/components/schemas/TeNodeConfig1" }, "teNodeStateDerived": { "$ref": "#/components/schemas/TeNodeStateDerived2" } } }, "State4": { "title": "State4", "type": "object", "properties": { "teNodeTunnelTerminationCapability": { "$ref": "#/components/schemas/TeNodeTunnelTerminationCapability1" } } }, "State5": { "title": "State5", "type": "object", "properties": { "teTerminationPointConfig": { "$ref": "#/components/schemas/TeTerminationPointConfig1" } } }, "State6": { "title": "State6", "type": "object", "properties": { "teTopologyConfig": { "$ref": "#/components/schemas/TeTopologyConfig1" } } }, "SwitchAddress": { "title": "SwitchAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "SwitchPolicy2": { "title": "SwitchPolicy2", "type": "object", "properties": { "waitToSwitchTime": { "$ref": "#/components/schemas/WaitToSwitchTime2" } } }, "SymmetricalOperation2": { "title": "SymmetricalOperation2", "type": "object", "properties": { "vlanOperations": { "$ref": "#/components/schemas/VlanOperations1" } } }, "SystemId": { "title": "SystemId", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "TargetIpAddress": { "title": "TargetIpAddress", "type": "object", "properties": { "ipv4Address": { "$ref": "#/components/schemas/UrlSafeString" }, "ipv6Address": { "$ref": "#/components/schemas/UrlSafeString" } } }, "Tdm2": { "title": "Tdm2", "type": "object", "properties": { "channelFraming": { "type": "string", "description": "Specifies the channel framing configuration for the DS1/E1 port" }, "ds0ChannelGroups": { "type": "array", "items": { "$ref": "#/components/schemas/TdmDs0ChannelGroupInfo" }, "description": "" }, "signalMode": { "$ref": "#/components/schemas/SignalMode" } } }, "Te1": { "title": "Te1", "type": "object", "properties": { "config": { "$ref": "#/components/schemas/Config1" }, "state": { "$ref": "#/components/schemas/State1" } } }, "Te2": { "title": "Te2", "required": [ "teNodeId" ], "type": "object", "properties": { "config": { "$ref": "#/components/schemas/Config2" }, "state": { "$ref": "#/components/schemas/State3" }, "teNodeId": { "$ref": "#/components/schemas/TeNodeId2" }, "tunnelTerminationPoint": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TunnelTerminationPoint" } } } }, "Te3": { "title": "Te3", "required": [ "teTpId" ], "type": "object", "properties": { "config": { "$ref": "#/components/schemas/Config4" }, "state": { "$ref": "#/components/schemas/State5" }, "teTpId": { "$ref": "#/components/schemas/TeTpId2" } } }, "Te4": { "title": "Te4", "type": "object", "properties": { "templates": { "$ref": "#/components/schemas/Templates2" } } }, "Te5": { "title": "Te5", "required": [ "clientId", "providerId", "teTopologyId" ], "type": "object", "properties": { "clientId": { "$ref": "#/components/schemas/ClientId" }, "config": { "$ref": "#/components/schemas/Config5" }, "providerId": { "$ref": "#/components/schemas/ProviderId" }, "state": { "$ref": "#/components/schemas/State6" }, "teTopologyId": { "$ref": "#/components/schemas/UrlSafeString" } } }, "TeLinkAttributes1": { "title": "TeLinkAttributes1", "type": "object", "properties": { "accessType": { "$ref": "#/components/schemas/AccessType" }, "adminStatus": { "$ref": "#/components/schemas/AdminStatus" }, "externalDomain": { "$ref": "#/components/schemas/ExternalDomain2" }, "isAbstract": { "type": "object", "description": "Present if the link is abstract." }, "name": { "type": "string", "description": "Link Name." }, "performanceMetricThrottleContainer": { "$ref": "#/components/schemas/PerformanceMetricThrottleContainer2" }, "schedules": { "$ref": "#/components/schemas/Schedules2" }, "teLinkInfoAttributes": { "$ref": "#/components/schemas/TeLinkInfoAttributes1" }, "underlay": { "$ref": "#/components/schemas/Underlay3" } } }, "TeLinkConfig1": { "title": "TeLinkConfig1", "type": "object", "properties": { "bundledLinks": { "$ref": "#/components/schemas/BundledLinks1" }, "componentLinks": { "$ref": "#/components/schemas/ComponentLinks1" }, "teLinkAttributes": { "$ref": "#/components/schemas/TeLinkAttributes1" }, "teLinkTemplate": { "type": "array", "items": { "type": "string" }, "description": "The reference to a TE link template." }, "template": { "type": "object", "description": "This feature indicates that the system supports template configuration." } } }, "TeLinkConfigAttributes2": { "title": "TeLinkConfigAttributes2", "type": "object", "properties": { "teLinkAttributes": { "$ref": "#/components/schemas/TeLinkAttributes1" } } }, "TeLinkConnectivityAttributes1": { "title": "TeLinkConnectivityAttributes1", "type": "object", "properties": { "maxLinkBandwidth": { "type": "number", "description": "Maximum bandwidth that can be seen on this link in this direction. Units in bytes per second." }, "maxResvLinkBandwidth": { "type": "number", "description": "Maximum amount of bandwidth that can be reserved in this direction in this link. Units in bytes per second." }, "performanceMetric": { "$ref": "#/components/schemas/PerformanceMetric2" }, "teDefaultMetric": { "type": "integer", "description": "Traffic Engineering Metric.", "format": "int64" }, "teSrlgs": { "$ref": "#/components/schemas/TeSrlgs2" }, "unreservedBandwidth": { "type": "object", "additionalProperties": { "type": "number" } } } }, "TeLinkInfoAttributes1": { "title": "TeLinkInfoAttributes1", "type": "object", "properties": { "administrativeGroup": { "$ref": "#/components/schemas/AdministrativeGroup" }, "interfaceSwitchingCapabilityList": { "$ref": "#/components/schemas/InterfaceSwitchingCapabilityList2" }, "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.", "format": "int32" }, "linkProtectionType": { "$ref": "#/components/schemas/LinkProtectionType" }, "teLinkConnectivityAttributes": { "$ref": "#/components/schemas/TeLinkConnectivityAttributes1" } } }, "TeLinkStateDerived2": { "title": "TeLinkStateDerived2", "type": "object", "properties": { "informationSource": { "$ref": "#/components/schemas/InformationSource" }, "informationSourceEntry": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/InformationSourceEntry" } }, "informationSourceState": { "$ref": "#/components/schemas/InformationSourceState2" }, "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." }, "operStatus": { "$ref": "#/components/schemas/OperStatus2" }, "recovery": { "$ref": "#/components/schemas/Recovery1" }, "underlay": { "$ref": "#/components/schemas/Underlay1" } } }, "TeLinkStateUnderlayAttributes1": { "title": "TeLinkStateUnderlayAttributes1", "type": "object", "properties": { "committed": { "type": "boolean", "description": "true if the underlay is committed." }, "dynamic": { "type": "boolean", "description": "true if the underlay is dynamically created." } } }, "TeLinkUnderlayAttributes2": { "title": "TeLinkUnderlayAttributes2", "type": "object", "properties": { "underlayBackupPath": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UnderlayBackupPath" } }, "underlayPrimaryPath": { "$ref": "#/components/schemas/UnderlayPrimaryPath2" }, "underlayProtectionType": { "type": "integer", "description": "Underlay protection type desired for this link", "format": "int32" }, "underlayTrailDes": { "$ref": "#/components/schemas/UnderlayTrailDes2" }, "underlayTrailSrc": { "$ref": "#/components/schemas/UnderlayTrailSrc2" } } }, "TemplateAttributes1": { "title": "TemplateAttributes1", "type": "object", "properties": { "priority": { "type": "integer", "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.", "format": "int32" }, "referenceChangePolicy": { "$ref": "#/components/schemas/ReferenceChangePolicy" } } }, "Templates2": { "title": "Templates2", "type": "object", "properties": { "linkTemplate": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/LinkTemplate" } }, "nodeTemplate": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NodeTemplate" } } } }, "Tenant2": { "title": "Tenant2", "required": [ "tenantName" ], "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", "description": "The customer-id associated with the tenant. This is optional and default value is 1", "format": "int64" }, "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" } } }, "TeNodeAttributes2": { "title": "TeNodeAttributes2", "type": "object", "properties": { "adminStatus": { "$ref": "#/components/schemas/AdminStatus" }, "schedules": { "$ref": "#/components/schemas/Schedules2" }, "teNodeConnectivityMatrix": { "$ref": "#/components/schemas/TeNodeConnectivityMatrix1" }, "teNodeInfoAttributes": { "$ref": "#/components/schemas/TeNodeInfoAttributes1" } } }, "TeNodeAttributes3": { "title": "TeNodeAttributes3", "type": "object", "properties": { "adminStatus": { "$ref": "#/components/schemas/AdminStatus" }, "schedules": { "$ref": "#/components/schemas/Schedules2" }, "teNodeInfoAttributes": { "$ref": "#/components/schemas/TeNodeInfoAttributes1" } } }, "TeNodeConfig1": { "title": "TeNodeConfig1", "type": "object", "properties": { "teNodeAttributes": { "$ref": "#/components/schemas/TeNodeAttributes2" }, "teNodeTemplate": { "type": "array", "items": { "type": "string" }, "description": "The reference to a TE node template." }, "template": { "type": "object", "description": "This feature indicates that the system supports template configuration." } } }, "TeNodeConfigAttributesTemplate2": { "title": "TeNodeConfigAttributesTemplate2", "type": "object", "properties": { "teNodeAttributes": { "$ref": "#/components/schemas/TeNodeAttributes3" } } }, "TeNodeConnectivityMatrix1": { "title": "TeNodeConnectivityMatrix1", "type": "object", "properties": { "connectivityMatrix": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectivityMatrix" } } } }, "TeNodeId2": { "title": "TeNodeId2", "type": "object", "properties": { "dottedQuad": { "$ref": "#/components/schemas/UrlSafeString" } } }, "TeNodeInfoAttributes1": { "title": "TeNodeInfoAttributes1", "type": "object", "properties": { "domainId": { "type": "integer", "description": "Identifies the domain that this node belongs. This attribute is used to support inter-domain links.", "format": "int64" }, "isAbstract": { "type": "object", "description": "Present if the node is abstract, not present if the node is actual." }, "name": { "$ref": "#/components/schemas/UrlSafeString" }, "signalingAddress": { "type": "array", "items": { "$ref": "#/components/schemas/IpAddress" }, "description": "Node signaling address." }, "underlayTopology": { "$ref": "#/components/schemas/UnderlayTopology2" } } }, "TeNodeStateDerived2": { "title": "TeNodeStateDerived2", "type": "object", "properties": { "informationSource": { "$ref": "#/components/schemas/InformationSource" }, "informationSourceEntry": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TeNodeStateDerivedInformationSourceEntry" } }, "informationSourceState": { "$ref": "#/components/schemas/InformationSourceState2" }, "isMultiAccessDr": { "type": "object", "description": "The presence of this attribute indicates that this TE node is a pseudonode elected as a designated router." }, "operStatus": { "$ref": "#/components/schemas/OperStatus3" } } }, "TeNodeTunnelTerminationCapability1": { "title": "TeNodeTunnelTerminationCapability1", "type": "object", "properties": { "encoding": { "type": "object", "description": "Base identity for encoding types" }, "interLayerLockId": { "type": "integer", "description": "Inter layer lock ID, used for path computation in a TE topology covering multiple layers or multiple regions.", "format": "int64" }, "protectionType": { "type": "object", "description": "Base identity from which LSP protection types are derived." }, "switchingCapability": { "type": "object", "description": "Base identity for interface switching capabilities" }, "terminationCapability": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TerminationCapability" } } } }, "TerminationPointConfig2": { "title": "TerminationPointConfig2", "type": "object", "properties": { "terminationPointParams": { "$ref": "#/components/schemas/TerminationPointParams1" } } }, "TerminationPointParams1": { "title": "TerminationPointParams1", "type": "object", "properties": { "adjacencySegmentId": { "$ref": "#/components/schemas/AdjacencySegmentId1" }, "adjacencySegmentIdData": { "$ref": "#/components/schemas/AdjacencySegmentIdData1" }, "areaIds": { "type": "array", "items": { "type": "string" }, "description": "Identify the area in the network" }, "isisLevel": { "$ref": "#/components/schemas/IsisLevel" }, "prefixSid": { "$ref": "#/components/schemas/PrefixSid" }, "tpId": { "$ref": "#/components/schemas/TpId3" } } }, "TerminationPointState2": { "title": "TerminationPointState2", "type": "object", "properties": { "terminationPointParams": { "$ref": "#/components/schemas/TerminationPointParams1" } } }, "TeSrlgs2": { "title": "TeSrlgs2", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Srlg" }, "description": "SRLG value." } } }, "TeTerminationPointConfig1": { "title": "TeTerminationPointConfig1", "type": "object", "properties": { "interLayerLockId": { "type": "integer", "description": "Inter layer lock ID, used for path computation in a TE topology covering multiple layers or multiple regions.", "format": "int64" }, "interfaceSwitchingCapabilityList": { "$ref": "#/components/schemas/InterfaceSwitchingCapabilityList2" }, "schedules": { "$ref": "#/components/schemas/Schedules2" } } }, "TeTopologyConfig1": { "title": "TeTopologyConfig1", "type": "object", "properties": { "optimizationCriterion": { "type": "object", "description": "Base identity for TE optimization criterion." }, "preference": { "type": "integer", "description": "Specifies a preference for this topology. A lower number indicates a higher preference.", "format": "int32" }, "schedules": { "$ref": "#/components/schemas/Schedules1" } } }, "TeTopologyRef1": { "title": "TeTopologyRef1", "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." } } }, "TeTpId2": { "title": "TeTpId2", "type": "object", "properties": { "ipAddress": { "$ref": "#/components/schemas/IpAddress1" }, "uint32": { "type": "integer", "format": "int64" } } }, "ThresholdAcceleratedAdvertisement2": { "title": "ThresholdAcceleratedAdvertisement2", "type": "object", "properties": { "performanceMetricAttributes": { "$ref": "#/components/schemas/PerformanceMetricAttributes1" } } }, "ThresholdIn2": { "title": "ThresholdIn2", "type": "object", "properties": { "performanceMetricAttributes": { "$ref": "#/components/schemas/PerformanceMetricAttributes1" } } }, "ThresholdOut2": { "title": "ThresholdOut2", "type": "object", "properties": { "performanceMetricAttributes": { "$ref": "#/components/schemas/PerformanceMetricAttributes1" } } }, "Tier1Scheduler1": { "title": "Tier1Scheduler1", "type": "object", "properties": { "scheduler": { "$ref": "#/components/schemas/Scheduler2" } } }, "TimeDivisionMultiplexCapable2": { "title": "TimeDivisionMultiplexCapable2", "type": "object", "properties": { "indication": { "$ref": "#/components/schemas/Indication" }, "minimumLspBandwidth": { "type": "number", "description": "Minimum LSP Bandwidth. Units in bytes per second." } } }, "TimeRange2": { "title": "TimeRange2", "type": "object", "properties": { "endTime": { "$ref": "#/components/schemas/UrlSafeString" }, "startTime": { "$ref": "#/components/schemas/UrlSafeString" } } }, "To2": { "title": "To2", "type": "object", "properties": { "tpRef": { "type": "string", "description": "Relative reference to destination termination point." } } }, "Topology2": { "title": "Topology2", "type": "object", "properties": { "teTopologyRef": { "$ref": "#/components/schemas/TeTopologyRef1" } } }, "TpId1": { "title": "TpId1", "type": "object", "properties": { "uri": { "$ref": "#/components/schemas/UrlSafeString" } } }, "TpId3": { "title": "TpId3", "type": "object", "properties": { "ipAddress": { "$ref": "#/components/schemas/IpAddress1" }, "uint32": { "type": "integer", "format": "int64" } } }, "TpRef1": { "title": "TpRef1", "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.)" } } }, "Underlay1": { "title": "Underlay1", "type": "object", "properties": { "teLinkStateUnderlayAttributes": { "$ref": "#/components/schemas/TeLinkStateUnderlayAttributes1" }, "teTopologyHierarchy": { "type": "object", "description": "This feature indicates that the system allows underlay and/or overlay TE topology hierarchy." } } }, "Underlay3": { "title": "Underlay3", "type": "object", "properties": { "teLinkStateUnderlayAttributes": { "$ref": "#/components/schemas/TeLinkStateUnderlayAttributes1" }, "teLinkUnderlayAttributes": { "$ref": "#/components/schemas/TeLinkUnderlayAttributes2" }, "teTopologyHierarchy": { "type": "object", "description": "This feature indicates that the system allows underlay and/or overlay TE topology hierarchy." } } }, "UnderlayPrimaryPath2": { "title": "UnderlayPrimaryPath2", "type": "object", "properties": { "pathElement": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TePathElement" } }, "teTopologyRef": { "$ref": "#/components/schemas/TeTopologyRef1" } } }, "UnderlayTopology2": { "title": "UnderlayTopology2", "type": "object", "properties": { "teTopologyHierarchy": { "type": "object", "description": "This feature indicates that the system allows underlay and/or overlay TE topology hierarchy." }, "teTopologyRef": { "$ref": "#/components/schemas/TeTopologyRef1" } } }, "UnderlayTrailDes2": { "title": "UnderlayTrailDes2", "type": "object", "properties": { "tpRef": { "$ref": "#/components/schemas/TpRef1" } } }, "UnderlayTrailSrc2": { "title": "UnderlayTrailSrc2", "type": "object", "properties": { "tpRef": { "$ref": "#/components/schemas/TpRef1" } } }, "UniPortConfig2": { "title": "UniPortConfig2", "type": "object", "properties": { "adminState": { "$ref": "#/components/schemas/AdminState" }, "appId": { "type": "string", "description": "The client-defined, custom Application ID for the entity" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttribute" }, "description": "" }, "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", "description": "The inner tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "name": { "type": "string", "description": "The name of the endpoint" }, "outerTag": { "type": "integer", "description": "The outer tag. Applicable to Dot1Q or QinQ ports.", "format": "int32" }, "readOnly": { "type": "boolean", "description": "Specifies whether or not this request is read-only" } } }, "User2": { "title": "User2", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The user unique identifier" }, "name": { "type": "string", "description": "The user name" } } }, "Value": { "title": "Value", "type": "object", "properties": { "mplsLabel": { "$ref": "#/components/schemas/MplsLabel2" }, "srv6Sid": { "$ref": "#/components/schemas/Srv6Sid2" } } }, "VlanClassification1": { "title": "VlanClassification1", "type": "object", "properties": { "tagType": { "$ref": "#/components/schemas/UrlSafeString" }, "vlanRange": { "$ref": "#/components/schemas/UrlSafeString" }, "vlanValue": { "$ref": "#/components/schemas/VlanValue" } } }, "VlanId2": { "title": "VlanId2", "type": "object", "properties": { "uint16": { "type": "integer", "format": "int32" } } }, "VlanOperations1": { "title": "VlanOperations1", "type": "object", "properties": { "popTags": { "type": "integer", "description": "The number of VLAN tags to pop (or swap if used in conjunction with push-tags)", "format": "int32" }, "pushTags": { "$ref": "#/components/schemas/PushTags2" } } }, "VlanValue": { "title": "VlanValue", "type": "object", "properties": { "uint16": { "type": "integer", "format": "int32" } } }, "VlanWrite1": { "title": "VlanWrite1", "type": "object", "properties": { "tagType": { "$ref": "#/components/schemas/UrlSafeString" }, "vlanValue": { "$ref": "#/components/schemas/VlanValue" } } }, "WaitToRevertTime2": { "title": "WaitToRevertTime2", "type": "object", "properties": { "time": { "$ref": "#/components/schemas/Time" } } }, "WaitToSwitchTime2": { "title": "WaitToSwitchTime2", "type": "object", "properties": { "time": { "$ref": "#/components/schemas/Time" } } } }, "securitySchemes": { "RESTToken": { "type": "apiKey", "name": "Authorization", "in": "header" } } }, "security": [], "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": " " }, { "name": "sdn-path-tool", "description": "" }, { "name": "sdn-sr-policies", "description": "" } ] }