--- swagger: "2.0" info: description: "MEF 60 (PRESTO NRP) swagger definition" version: "2018R2" title: "Network Resource Provisioning" host: "localhost:1234" basePath: "/restconf" consumes: - "application/json" - "application/xml" produces: - "application/json" - "application/xml" paths: /data/context/: get: tags: - "tapi-common" description: "returns tapi.common.Context" parameters: [] responses: 200: description: "tapi.common.Context" schema: $ref: "#/definitions/tapi.common.Context" 400: description: "Internal error" /data/context/connection={uuid}/: get: tags: - "tapi-common" description: "returns tapi.connectivity.Connection" parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" responses: 200: description: "tapi.connectivity.Connection" schema: $ref: "#/definitions/tapi.connectivity.Connection" 400: description: "Internal error" /data/context/connection={uuid}/switch-control={switch-control-uuid}/: get: tags: - "tapi-common" description: "returns tapi.connectivity.SwitchControl" parameters: - name: "uuid" in: "path" description: "Id of connection" required: true type: "string" - name: "switch-control-uuid" in: "path" description: "Id of switch-control" required: true type: "string" responses: 200: description: "tapi.connectivity.SwitchControl" schema: $ref: "#/definitions/tapi.connectivity.SwitchControl" 400: description: "Internal error" /data/context/connectivity-service={uuid}/: get: tags: - "tapi-common" description: "returns tapi.connectivity.connectivitycontext.ConnectivityService" parameters: - name: "uuid" in: "path" description: "Id of connectivity-service" required: true type: "string" responses: 200: description: "tapi.connectivity.connectivitycontext.ConnectivityService" schema: $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" 400: description: "Internal error" /data/context/nw-topology-service/: get: tags: - "tapi-common" description: "returns tapi.topology.NetworkTopologyService" parameters: [] responses: 200: description: "tapi.topology.NetworkTopologyService" schema: $ref: "#/definitions/tapi.topology.NetworkTopologyService" 400: description: "Internal error" /data/context/path-comp-service={uuid}/: get: tags: - "tapi-common" description: "returns tapi.path.computation.PathComputationService" parameters: - name: "uuid" in: "path" description: "Id of path-comp-service" required: true type: "string" responses: 200: description: "tapi.path.computation.PathComputationService" schema: $ref: "#/definitions/tapi.path.computation.PathComputationService" 400: description: "Internal error" /data/context/path={uuid}/: get: tags: - "tapi-common" description: "returns tapi.path.computation.Path" parameters: - name: "uuid" in: "path" description: "Id of path" required: true type: "string" responses: 200: description: "tapi.path.computation.Path" schema: $ref: "#/definitions/tapi.path.computation.Path" 400: description: "Internal error" /data/context/service-interface-point={uuid}/: get: tags: - "tapi-common" description: "returns tapi.common.context.ServiceInterfacePoint" parameters: - name: "uuid" in: "path" description: "Id of service-interface-point" required: true type: "string" responses: 200: description: "tapi.common.context.ServiceInterfacePoint" schema: $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" 400: description: "Internal error" /data/context/topology={uuid}/: get: tags: - "tapi-common" description: "returns tapi.topology.Topology" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" responses: 200: description: "tapi.topology.Topology" schema: $ref: "#/definitions/tapi.topology.Topology" 400: description: "Internal error" /data/context/topology={uuid}/link={link-uuid}/: get: tags: - "tapi-common" description: "returns tapi.topology.Link" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - name: "link-uuid" in: "path" description: "Id of link" required: true type: "string" responses: 200: description: "tapi.topology.Link" schema: $ref: "#/definitions/tapi.topology.Link" 400: description: "Internal error" /data/context/topology={uuid}/node={node-uuid}/: get: tags: - "tapi-common" description: "returns tapi.topology.topology.Node" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - name: "node-uuid" in: "path" description: "Id of node" required: true type: "string" responses: 200: description: "tapi.topology.topology.Node" schema: $ref: "#/definitions/tapi.topology.topology.Node" 400: description: "Internal error" /data/context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/: get: tags: - "tapi-common" description: "returns tapi.topology.NodeRuleGroup" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - name: "node-uuid" in: "path" description: "Id of node" required: true type: "string" - name: "node-rule-group-uuid" in: "path" description: "Id of node-rule-group" required: true type: "string" responses: 200: description: "tapi.topology.NodeRuleGroup" schema: $ref: "#/definitions/tapi.topology.NodeRuleGroup" 400: description: "Internal error" /data/context/topology={uuid}/node={node-uuid}/node-rule-group={node-rule-group-uuid}/inter-rule-group={inter-rule-group-uuid}/: get: tags: - "tapi-common" description: "returns tapi.topology.InterRuleGroup" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - name: "node-uuid" in: "path" description: "Id of node" required: true type: "string" - name: "node-rule-group-uuid" in: "path" description: "Id of node-rule-group" required: true type: "string" - name: "inter-rule-group-uuid" in: "path" description: "Id of inter-rule-group" required: true type: "string" responses: 200: description: "tapi.topology.InterRuleGroup" schema: $ref: "#/definitions/tapi.topology.InterRuleGroup" 400: description: "Internal error" /data/context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/: get: tags: - "tapi-common" description: "returns tapi.topology.node.OwnedNodeEdgePoint" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - name: "node-uuid" in: "path" description: "Id of node" required: true type: "string" - name: "owned-node-edge-point-uuid" in: "path" description: "Id of owned-node-edge-point" required: true type: "string" responses: 200: description: "tapi.topology.node.OwnedNodeEdgePoint" schema: $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" 400: description: "Internal error" /data/context/topology={uuid}/node={node-uuid}/owned-node-edge-point={owned-node-edge-point-uuid}/connection-end-point={connection-end-point-uuid}/: get: tags: - "tapi-common" description: "returns tapi.connectivity.ConnectionEndPoint" parameters: - name: "uuid" in: "path" description: "Id of topology" required: true type: "string" - name: "node-uuid" in: "path" description: "Id of node" required: true type: "string" - name: "owned-node-edge-point-uuid" in: "path" description: "Id of owned-node-edge-point" required: true type: "string" - name: "connection-end-point-uuid" in: "path" description: "Id of connection-end-point" required: true type: "string" responses: 200: description: "tapi.connectivity.ConnectionEndPoint" schema: $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" 400: description: "Internal error" /operations/compute-p-2-p-path/: post: tags: - "tapi-path-computation" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.path.computation.ComputeP2PPathInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.path.computation.ComputeP2PPathOutput" 201: description: "No response" 400: description: "Internal error" /operations/create-connectivity-service/: post: tags: - "tapi-connectivity" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.connectivity.CreateConnectivityServiceInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.CreateConnectivityServiceOutput" 201: description: "No response" 400: description: "Internal error" /operations/delete-connectivity-service/: post: tags: - "tapi-connectivity" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.connectivity.DeleteConnectivityServiceInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.DeleteConnectivityServiceOutput" 201: description: "No response" 400: description: "Internal error" /operations/delete-p-2-p-path/: post: tags: - "tapi-path-computation" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.path.computation.DeleteP2PPathInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.path.computation.DeleteP2PPathOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-connection-details/: post: tags: - "tapi-connectivity" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.connectivity.GetConnectionDetailsInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.GetConnectionDetailsOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-connectivity-service-details/: post: tags: - "tapi-connectivity" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.connectivity.GetConnectivityServiceDetailsInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.GetConnectivityServiceDetailsOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-connectivity-service-list/: post: tags: - "tapi-connectivity" parameters: [] responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.GetConnectivityServiceListOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-link-details/: post: tags: - "tapi-topology" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.topology.GetLinkDetailsInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.topology.GetLinkDetailsOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-node-details/: post: tags: - "tapi-topology" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.topology.GetNodeDetailsInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.topology.GetNodeDetailsOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-node-edge-point-details/: post: tags: - "tapi-topology" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetailsInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.topology.GetNodeEdgePointDetailsOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-service-interface-point-details/: post: tags: - "tapi-common" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetailsInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.common.GetServiceInterfacePointDetailsOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-service-interface-point-list/: post: tags: - "tapi-common" parameters: [] responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.common.GetServiceInterfacePointListOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-topology-details/: post: tags: - "tapi-topology" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.topology.GetTopologyDetailsInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.topology.GetTopologyDetailsOutput" 201: description: "No response" 400: description: "Internal error" /operations/get-topology-list/: post: tags: - "tapi-topology" parameters: [] responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.topology.GetTopologyListOutput" 201: description: "No response" 400: description: "Internal error" /operations/optimize-p-2-p-path/: post: tags: - "tapi-path-computation" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.path.computation.OptimizeP2PPathInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.path.computation.OptimizeP2PPathOutput" 201: description: "No response" 400: description: "Internal error" /operations/update-connectivity-service/: post: tags: - "tapi-connectivity" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.connectivity.UpdateConnectivityServiceInput" responses: 200: description: "Correct response" schema: $ref: "#/definitions/tapi.connectivity.UpdateConnectivityServiceOutput" 201: description: "No response" 400: description: "Internal error" /operations/update-service-interface-point/: post: tags: - "tapi-common" parameters: - in: "body" name: "body-param" required: false schema: $ref: "#/definitions/tapi.common.UpdateServiceInterfacePointInput" responses: 201: description: "No response" 400: description: "Internal error" definitions: mef.common.BwpFlow: type: "object" properties: cir-max: type: "integer" format: "int64" description: "This attribute denotes the maximum Committed Information Rate\ \ that limits the rate of tokens added to the committed token bucket. In\ \ bits per second." envelope: description: "This attribute represents the relationship between the BwpFlow\ \ and the Envelope, indicating which Envelope the BwpFlow belongs." $ref: "#/definitions/mef.common.Envelope" token-request-offset: type: "integer" format: "int64" description: "This attribute adjusts the number of tokens requested for each\ \ external interface frame." coupling-flag: type: "boolean" description: "This attribute denotes the Coupling Flag that Determines if\ \ overflow Green tokens can be used as Yellow tokens. FALSE for 0 (overflow\ \ green tokens are discarded) and TRUE for 1 (overflow green tokens can\ \ be used as yellow tokens)" default: false cbs: type: "integer" format: "int64" description: "This attribute denotes the Committed Burst Size that limits\ \ the maximum number of bytes available for a burst of frames that will\ \ be declared Green, in bytes," color-mode: description: "This attribute denotes the Color Mode that Indicates whether\ \ the Color Identifier of the frame is considered by the Bandwidth Profile\ \ Algorithm." $ref: "#/definitions/mef.common.types.ColorMode" ebs: type: "integer" format: "int64" description: "This attribute denotes the Excessive Burst Size that limits\ \ the maximum number of bytes available for a burst of frames that will\ \ be declared Yellow, in bytes." rank: type: "integer" format: "int64" description: "This attribute denotes the rank of the bandwidth profile flow\ \ in the envelope." eir-max: type: "integer" format: "int64" description: "This attribute denotes the Maximum Excess Information Rate that\ \ Limits the rate of tokens added to the excess token bucket, in bits per\ \ second." cir: type: "integer" format: "int64" description: "This attribute denotes the Committed Information Rate that limits\ \ the average rate of frames that will be declared Green. In bits per second." eir: type: "integer" format: "int64" description: "This attribute denotes the Excess Information Rate that limits\ \ the average rate of frames that will be declared Yellow, in bits per second." mef.common.ColorIdentifier: type: "object" properties: dei-color-pac: description: "This attribute represents the relationship between the ColorIdentifier\ \ and the DeiColorIdPac (representing the choice that maps Vlan tag DEI\ \ to Color)." $ref: "#/definitions/mef.common.DeiColorIdPac" color-field-type: description: "This attribute determines which conditional package (among EVC/OVC\ \ End Point, PCP, DEI or DSCP) to be used as the Color Identifier." $ref: "#/definitions/mef.common.types.ColorFieldType" sep-color-pac: description: "This attribute represents the relationship between the ColorIdentifier\ \ and the SepColorIdPac (representing the choice that maps EVC End Point\ \ or OVC End Point to Color)." $ref: "#/definitions/mef.common.SepColorIdPac" dcsp-color-pac: type: "array" description: "This attribute represents the relationship between the ColorIdentifier\ \ and the DscpColorIdPac (representing the choice that maps DSCP values\ \ to Color)." items: $ref: "#/definitions/mef.common.DscpColorIdPac" pcp-color-pac: description: "This attribute represents the relationship between the ColorIdentifier\ \ and the PcpColorIdPac (representing the choice that maps Vlan tag PCPs\ \ to Color)." $ref: "#/definitions/mef.common.PcpColorIdPac" mef.common.CosIdentifier: type: "object" properties: pcp-cos-id-pac: description: "This attribute represents the relationship between the CosIdentifier\ \ and the PcpCosIdPac when the cosMappingType of EvcEndPoint or OvcEndPoint\ \ is PCP and the cosName is not only for L2CP." $ref: "#/definitions/mef.common.PcpCosIdPac" sep-cos-id-pac: description: "This attribute represents the relationship between the CosIdentifier\ \ and the SepCosIdPac when the cosMappingType of EvcEndPoint or OvcEndPoint\ \ is END_POINT and the cosName is not only for L2CP." $ref: "#/definitions/mef.common.SepCosIdPac" ingress-bwp-per-cos: description: "This attribute represents the relationship between the CosIdentifier\ \ and the BwpFlow, for ingress bandwidth profile per CoS Name." $ref: "#/definitions/mef.common.BwpFlow" l2cp-protocol-list: type: "array" description: "This attribute lists the L2CP Protocols that map to the Class\ \ of Service Name." items: $ref: "#/definitions/mef.common.types.L2cpProtocol" dscp-cos-id-pac: type: "array" description: "This attribute represents the relationship between the CosIdentifier\ \ and the DespCosIdPac when the cosMappingType of EvcEndPoint or OvcEndPoint\ \ is DSCP and the cosName is not only for L2CP." items: $ref: "#/definitions/mef.common.DscpCosIdPac" cos-name: type: "string" description: "This attribute denotes the Class of Service name that the CosIdentifier\ \ map to." mef.common.CosNameAndColorToDeiPac: type: "object" properties: ingress-cos-name: type: "string" description: "This attribute denotes the ingress CoS name." dei-value: description: "This attribute denotes the egress frame DEI value, mapped from\ \ ingress CoS Name and ingress frame color. " $ref: "#/definitions/mef.common.types.DeiOrDiscard" ingress-color: description: "This attribute denotes the ingress frame color as one of the\ \ determined factor for Egress Map. " $ref: "#/definitions/mef.common.types.FrameColor" mef.common.CosNameAndColorToPcpPac: type: "object" properties: ingress-cos-name: type: "string" description: "This attribute denotes the ingress CoS name." pcp-value: description: "This attribute denotes the egress frame PCP value, mapped from\ \ ingress CoS name and ingress frame color. " $ref: "#/definitions/mef.common.types.PcpOrDiscard" ingress-color: description: "This attribute denotes the ingress frame color as one of the\ \ determined factor for Egress Map. " $ref: "#/definitions/mef.common.types.FrameColor" mef.common.CosNameToPcpPac: type: "object" properties: pcp-value: description: "This attribute denotes the egress frame PCP value, mapped from\ \ ingress CoS Name and ingress frame color. " $ref: "#/definitions/mef.common.types.PcpOrDiscard" ingress-cos-name: type: "string" description: "This attribute denotes the ingress CoS name." mef.common.DeiColorIdPac: type: "object" mef.common.DscpColorIdPac: type: "object" properties: dscp-value-for-green-list: type: "array" description: "This attribute provides a list DSCP values map to the green\ \ ingress EI frames. The dscpValueForGreenList and the dscpValueForYellowList\ \ must disjoint and the union of the two lists must include all possible\ \ DSCP values." items: type: "integer" format: "int64" ip-version: description: "This attribute denotes which IP version is used. It can be IPV4,\ \ IPV6 or IPV4_AND_IPV6." $ref: "#/definitions/mef.common.types.IpVersion" dscp-value-for-yellow-list: type: "array" description: "This attribute provides a list DSCP values map to the yellow\ \ ingress EI frames. The dscpValueForGreenList and the dscpValueForYellowList\ \ must disjoint and the union of the two lists must include all possible\ \ DSCP values." items: type: "integer" format: "int64" mef.common.DscpCosIdPac: type: "object" properties: ip-version: description: "This attribute denotes the IP version for the DSCP. It can be\ \ IPV4, IPV6 or IPV4_AND_IPV6." $ref: "#/definitions/mef.common.types.IpVersion" dscp-value-list: type: "array" description: "This attribute is a list of DSCP values that maps to a CoS Name." items: type: "integer" format: "int64" mef.common.DscpEecIdPac: type: "object" properties: ip-version: description: "This attribute specifies the IP version for the DSCP. It can\ \ be IPV4, IPV6 or IPV4_AND_IPV6." $ref: "#/definitions/mef.common.types.IpVersion" dscp-value-list: type: "array" description: "This attribute is a list of DSCP values that maps to the EEC\ \ Name. " items: type: "integer" format: "int64" mef.common.EecIdentifier: type: "object" properties: egress-bwp-per-eec: description: "This attribute represents the relationship between the EecIdentifier\ \ and the BwpFlow, for egress bandwidth profile per EEC Name." $ref: "#/definitions/mef.common.BwpFlow" sep-eec-id-pac: description: "This attribute represents the relationship between the EecIdentifier\ \ and a SepEecIdPac when the eecMappingType of EvcEndPoint or OvcEndPoint\ \ is END_POINT and the eecName is not only for L2CP. This not addressed\ \ in MEF 10.3 but can be future consideration." $ref: "#/definitions/mef.common.SepEecIdPac" l2cp-protocol-list: type: "array" description: "This attribute lists the L2CP Protocols that map to the Egress\ \ Equivalence Class Name." items: $ref: "#/definitions/mef.common.types.L2cpProtocol" dscp-eec-id-pac: type: "array" description: "This attribute represents the relationship between the EecIdentifier\ \ and a DscpEecIdPac when the eecMappingType of EvcEndPoint or OvcEndPoint\ \ is DSCP and the eecName is not only for L2CP." items: $ref: "#/definitions/mef.common.DscpEecIdPac" pcp-eec-id-pac: description: "This attribute represents the relationship between the EecIdentifier\ \ and a PcpEecIdPac when the eecMappingType of EvcEndPoint or OvcEndPoint\ \ is PCP and the eecName is not only for L2CP." $ref: "#/definitions/mef.common.PcpEecIdPac" eec-name: type: "string" description: "This attribute denotes the Egress Equivalence Class Name that\ \ the EecIdentifier maps to." mef.common.EgressMap: type: "object" properties: cos-name-to-pcp-pac-list: type: "array" description: "This attribute represents the relationship between the EgressMap\ \ and the CosNameToPcpPac (representing the attribute set for using CoS\ \ Name to egress PCP mapping)." items: $ref: "#/definitions/mef.common.CosNameToPcpPac" egress-map-type: description: "This attribute determines which form to take to apply for egress\ \ frame color indication, among CoS name and Ingress Color to C-Tag PCP,\ \ or CoS name and Ingress Color to S-Tag PCP, or CoS Name and Ingress Color\ \ to C-Tag DEI, or CoS Name and Ingress Color to S-Tag DEI, or CoS Name\ \ to C-Tag PCP, or CoS Name to S-Tag PCP." $ref: "#/definitions/mef.common.types.EgressMapType" cos-name-and-color-to-pcp-pac-list: type: "array" description: "This attribute represents the relationship between the EgressMap\ \ and the CosNameAndColorToPcpPac (representing the attribute set for using\ \ CoS Name and ingress color to egress PCP mapping)." items: $ref: "#/definitions/mef.common.CosNameAndColorToPcpPac" cos-name-and-color-to-dei-pac-list: type: "array" description: "This attribute represents the relationship between the EgressMap\ \ and the CosNameAndColorToDeiPac (representing the attribute set for using\ \ CoS Name and ingress color to egress DEI mapping)." items: $ref: "#/definitions/mef.common.CosNameAndColorToDeiPac" mef.common.Envelope: type: "object" properties: coupling-flag-for-index-zero: type: "boolean" description: "This attribute denotes the coupling flag for index zero. FALSE\ \ for NO and TRUE for YES (overflow Green tokens can be used as Yellow tokens)" default: false envelope-id: type: "string" description: "This attribute is a string that identifies the Envelope." mef.common.PcpColorIdPac: type: "object" properties: pcp-value-for-yellow-list: type: "array" description: "This attribute provides a list PCP values map to the yellow\ \ ingress EI frames. The pcpValueForGreenList and the pcpValueForYellowList\ \ must disjoint and the union of the two lists must include all possible\ \ PCP values. " items: type: "integer" format: "int64" pcp-value-for-green-list: type: "array" description: "This attribute provides a list PCP values map to the green ingress\ \ EI frames. The pcpValueForGreenList and the pcpValueForYellowList must\ \ disjoint and the union of the two lists must include all possible PCP\ \ values. " items: type: "integer" format: "int64" mef.common.PcpCosIdPac: type: "object" properties: pcp-value-list: type: "array" description: "This attribute is a list of PCP values that map to the CoS Name. " items: type: "integer" format: "int64" mef.common.PcpEecIdPac: type: "object" properties: pcp-value-list: type: "array" description: "This attribute provides a list of PCP values that map to the\ \ Egress Equivalence Class Name." items: type: "integer" format: "int64" mef.common.SepColorIdPac: type: "object" properties: color: description: "This attribute denotes the color of the EI frame, green or yellow." $ref: "#/definitions/mef.common.types.FrameColor" mef.common.SepCosIdPac: type: "object" mef.common.SepEecIdPac: type: "object" mef.common.types.ColorFieldType: type: "string" enum: - "PCP" - "DEI" - "END_POINT" - "DSCP" mef.common.types.ColorMode: type: "string" enum: - "COLOR_AWARE" - "COLOR_BLIND" mef.common.types.CosOrEecMappingType: type: "string" enum: - "END_POINT" - "PCP" - "DSCP" mef.common.types.DeiOrDiscard: type: "string" enum: - "DISCARD" - "0" - "1" mef.common.types.EgressMapType: type: "string" enum: - "CN_C_TAG_PCP" - "CC_C_TAG_PCP" - "CC_C_TAG_DEI" - "CN_S_TAG_PCP" - "CC_S_TAG_PCP" - "CC_S_TAG_DEI" mef.common.types.FrameColor: type: "string" enum: - "GREEN" - "YELLOW" mef.common.types.IpVersion: type: "string" enum: - "IPV4" - "IPV6" - "IPV4_AND_IPV6" mef.common.types.L2cpAddressSet: type: "string" enum: - "CTA" - "CTB" - "CTB2" mef.common.types.L2cpPeering: type: "object" properties: protocol-id: description: "This is a L2CP Protocol Identifier." $ref: "#/definitions/mef.common.types.L2cpProtocol" link-id-list: type: "array" description: "It is possible that a protocol (e.g. ESMC) could operate on\ \ some, but not all, of the physical\n links. When linkId\ \ is not listed, the protocol peering applies to all members of the aggregation\ \ link." items: type: "integer" format: "int64" destination-address: type: "integer" format: "int64" description: "This is a Mac Address." mef.common.types.L2cpProtocol: type: "object" properties: sub-type: type: "integer" format: "int64" description: "This attribute specifies the subtype of the L2CP protocol." llc-address-or-ether-type: type: "integer" format: "int64" description: "This attribute specifies the LLC address or the EtherType value." l2cp-protocol-type: description: "This attribute specifies the type of L2CP protocol, i.e., LLC\ \ or EtherType." $ref: "#/definitions/mef.common.types.L2cpProtocolType" mef.common.types.L2cpProtocolType: type: "string" enum: - "ETHERTYPE" - "LLC" mef.common.types.PcpOrDiscard: type: "string" enum: - "DISCARD" - "0" - "1" - "2" - "3" - "4" - "5" - "6" - "7" mef.common.types.SourceMacAddressLimit: type: "object" properties: limit: type: "integer" format: "int64" description: "This attribute denotes the maximum acceptable source MAC addresses." time-interval: type: "integer" format: "int64" description: "This attribute denotes the time interval in milliseconds." mef.common.types.TaggedL2cpProcessing: type: "string" enum: - "802.1_COMPLIANT" - "802.1_NON_COMPLIANT" mef.common.types.VlanId: type: "object" properties: vlan-id: type: "integer" format: "int64" description: "This is the Vlan ID value." mef.common.types.VlanIdListing: type: "object" properties: type: description: "Can be LIST, or ALL, or EXCEPT." $ref: "#/definitions/mef.common.types.VlanIdMappingType" vlan-id-list: type: "array" description: "This is a list of Vlan IDs." items: $ref: "#/definitions/mef.common.types.VlanId" mef.common.types.VlanIdMappingType: type: "string" enum: - "ALL" - "EXCEPT" - "LIST" mef.common.types.VlanIdPreservation: type: "string" enum: - "PRESERVE" - "RETAIN" - "STRIP" nrm.connectivity.CarrierEthInterfaceResource: type: "object" properties: l2cp-peering-list: type: "array" description: "This attribute represents the L2CP Peering Service defined in\ \ MEF 45 section 8.2 when applied to the UNI/ENNI/INNI." items: $ref: "#/definitions/mef.common.types.L2cpPeering" max-frame-size: type: "integer" format: "int64" description: "This value indicates the maximum length of frames supported\ \ by this Interface." nrm.connectivity.DeliveryActionType: type: "string" enum: - "DISCARD" - "CONDITIONALLY" - "UNCONDITIONALLY" nrm.connectivity.FrameDeliveryCondition: type: "object" properties: action: description: "Data Service Frame disposition." $ref: "#/definitions/nrm.connectivity.DeliveryActionType" delivery-condition: type: "array" description: "When the value is conditionally, the conditions that determine\ \ whether a Data Service Frame is delivered or discarded MUST be specified.\ \ Conditions can be described in the name-value pair list, where name is\ \ used to represent the condition name or identifier, and value is used\ \ to represent the condition details associated to that name/identifier.\ \ Interoperability requires further standardization." items: $ref: "#/definitions/tapi.common.NameAndValue" nrm.connectivity.VlanIdListAndUntag: type: "object" properties: vlan-id: type: "array" description: "This is for VLAN ID from 1 to 4094" items: $ref: "#/definitions/mef.common.types.VlanId" vlan-id-mapping-type: description: "Type=LIST: all listed VLAN IDs. Type=EXCEPT: all VLAN IDs except\ \ the listed ones. Type=ALL, all VLAN IDs, hence vlanId list is not applicable." $ref: "#/definitions/mef.common.types.VlanIdMappingType" untagged-and-prio-tagged-included: type: "boolean" description: "If true, then untagged and priority tagged frames are included\ \ in the mapping, otherwise not." default: false nrp.interface.ConnectivityServiceAugmentation1: type: "object" properties: nrp-carrier-eth-connectivity-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthConnectivityResource" x-augmentation: prefix: "nrp-interface" namespace: "urn:mef:yang:nrp-interface" nrp.interface.CreateConnectivityServiceInputAugmentation1: type: "object" properties: nrp-carrier-eth-connectivity-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthConnectivityResource" x-augmentation: prefix: "nrp-interface" namespace: "urn:mef:yang:nrp-interface" nrp.interface.EndPointAugmentation1: type: "object" properties: nrp-carrier-eth-connectivity-end-point-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthConnectivityEndPointResource" x-augmentation: prefix: "nrp-interface" namespace: "urn:mef:yang:nrp-interface" nrp.interface.NrpCarrierEthConnectivityEndPointResource: type: "object" properties: egress-map-list: type: "array" description: "This attribute represents the relationship between the End Point\ \ and the Egress Map(s). This attribute is a set of mappings that determine\ \ the content of the S-Tag or C-Tag of an egress EI Frame.\n \ \ " items: $ref: "#/definitions/mef.common.EgressMap" l2cp-address-set: description: "This attribute specifies the subset of the Bridge Reserved Addresses\ \ that are filtered (i.e. L2CP Frames with this destination address are\ \ Peered or Discarded but not Passed) at a L2CP Decision Point." $ref: "#/definitions/mef.common.types.L2cpAddressSet" egress-bwp-flow: description: "This attribute denotes the relationship between a Connectivity\ \ Service End Point and the bandwidth profile flow. It describes egress\ \ policing on all egress EI Frames mapped to a given End Point." $ref: "#/definitions/mef.common.BwpFlow" eec-mapping-type: description: "The Egress Equivalence Class (EEC) is used to specify Egress\ \ Bandwidth Profiles. The EEC Mapping Type is one of SEP (Service End Point)\ \ based, PCP based or DSCP based.\n When the list\ \ of EEC Identifier is empty, this attribute shall be unset. Otherwise\ \ it shall be set." $ref: "#/definitions/mef.common.types.CosOrEecMappingType" ce-vlan-id-list-and-untag: description: "List of one or more C-VLAN ID values. A C-Tagged Frame, whose\ \ C-VLAN ID value matches an entry in this attribute, maps to the Connectivity\ \ Service End Point.\n It is possible to specify\ \ whether untagged and priority tagged frames are included in the mapping.\n\ \ Type=LIST: all listed VLAN IDs. Type=EXCEPT: all\ \ VLAN IDs except the listed ones. Type=ALL, all VLAN IDs, hence vlanId\ \ list is not applicable." $ref: "#/definitions/nrm.connectivity.VlanIdListAndUntag" leaf-svlan-id: description: "This attribute applies only to End Points with Trunk End Point\ \ Role. It identifies the S-VLAN ID of frames mapped to either a Leaf End\ \ Point or a Trunk End Point (via the Leaf S-VLAN ID value) of the Connectivity\ \ Service." $ref: "#/definitions/mef.common.types.VlanId" root-svlan-id: description: "This attribute applies only to End Points with Trunk End Point\ \ Role. It identifies the S-VLAN ID of frames mapped to either a Root End\ \ Point or a Trunk End Point (via the Root S-VLAN ID value) of the Connectivity\ \ Service." $ref: "#/definitions/mef.common.types.VlanId" cos-mapping-type: description: "The Class of Service (CoS) is used to specify ingress Bandwidth\ \ Profiles. The CoS Mapping Type is one of SEP (Service End Point) based,\ \ PCP based or DSCP based." $ref: "#/definitions/mef.common.types.CosOrEecMappingType" ingress-bwp-flow: description: " This attribute denotes the relationship between a Connectivity\ \ Service End Point and the bandwidth profile flow. It describes ingress\ \ policing on all ingress EI Frames mapped to a given End Point." $ref: "#/definitions/mef.common.BwpFlow" source-mac-address-limit: description: "This attribute limits the number of source MAC Addresses that\ \ can be used in ingress EI Frames mapped to the Connectivity Service End\ \ Point of all types over a time interval. When not present, the number\ \ of source MAC addresses is unlimited.\n Two independent\ \ parameters control the behavior of this attribute: N : A positive integer\ \ and t : A time interval.\n This attribute operates\ \ by maintaining a list of maximum length N of source MAC addresses which\ \ are aged-out of the list if not seen in a time interval t. If an ingress\ \ Service Frame arrives with a new source MAC address when the list is full,\ \ the Service Frame is discarded." $ref: "#/definitions/mef.common.types.SourceMacAddressLimit" eec-identifier-list: type: "array" description: "This attribute represents the relationship between the Connectivity\ \ Service End Point and the Egress Equivalence Class Identifier(s)." items: $ref: "#/definitions/mef.common.EecIdentifier" cos-identifier-list: type: "array" description: "This attribute represents the relationship between the Connectivity\ \ Service End Point and the Class of Service Identifier(s)." items: $ref: "#/definitions/mef.common.CosIdentifier" s-vlan-id-list: description: "List of one or more S-VLAN ID values. An S-Tagged Frame, whose\ \ S-VLAN ID value matches an entry in this attribute, maps to the Connectivity\ \ Service End Point.\n Type=LIST: all listed VLAN\ \ IDs. Type=EXCEPT: all VLAN IDs except the listed ones. Type=ALL, all VLAN\ \ IDs, hence vlanId list is not applicable.\n " $ref: "#/definitions/mef.common.types.VlanIdListing" color-identifier: description: "This attribute represents the relationship between the Connectivity\ \ Service End Point and a Color Identifier." $ref: "#/definitions/mef.common.ColorIdentifier" nrp.interface.NrpCarrierEthConnectivityResource: type: "object" properties: ce-vlan-id-preservation: description: "This attribute describes a relationship between the format of\ \ the VLAN ID and related fields values of the frame at one Interface and\ \ the format and VLAN ID and related fields values of the corresponding\ \ frame at another Interface.\n Used the MEF 7.3\ \ OVC type (PRESERVE/STRIP/RETAIN) as it depends on EVC/OVC decomposition\ \ performed by SOFs.\n " $ref: "#/definitions/mef.common.types.VlanIdPreservation" ce-vlan-pcp-preservation: type: "boolean" description: "This attribute can be used to preserve the value of the CE-VLAN\ \ PCP field in VLAN Tagged Service Frames across a Connectivity Service." default: false s-vlan-dei-preservation: type: "boolean" description: "This attribute describes a relationship between the S-VLAN DEI\ \ value of a frame at one ENNI and the S-VLAN DEI of the corresponding frame\ \ at another ENNI supported by the Operator CEN where each ENNI has a Connectivity\ \ Service End Point that is associated by the Connectivity Service." default: false max-frame-size: type: "integer" format: "int64" description: "This attribute denotes the maximum frame size in bytes requested\ \ for the connectivity service." multipoint-capable: type: "boolean" description: "A value of “true” indicates that the End Points can be added/removed\ \ during Connectivity Service lifecycle." default: false broadcast-frame-delivery: description: "When the value is conditionally, the conditions that determine\ \ whether a Data Service Frame is delivered or discarded MUST be specified.\ \ Conditions can be described in the name-value pair list." $ref: "#/definitions/nrm.connectivity.FrameDeliveryCondition" s-vlan-pcp-preservation: type: "boolean" description: "This attribute describes a relationship between the S-VLAN PCP\ \ value of a frame at one ENNI and the S-VLAN PCP of the corresponding frame\ \ at another ENNI supported by the Operator CEN where each ENNI has a Connectivity\ \ Service End Point that is associated by the Connectivity Service." default: false ce-vlan-dei-preservation: type: "boolean" description: "This attribute can be used to preserve the value of the CE-VLAN\ \ DEI field in VLAN Tagged Service Frames across a Connectivity Service." default: false multicast-frame-delivery: description: "When the value is conditionally, the conditions that determine\ \ whether a Data Service Frame is delivered or discarded MUST be specified.\ \ Conditions can be described in the name-value pair list." $ref: "#/definitions/nrm.connectivity.FrameDeliveryCondition" unicast-frame-delivery: description: "When the value is conditionally, the conditions that determine\ \ whether a Data Service Frame is delivered or discarded MUST be specified.\ \ Conditions can be described in the name-value pair list." $ref: "#/definitions/nrm.connectivity.FrameDeliveryCondition" nrp.interface.NrpCarrierEthEnniNResource: allOf: - $ref: "#/definitions/nrm.connectivity.CarrierEthInterfaceResource" - type: "object" properties: tagged-l2cp-processing: description: "This attribute represents the Tagged L2CP Processing defined\ \ in MEF 45 section 8.3 (IEEE 802.1 compliant or 802.1 non-compliant.\ \ Desired to be 802.1 compliant). It is one of the ENNI Operator Multi-lateral\ \ attributes, which requires the CENs at the ENNI-N to agree on the values\ \ but may allow these values to be different." $ref: "#/definitions/mef.common.types.TaggedL2cpProcessing" description: "This class represents ENNI-N management function. It augments\ \ the ONF TAPI ServiceInterfacePoint class at the Ethernet frame layer." nrp.interface.NrpCarrierEthInniNResource: type: "object" properties: l2cp-peering-list: type: "array" description: "This attribute represents the L2CP Peering Service defined in\ \ MEF 45 section 8.2 when applied to the UNI/ENNI/INNI." items: $ref: "#/definitions/mef.common.types.L2cpPeering" max-frame-size: type: "integer" format: "int64" description: "This value indicates the maximum length of frames supported\ \ by this Interface." nrp.interface.NrpCarrierEthUniNResource: allOf: - $ref: "#/definitions/nrm.connectivity.CarrierEthInterfaceResource" - type: "object" properties: ingress-bwp-flow: description: "This attribute represents the relationship between the UNI-N\ \ and the ingress BwpFlow." $ref: "#/definitions/mef.common.BwpFlow" elmi-pe-mode-enabled: type: "boolean" description: "This attribute denotes whether the ELMI is enabled or not.\ \ When the value is TRUE, the CEN MUST meet the mandatory requirements\ \ in MEF 16 that apply to the UNI-N.\n Note: Ethernel\ \ Local Management Interface protocol contents are defined which clearly\ \ identify MEF Service/Resource constructs like UNI and EVC, hence the\ \ attribute cannot be placed in an ethernet generic class." default: false egress-bwp-flow: description: "This attribute represents the relationship between the UNI-N\ \ and the egress BwpFlow. " $ref: "#/definitions/mef.common.BwpFlow" description: "This class represents UNI-N management function. It augments the\ \ ONF TAPI ServiceInterfacePoint class at the Ethernet frame layer. " nrp.interface.ServiceAugmentation1: type: "object" properties: nrp-carrier-eth-connectivity-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthConnectivityResource" x-augmentation: prefix: "nrp-interface" namespace: "urn:mef:yang:nrp-interface" nrp.interface.ServiceInterfacePointAugmentation1: type: "object" properties: nrp-carrier-eth-inni-n-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthInniNResource" nrp-carrier-eth-uni-n-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthUniNResource" nrp-carrier-eth-enni-n-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthEnniNResource" x-augmentation: prefix: "nrp-interface" namespace: "urn:mef:yang:nrp-interface" nrp.interface.SipAugmentation1: type: "object" properties: nrp-carrier-eth-inni-n-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthInniNResource" nrp-carrier-eth-uni-n-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthUniNResource" nrp-carrier-eth-enni-n-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthEnniNResource" x-augmentation: prefix: "nrp-interface" namespace: "urn:mef:yang:nrp-interface" nrp.interface.UpdateConnectivityServiceInputAugmentation1: type: "object" properties: nrp-carrier-eth-connectivity-resource: description: "none" $ref: "#/definitions/nrp.interface.NrpCarrierEthConnectivityResource" x-augmentation: prefix: "nrp-interface" namespace: "urn:mef:yang:nrp-interface" tapi.common.AdminStatePac: type: "object" properties: operational-state: description: "none" $ref: "#/definitions/tapi.common.OperationalState" lifecycle-state: description: "none" $ref: "#/definitions/tapi.common.LifecycleState" administrative-state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" tapi.common.AdministrativeState: type: "string" enum: - "LOCKED" - "UNLOCKED" tapi.common.BandwidthProfile: type: "object" properties: committed-information-rate: description: "none" $ref: "#/definitions/tapi.common.CapacityValue" coupling-flag: type: "boolean" description: "none" default: false bw-profile-type: description: "none" $ref: "#/definitions/tapi.common.BandwidthProfileType" peak-information-rate: description: "none" $ref: "#/definitions/tapi.common.CapacityValue" committed-burst-size: description: "none" $ref: "#/definitions/tapi.common.CapacityValue" peak-burst-size: description: "none" $ref: "#/definitions/tapi.common.CapacityValue" color-aware: type: "boolean" description: "none" default: false tapi.common.BandwidthProfileType: type: "string" enum: - "MEF_10.x" - "RFC_2697" - "RFC_2698" - "RFC_4115" tapi.common.Capacity: type: "object" properties: bandwidth-profile: description: "none" $ref: "#/definitions/tapi.common.BandwidthProfile" total-size: description: "Total capacity of the TopologicalEntity in MB/s. In case of\ \ bandwidthProfile, this is expected to same as the committedInformationRate." $ref: "#/definitions/tapi.common.CapacityValue" tapi.common.CapacityPac: type: "object" properties: available-capacity: description: "Capacity available to be assigned." $ref: "#/definitions/tapi.common.Capacity" total-potential-capacity: description: "An optimistic view of the capacity of the TopologicalEntity\ \ assuming that any shared capacity is available to be taken." $ref: "#/definitions/tapi.common.Capacity" tapi.common.CapacityUnit: type: "string" enum: - "TB" - "TBPS" - "GB" - "GBPS" - "MB" - "MBPS" - "KB" - "KBPS" tapi.common.CapacityValue: type: "object" properties: value: type: "integer" format: "int32" description: "none" unit: description: "none" $ref: "#/definitions/tapi.common.CapacityUnit" tapi.common.Context: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ContextAugmentation2" - $ref: "#/definitions/tapi.path.computation.ContextAugmentation1" - $ref: "#/definitions/tapi.topology.ContextAugmentation3" - type: "object" properties: service-interface-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.common.context.ServiceInterfacePoint" description: "none" tapi.common.DirectiveValue: type: "string" enum: - "MINIMIZE" - "MAXIMIZE" - "ALLOW" - "DISALLOW" - "DONT_CARE" tapi.common.ForwardingDirection: type: "string" enum: - "BIDIRECTIONAL" - "UNIDIRECTIONAL" - "UNDEFINED_OR_UNKNOWN" tapi.common.GetServiceInterfacePointDetailsInput: properties: input: type: "object" properties: sip-id-or-name: type: "string" description: "none" tapi.common.GetServiceInterfacePointDetailsOutput: properties: output: type: "object" properties: sip: description: "none" $ref: "#/definitions/tapi.common.getserviceinterfacepointdetails.output.Sip" tapi.common.GetServiceInterfacePointListOutput: properties: output: type: "object" properties: sip: type: "array" description: "none" items: $ref: "#/definitions/tapi.common.getserviceinterfacepointlist.output.Sip" tapi.common.GlobalClass: type: "object" properties: name: type: "array" description: "List of names. A property of an entity with a value that is\ \ unique in some namespace but may change during the life of the entity.\ \ A name carries no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" uuid: type: "string" description: "UUID: An identifier that is universally unique within an identifier\ \ space, where the identifier space is itself globally unique, and immutable.\ \ An UUID carries no semantics with respect to the purpose or state of the\ \ entity.\n UUID here uses string representation as defined\ \ in RFC 4122. The canonical representation uses lowercase characters.\n\ \ Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-'\ \ + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12} \n Example of a UUID\ \ in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6" tapi.common.LayerProtocolName: type: "string" enum: - "OTSiA" - "OCH" - "OTU" - "ODU" - "ETH" - "ETY" - "DSR" tapi.common.LifecycleState: type: "string" enum: - "PLANNED" - "POTENTIAL_AVAILABLE" - "POTENTIAL_BUSY" - "INSTALLED" - "PENDING_REMOVAL" tapi.common.LocalClass: type: "object" properties: name: type: "array" description: "List of names. A property of an entity with a value that is\ \ unique in some namespace but may change during the life of the entity.\ \ A name carries no semantics with respect to the purpose of the entity." items: $ref: "#/definitions/tapi.common.NameAndValue" local-id: type: "string" description: "none" tapi.common.NameAndValue: type: "object" properties: value-name: type: "string" description: "The name of the value. The value need not have a name." value: type: "string" description: "The value" tapi.common.OperationalState: type: "string" enum: - "DISABLED" - "ENABLED" tapi.common.OperationalStatePac: type: "object" properties: operational-state: description: "none" $ref: "#/definitions/tapi.common.OperationalState" lifecycle-state: description: "none" $ref: "#/definitions/tapi.common.LifecycleState" tapi.common.PortDirection: type: "string" enum: - "BIDIRECTIONAL" - "INPUT" - "OUTPUT" - "UNIDENTIFIED_OR_UNKNOWN" tapi.common.PortRole: type: "string" enum: - "SYMMETRIC" - "ROOT" - "LEAF" - "TRUNK" - "UNKNOWN" tapi.common.ServiceInterfacePoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.CapacityPac" - $ref: "#/definitions/tapi.common.GlobalClass" - type: "object" properties: layer-protocol-name: type: "array" description: "Usage of layerProtocolName [>1] in the ServiceInterfacePoint\ \ should be considered experimental" items: $ref: "#/definitions/tapi.common.LayerProtocolName" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers. \n\ \ The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.common.ServiceInterfacePointRef: type: "object" properties: service-interface-point-id: type: "string" x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" tapi.common.TerminationDirection: type: "string" enum: - "BIDIRECTIONAL" - "SINK" - "SOURCE" - "UNDEFINED_OR_UNKNOWN" tapi.common.TerminationPac: type: "object" properties: termination-direction: description: "The overall directionality of the LP. \n \ \ - A BIDIRECTIONAL LP will have some SINK and/or SOURCE flowss.\n \ \ - A SINK LP can only contain elements with SINK flows or\ \ CONTRA_DIRECTION_SOURCE flows\n - A SOURCE LP can only\ \ contain SOURCE flows or CONTRA_DIRECTION_SINK flows" $ref: "#/definitions/tapi.common.TerminationDirection" termination-state: description: "Indicates whether the layer is terminated and if so how." $ref: "#/definitions/tapi.common.TerminationState" tapi.common.TerminationState: type: "string" enum: - "LP_CAN_NEVER_TERMINATE" - "LT_NOT_TERMINATED" - "TERMINATED_SERVER_TO_CLIENT_FLOW" - "TERMINATED_CLIENT_TO_SERVER_FLOW" - "TERMINATED_BIDIRECTIONAL" - "LT_PERMENANTLY_TERMINATED" - "TERMINATION_STATE_UNKNOWN" tapi.common.TimeRange: type: "object" properties: end-time: type: "string" description: "none" start-time: type: "string" description: "none" tapi.common.UpdateServiceInterfacePointInput: properties: input: type: "object" properties: sip-id-or-name: type: "string" description: "none" state: description: "none" $ref: "#/definitions/tapi.common.AdministrativeState" tapi.common.context.ServiceInterfacePoint: allOf: - $ref: "#/definitions/nrp.interface.ServiceInterfacePointAugmentation1" - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" tapi.common.getserviceinterfacepointdetails.output.Sip: allOf: - $ref: "#/definitions/nrp.interface.SipAugmentation1" - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" tapi.common.getserviceinterfacepointlist.output.Sip: allOf: - $ref: "#/definitions/nrp.interface.SipAugmentation1" - $ref: "#/definitions/tapi.common.ServiceInterfacePoint" tapi.connectivity.Connection: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.common.OperationalStatePac" - type: "object" properties: lower-connection: type: "array" description: "An Connection object supports a recursive aggregation relationship\ \ such that the internal construction of an Connection can be exposed\ \ as multiple lower level Connection objects (partitioning).\n \ \ Aggregation is used as for the Node/Topology to allow changes\ \ in hierarchy.\n Connection aggregation reflects Node/Topology\ \ aggregation.\n The FC represents a Cross-Connection\ \ in an NE. The Cross-Connection in an NE is not necessarily the lowest\ \ level of FC partitioning." items: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:uuid" switch-control: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.SwitchControl" route: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.Route" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The ForwardingConstruct (FC) object class models enabled potential\ \ for forwarding between two or more LTPs and like the LTP supports any transport\ \ protocol including all circuit and packet forms.\n At the\ \ lowest level of recursion, a FC represents a cross-connection within an\ \ NE." tapi.connectivity.ConnectionEndPoint: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.common.OperationalStatePac" - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: client-node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.OwnedNodeEdgePointRef" connectivity-service-end-point: type: "string" description: "none" x-path: "/tapi-common:context/tapi-connectivity:connectivity-service/tapi-connectivity:end-point/tapi-connectivity:local-id" connection-port-role: description: "Each EP of the FC has a role (e.g., working, protection, protected,\ \ symmetric, hub, spoke, leaf, root) in the context of the FC with respect\ \ to the FC function. " $ref: "#/definitions/tapi.common.PortRole" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" parent-node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.OwnedNodeEdgePointRef" connection-port-direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers.\n\ \ The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.connectivity.ConnectionEndPointRef: allOf: - $ref: "#/definitions/tapi.topology.OwnedNodeEdgePointRef" - type: "object" properties: connection-end-point-id: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" tapi.connectivity.ConnectionRef: type: "object" properties: connection-id: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:uuid" tapi.connectivity.ConnectivityConstraint: allOf: - $ref: "#/definitions/tapi.connectivity.RouteComputePolicy" - type: "object" properties: schedule: description: "none" $ref: "#/definitions/tapi.common.TimeRange" requested-capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" is-exclusive: type: "boolean" description: "To distinguish if the resources are exclusive to the service\ \ - for example between EPL(isExclusive=true) and EVPL (isExclusive=false),\ \ or between EPLAN (isExclusive=true) and EVPLAN (isExclusive=false)" default: true diversity-exclusion: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectivityServiceRef" service-level: type: "string" description: "An abstract value the meaning of which is mutually agreed\ \ – typically represents metrics such as - Class of service, priority,\ \ resiliency, availability" service-type: description: "none" $ref: "#/definitions/tapi.connectivity.ServiceType" cost-characteristic: type: "array" description: "The list of costs where each cost relates to some aspect of\ \ the TopologicalEntity." items: $ref: "#/definitions/tapi.topology.CostCharacteristic" latency-characteristic: type: "array" description: "The effect on the latency of a queuing process. This only\ \ has significant effect for packet based systems and has a complex characteristic." items: $ref: "#/definitions/tapi.topology.LatencyCharacteristic" coroute-inclusion: type: "string" description: "none" x-path: "/tapi-common:context/tapi-connectivity:connectivity-service/tapi-connectivity:uuid" description: "none" tapi.connectivity.ConnectivityServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: protection-role: description: "To specify the protection role of this Port when create or\ \ update ConnectivityService." $ref: "#/definitions/tapi.connectivity.ProtectionRole" role: description: "Each EP of the FC has a role (e.g., working, protection, protected,\ \ symmetric, hub, spoke, leaf, root) in the context of the FC with respect\ \ to the FC function. " $ref: "#/definitions/tapi.common.PortRole" service-interface-point: description: "none" $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" description: "The association of the FC to LTPs is made via EndPoints.\n \ \ The EndPoint (EP) object class models the access to the FC function.\n\ \ The traffic forwarding between the associated EPs of the\ \ FC depends upon the type of FC and may be associated with FcSwitch object\ \ instances.\n In cases where there is resilience the EndPoint\ \ may convey the resilience role of the access to the FC.\n \ \ It can represent a protected (resilient/reliable) point or a protecting\ \ (unreliable working or protection) point.\n The EP replaces\ \ the Protection Unit of a traditional protection model.\n \ \ The ForwadingConstruct can be considered as a component and the EndPoint\ \ as a Port on that component" tapi.connectivity.ConnectivityServiceRef: type: "object" properties: connectivity-service-id: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connectivity-service/tapi-connectivity:uuid" tapi.connectivity.ContextAugmentation2: type: "object" properties: connectivity-service: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.connectivitycontext.ConnectivityService" connection: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.Connection" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" tapi.connectivity.CoordinateType: type: "string" enum: - "NO_COORDINATE" - "HOLD_OFF_TIME" - "WAIT_FOR_NOTIFICATION" tapi.connectivity.CreateConnectivityServiceInput: properties: input: $ref: "#/definitions/tapi.connectivity.CreateConnectivityServiceInputInput" tapi.connectivity.CreateConnectivityServiceInputInput: allOf: - $ref: "#/definitions/nrp.interface.CreateConnectivityServiceInputAugmentation1" - type: "object" properties: topo-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.TopologyConstraint" state: type: "string" description: "none" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.createconnectivityservice.input.EndPoint" conn-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" resilience-constraint: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" description: "" tapi.connectivity.CreateConnectivityServiceOutput: properties: output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.createconnectivityservice.output.Service" tapi.connectivity.DeleteConnectivityServiceInput: properties: input: type: "object" properties: service-id-or-name: type: "string" description: "none" tapi.connectivity.DeleteConnectivityServiceOutput: properties: output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.deleteconnectivityservice.output.Service" tapi.connectivity.DiversityPolicy: type: "string" enum: - "SRLG" - "SRNG" - "SNG" - "NODE" - "LINK" tapi.connectivity.GetConnectionDetailsInput: properties: input: type: "object" properties: service-id-or-name: type: "string" description: "none" connection-id-or-name: type: "string" description: "none" tapi.connectivity.GetConnectionDetailsOutput: properties: output: type: "object" properties: connection: description: "none" $ref: "#/definitions/tapi.connectivity.Connection" tapi.connectivity.GetConnectivityServiceDetailsInput: properties: input: type: "object" properties: service-id-or-name: type: "string" description: "none" tapi.connectivity.GetConnectivityServiceDetailsOutput: properties: output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.getconnectivityservicedetails.output.Service" tapi.connectivity.GetConnectivityServiceListOutput: properties: output: type: "object" properties: service: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.output.Service" tapi.connectivity.OwnedNodeEdgePointAugmentation1: type: "object" properties: connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPoint" x-augmentation: prefix: "tapi-connectivity" namespace: "urn:onf:otcc:yang:tapi-connectivity" tapi.connectivity.ProtectionRole: type: "string" enum: - "WORK" - "PROTECT" - "PROTECTED" - "NA" - "WORK_RESTORE" - "PROTECT_RESTORE" tapi.connectivity.ResilienceConstraint: type: "object" properties: is-lock-out: type: "boolean" description: "The resource is configured to temporarily not be available for\ \ use in the protection scheme(s) it is part of.\n This\ \ overrides all other protection control states including forced.\n \ \ If the item is locked out then it cannot be used under\ \ any circumstances.\n Note: Only relevant when part\ \ of a protection scheme." default: false max-switch-times: type: "integer" format: "int32" description: "Used to limit the maximum swtich times. When work fault disappears\ \ , and traffic return to the original work path, switch counter reset." restoration-coordinate-type: description: " The coordination mechanism between multi-layers." $ref: "#/definitions/tapi.connectivity.CoordinateType" is-coordinated-switching-both-ends: 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." default: false hold-off-time: type: "integer" format: "int32" description: "This attribute indicates the time, in milliseconds, between\ \ declaration of signal degrade or signal fail, and the initialization of\ \ the protection switching algorithm." is-frozen: type: "boolean" description: "Temporarily prevents any switch action to be taken and, as such,\ \ freezes the current state.\n Until the freeze is cleared,\ \ additional near-end external commands are rejected and fault condition\ \ changes and received APS messages are ignored.\n All\ \ administrative controls of any aspect of protection are rejected." default: false wait-to-revert-time: type: "integer" format: "int32" 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." default: 15 layer-protocol: description: "Indicate which layer this resilience parameters package configured\ \ for." $ref: "#/definitions/tapi.common.LayerProtocolName" resilience-type: description: "none" $ref: "#/definitions/tapi.topology.ResilienceType" restore-priority: type: "integer" format: "int32" description: "none" reversion-mode: description: "Indcates whether the protection scheme is revertive or non-revertive." $ref: "#/definitions/tapi.connectivity.ReversionMode" tapi.connectivity.ReversionMode: type: "string" enum: - "REVERTIVE" - "NON-REVERTIVE" tapi.connectivity.Route: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: connection-end-point: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-connectivity:connection-end-point/tapi-connectivity:uuid" description: "The FC Route (FcRoute) object class models the individual routes\ \ of an FC.\n The route of an FC object is represented by a\ \ list of FCs at a lower level.\n Note that depending on the\ \ service supported by an FC, an the FC can have multiple routes." tapi.connectivity.RouteComputePolicy: type: "object" properties: diversity-policy: description: "none" $ref: "#/definitions/tapi.connectivity.DiversityPolicy" route-objective-function: description: "none" $ref: "#/definitions/tapi.connectivity.RouteObjectiveFunction" tapi.connectivity.RouteObjectiveFunction: type: "string" enum: - "MIN_WORK_ROUTE_HOP" - "MIN_WORK_ROUTE_COST" - "MIN_WORK_ROUTE_LATENCY" - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_HOP" - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_COST" - "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_LATENCY" - "LOAD_BALANCE_MAX_UNUSED_CAPACITY" tapi.connectivity.SelectionControl: type: "string" enum: - "LOCK_OUT" - "NORMAL" - "MANUAL" - "FORCED" tapi.connectivity.SelectionReason: type: "string" enum: - "LOCKOUT" - "NORMAL" - "MANUAL" - "FORCED" - "WAIT_TO_REVERT" - "SIGNAL_DEGRADE" - "SIGNAL_FAIL" tapi.connectivity.ServiceType: type: "string" enum: - "POINT_TO_POINT_CONNECTIVITY" - "POINT_TO_MULTIPOINT_CONNECTIVITY" - "MULTIPOINT_CONNECTIVITY" - "ROOTED_MULTIPOINT_CONNECTIVITY" tapi.connectivity.Switch: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: selected-connection-end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ConnectionEndPointRef" selected-route: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:route/tapi-connectivity:local-id" selection-control: description: "Degree of administrative control applied to the switch selection." $ref: "#/definitions/tapi.connectivity.SelectionControl" selection-reason: description: "The reason for the current switch selection." $ref: "#/definitions/tapi.connectivity.SelectionReason" switch-direction: description: "Indicates whether the switch selects from ingress to the FC\ \ or to egress of the FC, or both." $ref: "#/definitions/tapi.common.PortDirection" description: "The class models the switched forwarding of traffic (traffic flow)\ \ between FcPorts (ConnectionEndPoints) and is present where there is protection\ \ functionality in the FC (Connection).\n If an FC exposes\ \ protection (having two or more FcPorts that provide alternative identical\ \ inputs/outputs), the FC will have one or more associated FcSwitch objects\ \ to represent the alternative flow choices visible at the edge of the FC.\n\ \ The FC switch represents and defines a protection switch\ \ structure encapsulated in the FC.\n Essentially performs\ \ one of the functions of the Protection Group in a traditional model. It\ \ associates to 2 or more FcPorts each playing the role of a Protection Unit.\n\ \ One or more protection, i.e. standby/backup, FcPorts provide\ \ protection for one or more working (i.e. regular/main/preferred) FcPorts\ \ where either protection or working can feed one or more protected FcPort.\n\ \ The switch may be used in revertive or non-revertive (symmetric)\ \ mode. When in revertive mode it may define a waitToRestore time.\n \ \ It may be used in one of several modes including source switch,\ \ destination switched, source and destination switched etc (covering cases\ \ such as 1+1 and 1:1).\n It may be locked out (prevented from\ \ switching), force switched or manual switched.\n It will\ \ indicate switch state and change of state.\n The switch can\ \ be switched away from all sources such that it becomes open and hence two\ \ coordinated switches can both feed the same LTP so long as at least one\ \ of the two is switched away from all sources (is 'open').\n \ \ The ability for a Switch to be 'high impedance' allows bidirectional\ \ ForwardingConstructs to be overlaid on the same bidirectional LTP where\ \ the appropriate control is enabled to prevent signal conflict.\n \ \ This ability allows multiple alternate routes to be present that\ \ otherwise would be in conflict." tapi.connectivity.SwitchControl: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - type: "object" properties: sub-switch-control: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.SwitchControlRef" switch: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.Switch" description: "Represents the capability to control and coordinate switches,\ \ to add/delete/modify FCs and to add/delete/modify LTPs/LPs so as to realize\ \ a protection scheme." tapi.connectivity.SwitchControlRef: allOf: - $ref: "#/definitions/tapi.connectivity.ConnectionRef" - type: "object" properties: switch-control-id: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:switch-control/tapi-connectivity:uuid" tapi.connectivity.TopologyConstraint: type: "object" properties: include-node: type: "array" description: "This is a loose constraint - that is it is unordered and could\ \ be a partial list" items: $ref: "#/definitions/tapi.topology.NodeRef" exclude-link: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.LinkRef" avoid-topology: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.TopologyRef" exclude-path: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathRef" include-link: type: "array" description: "This is a loose constraint - that is it is unordered and could\ \ be a partial list " items: $ref: "#/definitions/tapi.topology.LinkRef" preferred-transport-layer: type: "array" description: "soft constraint requested by client to indicate the layer(s)\ \ of transport connection that it prefers to carry the service. This could\ \ be same as the service layer or one of the supported server layers" items: $ref: "#/definitions/tapi.common.LayerProtocolName" exclude-node: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeRef" include-topology: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.TopologyRef" include-path: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathRef" tapi.connectivity.UpdateConnectivityServiceInput: properties: input: $ref: "#/definitions/tapi.connectivity.UpdateConnectivityServiceInputInput" tapi.connectivity.UpdateConnectivityServiceInputInput: allOf: - $ref: "#/definitions/nrp.interface.UpdateConnectivityServiceInputAugmentation1" - type: "object" properties: service-id-or-name: type: "string" description: "none" end-point: description: "none" $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.input.EndPoint" resilience-constraint: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" topo-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.TopologyConstraint" state: type: "string" description: "none" conn-constraint: description: "none" $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" description: "" tapi.connectivity.UpdateConnectivityServiceOutput: properties: output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.output.Service" tapi.connectivity.connectivitycontext.ConnectivityService: allOf: - $ref: "#/definitions/nrp.interface.ConnectivityServiceAugmentation1" - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - $ref: "#/definitions/tapi.connectivity.TopologyConstraint" - type: "object" properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" connection: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:uuid" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.connectivityservice.EndPoint" direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.connectivityservice.EndPoint: allOf: - $ref: "#/definitions/nrp.interface.EndPointAugmentation1" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.connectivity.createconnectivityservice.input.EndPoint: allOf: - $ref: "#/definitions/nrp.interface.EndPointAugmentation1" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.connectivity.createconnectivityservice.output.Service: allOf: - $ref: "#/definitions/nrp.interface.ServiceAugmentation1" - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - $ref: "#/definitions/tapi.connectivity.TopologyConstraint" - type: "object" properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" connection: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:uuid" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.createconnectivityservice.output.service.EndPoint" direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.createconnectivityservice.output.service.EndPoint: allOf: - $ref: "#/definitions/nrp.interface.EndPointAugmentation1" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.connectivity.deleteconnectivityservice.output.Service: allOf: - $ref: "#/definitions/nrp.interface.ServiceAugmentation1" - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - $ref: "#/definitions/tapi.connectivity.TopologyConstraint" - type: "object" properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" connection: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:uuid" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.deleteconnectivityservice.output.service.EndPoint" direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.deleteconnectivityservice.output.service.EndPoint: allOf: - $ref: "#/definitions/nrp.interface.EndPointAugmentation1" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.connectivity.getconnectivityservicedetails.output.Service: allOf: - $ref: "#/definitions/nrp.interface.ServiceAugmentation1" - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - $ref: "#/definitions/tapi.connectivity.TopologyConstraint" - type: "object" properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" connection: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:uuid" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.getconnectivityservicedetails.output.service.EndPoint" direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.getconnectivityservicedetails.output.service.EndPoint: allOf: - $ref: "#/definitions/nrp.interface.EndPointAugmentation1" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.connectivity.getconnectivityservicelist.output.Service: allOf: - $ref: "#/definitions/nrp.interface.ServiceAugmentation1" - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - $ref: "#/definitions/tapi.connectivity.TopologyConstraint" - type: "object" properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" connection: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:uuid" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.getconnectivityservicelist.output.service.EndPoint" direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.getconnectivityservicelist.output.service.EndPoint: allOf: - $ref: "#/definitions/nrp.interface.EndPointAugmentation1" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.connectivity.updateconnectivityservice.input.EndPoint: allOf: - $ref: "#/definitions/nrp.interface.EndPointAugmentation1" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.connectivity.updateconnectivityservice.output.Service: allOf: - $ref: "#/definitions/nrp.interface.ServiceAugmentation1" - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.connectivity.ConnectivityConstraint" - $ref: "#/definitions/tapi.connectivity.ResilienceConstraint" - $ref: "#/definitions/tapi.connectivity.TopologyConstraint" - type: "object" properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" connection: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-connectivity:connection/tapi-connectivity:uuid" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.connectivity.updateconnectivityservice.output.service.EndPoint" direction: description: "none" $ref: "#/definitions/tapi.common.ForwardingDirection" description: "none" tapi.connectivity.updateconnectivityservice.output.service.EndPoint: allOf: - $ref: "#/definitions/nrp.interface.EndPointAugmentation1" - $ref: "#/definitions/tapi.connectivity.ConnectivityServiceEndPoint" tapi.path.computation.ComputeP2PPathInput: properties: input: type: "object" properties: routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" sep: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" tapi.path.computation.ComputeP2PPathOutput: properties: output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.path.computation.PathComputationService" tapi.path.computation.ContextAugmentation1: type: "object" properties: path-comp-service: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathComputationService" path: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.Path" x-augmentation: prefix: "tapi-path-computation" namespace: "urn:onf:otcc:yang:tapi-path-computation" tapi.path.computation.DeleteP2PPathInput: properties: input: type: "object" properties: path-id-or-name: type: "string" description: "none" tapi.path.computation.DeleteP2PPathOutput: properties: output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.path.computation.PathComputationService" tapi.path.computation.OptimizeP2PPathInput: properties: input: type: "object" properties: routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" path-id-or-name: type: "string" description: "none" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" tapi.path.computation.OptimizeP2PPathOutput: properties: output: type: "object" properties: service: description: "none" $ref: "#/definitions/tapi.path.computation.PathComputationService" tapi.path.computation.Path: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - type: "object" properties: link: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.LinkRef" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" description: "Path is described by an ordered list of TE Links. A TE Link is\ \ defined by a pair of Node/NodeEdgePoint IDs. A Connection is realized by\ \ concatenating link resources (associated with a Link) and the lower-level\ \ connections (cross-connections) in the different nodes" tapi.path.computation.PathComputationService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - type: "object" properties: path: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathRef" routing-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.RoutingConstraint" optimization-constraint: description: "none" $ref: "#/definitions/tapi.path.computation.PathOptimizationConstraint" objective-function: description: "none" $ref: "#/definitions/tapi.path.computation.PathObjectiveFunction" end-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.path.computation.PathServiceEndPoint" description: "none" tapi.path.computation.PathObjectiveFunction: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: link-utilization: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" bandwidth-optimization: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" cost-optimization: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" resource-sharing: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" concurrent-paths: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" description: "none" tapi.path.computation.PathOptimizationConstraint: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: traffic-interruption: description: "none" $ref: "#/definitions/tapi.common.DirectiveValue" description: "none" tapi.path.computation.PathRef: type: "object" properties: path-id: type: "string" x-path: "/tapi-common:context/tapi-path-computation:path/tapi-path-computation:uuid" tapi.path.computation.PathServiceEndPoint: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: service-layer: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" role: description: "Each EP of the FC has a role (e.g., working, protection, protected,\ \ symmetric, hub, spoke, leaf, root) in the context of the FC with respect\ \ to the FC function. " $ref: "#/definitions/tapi.common.PortRole" service-interface-point: type: "string" description: "none" x-path: "/tapi-common:context/tapi-common:service-interface-point/tapi-common:uuid" direction: description: "The orientation of defined flow at the EndPoint." $ref: "#/definitions/tapi.common.PortDirection" description: "The association of the FC to LTPs is made via EndPoints.\n \ \ The EndPoint (EP) object class models the access to the FC function.\n\ \ The traffic forwarding between the associated EPs of the\ \ FC depends upon the type of FC and may be associated with FcSwitch object\ \ instances.\n In cases where there is resilience the EndPoint\ \ may convey the resilience role of the access to the FC.\n \ \ It can represent a protected (resilient/reliable) point or a protecting\ \ (unreliable working or protection) point.\n The EP replaces\ \ the Protection Unit of a traditional protection model.\n \ \ The ForwadingConstruct can be considered as a component and the EndPoint\ \ as a Port on that component" tapi.path.computation.RoutingConstraint: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: path-layer: type: "array" description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" requested-capacity: description: "none" $ref: "#/definitions/tapi.common.Capacity" avoid-topology: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:uuid" service-level: type: "string" description: "An abstract value the meaning of which is mutually agreed\ \ – typically represents metrics such as - Class of service, priority,\ \ resiliency, availability" cost-characteristic: type: "array" description: "The list of costs where each cost relates to some aspect of\ \ the TopologicalEntity." items: $ref: "#/definitions/tapi.topology.CostCharacteristic" include-topology: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.TopologyRef" latency-characteristic: type: "array" description: "The effect on the latency of a queuing process. This only\ \ has significant effect for packet based systems and has a complex characteristic." items: $ref: "#/definitions/tapi.topology.LatencyCharacteristic" description: "none" tapi.topology.ContextAugmentation3: type: "object" properties: nw-topology-service: description: "none" $ref: "#/definitions/tapi.topology.NetworkTopologyService" topology: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.Topology" x-augmentation: prefix: "tapi-topology" namespace: "urn:onf:otcc:yang:tapi-topology" tapi.topology.CostCharacteristic: type: "object" properties: cost-value: type: "string" description: "The specific cost." cost-algorithm: type: "string" description: "The cost may vary based upon some properties of the TopologicalEntity.\ \ The rules for the variation are conveyed by the costAlgorithm." cost-name: type: "string" description: "The cost characteristic will related to some aspect of the TopologicalEntity\ \ (e.g. $ cost, routing weight). This aspect will be conveyed by the costName." tapi.topology.ForwardingRule: type: "string" enum: - "MAY_FORWARD_ACROSS_GROUP" - "MUST_FORWARD_ACROSS_GROUP" - "CANNOT_FORWARD_ACROSS_GROUP" - "NO_STATEMENT_ON_FORWARDING" tapi.topology.GetLinkDetailsInput: properties: input: type: "object" properties: link-id-or-name: type: "string" description: "none" topology-id-or-name: type: "string" description: "none" tapi.topology.GetLinkDetailsOutput: properties: output: type: "object" properties: link: description: "none" $ref: "#/definitions/tapi.topology.Link" tapi.topology.GetNodeDetailsInput: properties: input: type: "object" properties: node-id-or-name: type: "string" description: "none" topology-id-or-name: type: "string" description: "none" tapi.topology.GetNodeDetailsOutput: properties: output: type: "object" properties: node: description: "none" $ref: "#/definitions/tapi.topology.Node" tapi.topology.GetNodeEdgePointDetailsInput: properties: input: type: "object" properties: ep-id-or-name: type: "string" description: "none" node-id-or-name: type: "string" description: "none" topology-id-or-name: type: "string" description: "none" tapi.topology.GetNodeEdgePointDetailsOutput: properties: output: type: "object" properties: node-edge-point: description: "none" $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.GetTopologyDetailsInput: properties: input: type: "object" properties: topology-id-or-name: type: "string" description: "none" tapi.topology.GetTopologyDetailsOutput: properties: output: type: "object" properties: topology: description: "none" $ref: "#/definitions/tapi.topology.Topology" tapi.topology.GetTopologyListOutput: properties: output: type: "object" properties: topology: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.Topology" tapi.topology.InterRuleGroup: allOf: - $ref: "#/definitions/tapi.common.CapacityPac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.topology.RiskParameterPac" - $ref: "#/definitions/tapi.topology.TransferCostPac" - $ref: "#/definitions/tapi.topology.TransferTimingPac" - type: "object" properties: associated-node-rule-group: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" rule: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.Rule" description: "none" tapi.topology.LatencyCharacteristic: type: "object" properties: traffic-property-name: type: "string" description: "The identifier of the specific traffic property to which the\ \ queuing latency applies." jitter-characteristic: type: "string" description: "High frequency deviation from true periodicity of a signal and\ \ therefore a small high rate of change of transfer latency.\n \ \ Applies to TDM systems (and not packet)." fixed-latency-characteristic: 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" wander-characteristic: type: "string" description: "Low frequency deviation from true periodicity of a signal and\ \ therefore a small low rate of change of transfer latency.\n \ \ Applies to TDM systems (and not packet)." queing-latency-characteristic: type: "string" description: "The specific queuing latency for the traffic property." tapi.topology.LayerProtocolTransitionPac: type: "object" properties: transitioned-layer-protocol-name: type: "array" description: "Provides the ordered structure of layer protocol transitions\ \ encapsulated in the TopologicalEntity. The ordering relates to the LinkPort\ \ role." items: type: "string" tapi.topology.Link: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.CapacityPac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.topology.LayerProtocolTransitionPac" - $ref: "#/definitions/tapi.topology.RiskParameterPac" - $ref: "#/definitions/tapi.topology.TransferCostPac" - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - $ref: "#/definitions/tapi.topology.TransferTimingPac" - $ref: "#/definitions/tapi.topology.ValidationPac" - type: "object" properties: layer-protocol-name: type: "array" description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" resilience-type: description: "none" $ref: "#/definitions/tapi.topology.ResilienceType" node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.OwnedNodeEdgePointRef" direction: description: "The directionality of the Link.\n Is applicable\ \ to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will\ \ be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\n\ \ Is not present in more complex cases." $ref: "#/definitions/tapi.common.ForwardingDirection" description: "The Link object class models effective adjacency between two or\ \ more ForwardingDomains (FD). " tapi.topology.LinkRef: allOf: - $ref: "#/definitions/tapi.topology.TopologyRef" - type: "object" properties: link-id: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid" tapi.topology.NetworkTopologyService: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - type: "object" properties: topology: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:uuid" description: "none" tapi.topology.Node: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.CapacityPac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.topology.TransferCostPac" - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - $ref: "#/definitions/tapi.topology.TransferTimingPac" - type: "object" properties: layer-protocol-name: type: "array" description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" owned-node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeEdgePoint" node-rule-group: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeRuleGroup" aggregated-node-edge-point: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" description: "The ForwardingDomain (FD) object class models the “ForwardingDomain”\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding.\n \ \ At the lowest level of recursion, an FD (within a network element (NE))\ \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.NodeEdgePoint: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.CapacityPac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.common.TerminationPac" - type: "object" properties: layer-protocol-name: description: "none" $ref: "#/definitions/tapi.common.LayerProtocolName" link-port-role: description: "Each LinkEnd of the Link has a role (e.g., symmetric, hub,\ \ spoke, leaf, root) in the context of the Link with respect to the Link\ \ function. " $ref: "#/definitions/tapi.common.PortRole" mapped-service-interface-point: type: "array" description: "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing)\ \ or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load\ \ balancing/Resilience) should be considered experimental" items: $ref: "#/definitions/tapi.common.ServiceInterfacePointRef" link-port-direction: description: "The orientation of defined flow at the LinkEnd." $ref: "#/definitions/tapi.common.PortDirection" aggregated-node-edge-point: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" description: "The LogicalTerminationPoint (LTP) object class encapsulates the\ \ termination and adaptation functions of one or more transport layers.\n\ \ The structure of LTP supports all transport protocols including\ \ circuit and packet forms." tapi.topology.NodeRef: allOf: - $ref: "#/definitions/tapi.topology.TopologyRef" - type: "object" properties: node-id: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid" tapi.topology.NodeRuleGroup: allOf: - $ref: "#/definitions/tapi.common.CapacityPac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.topology.RiskParameterPac" - $ref: "#/definitions/tapi.topology.TransferCostPac" - $ref: "#/definitions/tapi.topology.TransferTimingPac" - type: "object" properties: inter-rule-group: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.InterRuleGroup" rule: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.Rule" node-rule-group: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeRuleGroupRef" node-edge-point: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" description: "none" tapi.topology.NodeRuleGroupRef: allOf: - $ref: "#/definitions/tapi.topology.NodeRef" - type: "object" properties: node-rule-group-id: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid" tapi.topology.OwnedNodeEdgePointRef: allOf: - $ref: "#/definitions/tapi.topology.NodeRef" - type: "object" properties: owned-node-edge-point-id: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" tapi.topology.ProtectionType: type: "string" enum: - "NO_PROTECTON" - "ONE_PLUS_ONE_PROTECTION" - "ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION" - "PERMANENT_ONE_PLUS_ONE_PROTECTION" - "ONE_FOR_ONE_PROTECTION" - "DYNAMIC_RESTORATION" - "PRE_COMPUTED_RESTORATION" tapi.topology.ResilienceType: type: "object" properties: restoration-policy: description: "none" $ref: "#/definitions/tapi.topology.RestorationPolicy" protection-type: description: "none" $ref: "#/definitions/tapi.topology.ProtectionType" tapi.topology.RestorationPolicy: type: "string" enum: - "PER_DOMAIN_RESTORATION" - "END_TO_END_RESTORATION" - "NA" tapi.topology.RiskCharacteristic: type: "object" properties: risk-characteristic-name: type: "string" description: "The name of the risk characteristic. The characteristic may\ \ be related to a specific degree of closeness. \n 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).\n Depending upon the importance\ \ of the traffic being routed different risk characteristics will be evaluated." risk-identifier-list: type: "array" description: "A list of the identifiers of each physical/geographic unit (with\ \ the specific risk characteristic) that is related to a segment of the\ \ TopologicalEntity." items: type: "string" tapi.topology.RiskParameterPac: type: "object" properties: risk-characteristic: type: "array" description: "A list of risk characteristics for consideration in an analysis\ \ of shared risk. Each element of the list represents a specific risk consideration." items: $ref: "#/definitions/tapi.topology.RiskCharacteristic" tapi.topology.Rule: allOf: - $ref: "#/definitions/tapi.common.LocalClass" - type: "object" properties: override-priority: type: "integer" format: "int32" description: "none" forwarding-rule: description: "none" $ref: "#/definitions/tapi.topology.ForwardingRule" rule-type: description: "none" $ref: "#/definitions/tapi.topology.RuleType" description: "none" tapi.topology.RuleType: type: "string" enum: - "FORWARDING" - "CAPACITY" - "COST" - "TIMING" - "RISK" - "GROUPING" tapi.topology.Topology: allOf: - $ref: "#/definitions/tapi.common.GlobalClass" - type: "object" properties: layer-protocol-name: type: "array" description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" link: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.Link" node: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.Node" description: "The ForwardingDomain (FD) object class models the “ForwardingDomain”\ \ topological component which is used to effect forwarding of transport characteristic\ \ information and offers the potential to enable forwarding.\n \ \ At the lowest level of recursion, an FD (within a network element (NE))\ \ represents a switch matrix (i.e., a fabric). Note that an NE can encompass\ \ multiple switch matrices (FDs). " tapi.topology.TopologyRef: type: "object" properties: topology-id: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:uuid" tapi.topology.TransferCostPac: type: "object" properties: cost-characteristic: type: "array" description: "The list of costs where each cost relates to some aspect of\ \ the TopologicalEntity." items: $ref: "#/definitions/tapi.topology.CostCharacteristic" tapi.topology.TransferIntegrityPac: type: "object" properties: error-characteristic: type: "string" description: "Describes the degree to which the signal propagated can be errored.\n\ \ Applies to TDM systems as the errored signal will be\ \ propagated and not packet as errored packets will be discarded." unavailable-time-characteristic: type: "string" description: "Describes the duration for which there may be no valid signal\ \ propagated." server-integrity-process-characteristic: type: "string" description: "Describes the effect of any server integrity enhancement process\ \ on the characteristics of the TopologicalEntity." delivery-order-characteristic: type: "string" description: "Describes the degree to which packets will be delivered out\ \ of sequence.\n Does not apply to TDM as the TDM protocols\ \ maintain strict order." repeat-delivery-characteristic: type: "string" description: "Primarily applies to packet systems where a packet may be delivered\ \ more than once (in fault recovery for example).\n It\ \ can also apply to TDM where several frames may be received twice due to\ \ switching in a system with a large differential propagation delay." loss-characteristic: type: "string" description: "Describes the acceptable characteristic of lost packets where\ \ loss may result from discard due to errors or overflow.\n \ \ Applies to packet systems and not TDM (as for TDM errored signals\ \ are propagated unless grossly errored and overflow/underflow turns into\ \ timing slips)." tapi.topology.TransferTimingPac: type: "object" properties: latency-characteristic: type: "array" description: "The effect on the latency of a queuing process. This only has\ \ significant effect for packet based systems and has a complex characteristic." items: $ref: "#/definitions/tapi.topology.LatencyCharacteristic" tapi.topology.ValidationMechanism: type: "object" properties: layer-protocol-adjacency-validated: type: "string" description: "State of validatiion" validation-mechanism: type: "string" description: "Name of mechanism used to validate adjacency" validation-robustness: type: "string" description: "Quality of validation (i.e. how likely is the stated validation\ \ to be invalid)" tapi.topology.ValidationPac: type: "object" properties: validation-mechanism: type: "array" description: "Provides details of the specific validation mechanism(s) used\ \ to confirm the presence of an intended topologicalEntity." items: $ref: "#/definitions/tapi.topology.ValidationMechanism" tapi.topology.node.OwnedNodeEdgePoint: allOf: - $ref: "#/definitions/tapi.connectivity.OwnedNodeEdgePointAugmentation1" - $ref: "#/definitions/tapi.topology.NodeEdgePoint" tapi.topology.topology.Node: allOf: - $ref: "#/definitions/tapi.common.AdminStatePac" - $ref: "#/definitions/tapi.common.CapacityPac" - $ref: "#/definitions/tapi.common.GlobalClass" - $ref: "#/definitions/tapi.topology.TransferCostPac" - $ref: "#/definitions/tapi.topology.TransferIntegrityPac" - $ref: "#/definitions/tapi.topology.TransferTimingPac" - type: "object" properties: layer-protocol-name: type: "array" description: "none" items: $ref: "#/definitions/tapi.common.LayerProtocolName" encap-topology: description: "none" $ref: "#/definitions/tapi.topology.TopologyRef" owned-node-edge-point: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.node.OwnedNodeEdgePoint" node-rule-group: type: "array" description: "none" items: $ref: "#/definitions/tapi.topology.NodeRuleGroup" aggregated-node-edge-point: type: "array" description: "none" items: type: "string" x-path: "/tapi-common:context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid" description: "none"