NsInstance.schema.json

										"type": "number"
									},
									"mscsEndpoints": {
										"description": "Information about the MSCS endpoints of the MSCS.\n",
										"type": "array",
										"items": {
											"description": "This type provides encapsulates information about an MSCS endpoint of the MSCS. It shall comply with the provisions defined in table 6.5.3.83-1.\n",
											"type": "object",
											"required": ["mscsEndpointId", "directionality", "connectivityServiceEndpoinId"],
											"properties": {
												"mscsEndpointId": {
													"description": "An identifier with the intention of being globally unique.\n",
													"type": "string"
												},
												"directionality": {
													"description": "Directionality of the data traffic in the context of the terminating MSCS endpoint from WAN’s perspective. Permitted values: -\tINBOUND: to indicate into the WAN. -\tOUTBOUND: to indicate from the WAN. -\tBOTH: to indicate bidirectional data traffic to/from the WAN.\n",
													"type": "string",
													"enum": ["INBOUND", "OUTBOUND", "BOTH"]
												},
												"connectivityServiceEndpoinId": {
													"description": "References the connectivity service endpoint configuration information applicable to support the MSCS endpoint. More than one connectivity service endpoint can be referred when endpoints are in LAG mode.\n",
													"type": "array",
													"items": {
														"description": "An identifier with the intention of being globally unique.\n",
														"type": "string"
													}
												}
											}
										}
									}
								}
							},
							"connectivityServiceEndpoints": {
								"description": "Configuration information about the network resources in the NFVI-PoP and their connectivity to the WAN.\n",
								"type": "array",
								"items": {
									"description": "This type provides configuration data for the NFVI-PoP network gateway providing connectivity service endpoints. The connectivity service endpoints are used as endpoints by an MSCS. It shall comply with the provisions defined in Table 6.5.3.84-1.\n",
									"type": "object",
									"required": ["connectivityServiceEndpointId", "vimId"],
									"properties": {
										"connectivityServiceEndpointId": {
											"description": "An identifier with the intention of being globally unique.\n",
											"type": "string"
										},
										"vimId": {
											"description": "An identifier with the intention of being globally unique.\n",
											"type": "string"
										},
										"siteToWanLayer2ProtocolData": {
											"description": "This type provides information about Layer 2 protocol specific information for the configuration of the NFVI-PoP network gateway to enable the stitching of the intra-site VN to the MSCS over the WAN. It shall comply with the provisions defined in Table 6.5.3.85-1. NOTE:\tEither \"networkResources\" or \"vnSegmentsIds\" shall be provided, but not both.\n",
											"type": "object",
											"required": ["layer2ConnectionInfo"],
											"properties": {
												"layer2ConnectionInfo": {
													"description": "Layer 2 protocol parameters of the connectivity service endpoint (CSE).\n",
													"type": "object",
													"required": ["connectionType", "interfaceType", "interfaceTagging", "encapsulationType"],
													"properties": {
														"connectionType": {
															"description": "The type of connection to be established on the connectivity service point. Permitted values: -\tCSE: defined by the characteristics of the existing referred connectivity service point. -\tAGGREGATE_CSE: create an aggregation of the connectivity service endpoints.\n",
															"type": "string",
															"enum": ["CSE", "AGGREGATE_CSE"]
														},
														"interfaceType": {
															"description": "To indicate whether to create logical interfaces on the referred connectivity service endpoint or new aggregated connectivity service endpoint. Permitted values: -\tPARENT: use the mapped interface to the connectivity service endpoint as is, i.e., do not create logical interfaces. -\tLOGICAL: create logical interfaces.\n",
															"type": "string",
															"enum": ["PARENT", "LOGICAL"]
														},
														"interfaceTagging": {
															"description": "The type of frames to forward on the connectivity service point. Permitted values: -\tUNTAGGED: an interface where frames are not tagged. -\tTAGGED: an interface configured to forward tagged frames (i.e., enabled for VLAN tagging).\n",
															"type": "string",
															"enum": ["UNTAGGED", "TAGGED"]
														},
														"encapsulationType": {
															"description": "The type of encapsulation. If the interfaceTagging=\"TAGGED\", either \"VLAN\" or \"VXLAN\" shall be set. Permitted values: -\tETH: generic Ethernet encapsulation. -\tVLAN: encapsulation based on VLAN. -\tVXLAN: encapsulation based on VXLAN.\n",
															"type": "string",
															"enum": ["ETH", "VLAN", "VXLAN"]
														},
														"vlanTaggingType": {
															"description": "Type of encapsulation method for VLAN tagging. Shall be present if interfaceTagging=\"TAGGED\" and encapsulationType=\"VLAN\". Permitted values: -\tDOT1Q: used when packets on the CSE are encapsulated with one or a set of customer VLAN identifiers. -\tQINQ: used when packets on the CSE are encapsulated with multiple customer VLAN identifiers and a single\n  service VLAN identifier.\n- QINANY: used when packets on the CSE have no specific customer VLAN and a service VLAN identifier is used.\n",
															"type": "string",
															"enum": ["DOT1Q", "QINQ", "QINANY"]
														},
														"wanSegmentIds": {
															"description": "Segment identifiers to pass on the tagged interface. Shall be present if encapsulationType=\"VLAN\" or “VXLAN\".\n",
															"type": "object",
															"required": ["wanSegmentIdValue"],
															"properties": {
																"wanSegmentIdValue": {
																	"description": "Identifier of the network segment (e.g., VLAN id or VNI).\n",
																	"type": "string"
																},
																"wanSegmentIdUpperRange": {
																	"description": "Identifier of the upper range network segment, in case the \"wanSegmentIds\" is used to define a range.\n",
																	"type": "string"
																}
															}
														},
														"vxlanConfig": {
															"description": "Additional configuration needed when using VXLAN encapsulation. Shall be present if interfaceTagging=\"TAGGED\" and encapsulationType=\"VXLAN\".\n",
															"type": "object",
															"required": ["peerMode"],
															"properties": {
																"peerMode": {
																	"description": "Type of VXLAN access mode. Default value is \"STATIC\".\nPermitted values: -\tSTATIC -\tBGP_EVPN\n",
																	"type": "string",
																	"enum": ["STATIC", "BGP_EVPN"]
																},
																"peers": {
																	"description": "List of IP addresses of VTEP peers when using static mode.\n",
																	"type": "array",
																	"items": {
																		"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
																		"type": "string",
																		"format": "IP"
																	}
																}
															}
														},
														"lagInterfaceData": {
															"description": "Information for setting up a LAG interface aggregating multiple connectivity service endpoints.\n",
															"type": "object",
															"required": ["aggregatedEndpoints", "lacpActivation", "lacpConfig"],
															"properties": {
																"aggregatedEndpoints": {
																	"description": "List of the connectivity service endpoints that are to be aggregated. Shall be present if connectionType=\"AGGREGATE_CSE\". In case of aggregating connectivity service endpoints, only one SiteToWanLayer2ProtocolData shall be provided for the whole set of aggregated endpoints.\n",
																	"type": "array",
																	"items": {
																		"description": "An identifier with the intention of being globally unique.\n",
																		"type": "string"
																	}
																},
																"lacpActivation": {
																	"description": "Indicates whether to activate LACP on the interface. If \"TRUE\", the LACP is to be activated, or \"FALSE\" otherwise. Default value is \"FALSE\".\n",
																	"type": "boolean"
																},
																"lacpConfig": {
																	"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
																	"type": "object"
																}
															}
														},
														"layer2ControlProtocol": {
															"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
															"type": "object"
														}
													}
												},
												"mtuL2": {
													"description": "Maximum Transmission Unit (MTU) that can be forwarded at layer 2 (in bytes). Default value is \"1500\" (bytes).\n",
													"type": "number"
												},
												"virtualRoutingAndForwarding": {
													"description": "Configuration related to the L2 virtual routing and forwarding (MAC-VRF).\n",
													"type": "object",
													"required": ["macVrfName"],
													"properties": {
														"macVrfName": {
															"description": "Name (or identifier) of the MAC-VRF instance.\n",
															"type": "string"
														}
													}
												},
												"forwardingConfig": {
													"description": "Information related to the forwarding of the VN in the NFVI-PoP to the connectivity service endpoint, if information about the VN to \"stitch\" is already known. . by the OSS/BSS. Shall not be provided otherwise, in which case the NFVO will infer the forwarding configuration based on the NS VL, or external VL, or externally-managed VL provisioning.\n",
													"type": "object",
													"oneOf": [{
														"required": ["networkResources"]
													}, {
														"required": ["vnSegmentIds"]
													}],
													"properties": {
														"networkResources": {
															"description": "Reference to the VN resource to be forwarded into/from the MSCS. See note.\n",
															"type": "array",
															"items": {
																"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM. NOTE: The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
																"type": "object",
																"required": ["resourceId"],
																"properties": {
																	"vimId": {
																		"description": "An identifier with the intention of being globally unique.\n",
																		"type": "string"
																	},
																	"resourceProviderId": {
																		"description": "An identifier with the intention of being globally unique.\n",
																		"type": "string"
																	},
																	"resourceId": {
																		"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
																		"type": "string"
																	},
																	"vimLevelResourceType": {
																		"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. See note.\n",
																		"type": "string"
																	}
																}
															}
														},
														"vnSegmentIds": {
															"description": "Identifiers of the network segments of the VN resources to be forwarded into/from the MSCS.\n",
															"type": "object",
															"required": ["vnSegmentIdValue"],
															"properties": {
																"vnSegmentIdValue": {
																	"description": "Identifier of the network segment.\n",
																	"type": "string"
																},
																"vnSegmentIdUpperRange": {
																	"description": "Identifier of the upper range network segment, in case the \"vnSegmentIds\" is used to define a range.\n",
																	"type": "string"
																}
															}
														}
													}
												}
											}
										},
										"siteToWanLayer3ProtocolData": {
											"description": "This type provides information about Layer 3 protocol specific information for the stitching of the intra-site VN to the multi-site connectivity service over the WAN. It shall comply with the provisions defined in Table 6.5.3.86-1.\n",
											"type": "object",
											"required": ["routingInfo"],
											"properties": {
												"logicalInterfaceIpAddress": {
													"description": "IP addressing information associated to a logical interface. Shall be present if the \"interfaceType\" of the SiteToWanLayer2ProtocolData is equal to \"LOGICAL\".\n",
													"type": "object",
													"required": ["ipAddress", "associatedSegmentId"],
													"properties": {
														"ipAddress": {
															"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
															"type": "string",
															"format": "IP"
														},
														"associatedSegmentId": {
															"description": "The associated segment identifier that has triggered the creation of the logical interface. The value shall be one of the values listed in the \"wanSegmentIds\" of the \"siteToWanLayer2ProtocolData\".\n",
															"type": "string"
														}
													}
												},
												"routingInfo": {
													"description": "The routing information that is activated on the connectivity service endpoint. More than one \"routingInfo\" is allowed to enable stacking different routing protocols (e.g., one routing protocol for IPv4 and another one for IPv6).\n",
													"type": "object",
													"required": ["routingProtocol", "routingAddressFamily"],
													"properties": {
														"routingProtocol": {
															"description": "The routing protocol that is activated on the connectivity service endpoint. Permitted values: -\tBGP: used for dynamic routing BGPv4. -\tRIP: used for dynamic routing RIPv2. -\tOSPF: used for dynamic routing (OSPF version 2 for IPv4; and OSPF version 3 for IPv6). -\tSTATIC: used for static routing. -\tDIRECT: used when the NFVI-PoP network is directly connected to the WAN provider network. -\tVRRP: used when the NFVI-PoP network is directly connected to the WAN provider network with virtual\n  router redundancy protocol support (VRRP).\n",
															"type": "string",
															"enum": ["BGP", "RIP", "OSPF", "STATIC", "DIRECT", "VRRP"]
														},
														"staticRouting": {
															"description": "Defines a static route. It shall only be present if the routingProtocol=\"STATIC\".\n",
															"type": "object",
															"required": ["ipVersion", "ipPrefix", "prefixSize", "nextHop"],
															"properties": {
																"ipVersion": {
																	"description": "The IP version applicable to the routing entry. Permitted values: -\tIPV4 -\tIPV6\n",
																	"type": "string",
																	"enum": ["IPV4", "IPV6"]
																},
																"ipPrefix": {
																	"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
																	"type": "string",
																	"format": "IP"
																},
																"prefixSize": {
																	"description": "The IP prefix size.\n",
																	"type": "number"
																},
																"nextHop": {
																	"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
																	"type": "string",
																	"format": "IP"
																}
															}
														},
														"routingAddressFamily": {
															"description": "The IP version applicable to the dynamic routing protocol. Shall be present for dynamic routing protocols. Permitted values: -\tIPV4 -\tIPV6\n",
															"type": "string",
															"enum": ["IPV4", "IPv6"]
														},
														"ospfRouting": {
															"description": "Defines parameters for OSPF routing. It shall only be present if the routingProtocol=\"OSPF\".\n",
															"type": "object",
															"required": ["areaId"],
															"properties": {
																"areaId": {
																	"description": "The routing area identifier, e.g., a number or an IP address.\n",
																	"type": "string"
																}
															}
														},
														"bgpRouting": {
															"description": "Defines parameters for BGP routing. It shall only be present if the routingProtocol=\"BGP\".\n",
															"type": "object",
															"required": ["bgpAs"],
															"properties": {
																"bgpAs": {
																	"description": "The Autonomous System (AS) identification applicable to the BGP routing info entry.\n",
																	"type": "object"
																},
																"bgpNeighbour": {
																	"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
																	"type": "string",
																	"format": "IP"
																},
																"bgpAdditionalParam": {
																	"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
																	"type": "object"
																}
															}
														},
														"routeMapsDistribution": {
															"description": "Maps of routes that are permitted or denied for redistribution.\n",
															"type": "object",
															"required": ["policy", "sequence", "matchAndSetRule"],
															"properties": {
																"policy": {
																	"description": "The policy to apply to the route distribution.\nPermitted values: -\tPERMIT -\tDENY\n",
																	"type": "string",
																	"enum": ["PERMIT", "DENY"]
																},
																"sequence": {
																	"description": "Sequence or index number assigned to the route-map.\n",
																	"type": "number"
																},
																"matchAndSetRule": {
																	"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
																	"type": "object"
																}
															}
														}
													}
												},
												"mtuL3": {
													"description": "Maximum Transmission Unit (MTU) that can be forwarded at layer 3 (in bytes). Default value is \"1500\" (bytes).\n",
													"type": "number"
												},
												"virtualRoutingAndForwarding": {
													"description": "Configuration related to the virtual routing and forwarding (VRF).\n",
													"type": "object",
													"required": ["vrfName"],
													"properties": {
														"vrfName": {
															"description": "Name (or identifier) of the VRF instance.\n",
															"type": "string"
														}
													}
												},
												"bfdConfig": {
													"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
													"type": "object"
												}
											}
										}
									}
								}
							}
						}
					}
				}
			}
		},
		"_links": {
			"type": "object",
			"description": "Links to resources related to this resource.",
			"required": ["self"],
			"properties": {
				"self": {
					"description": "This type represents a link to a resource.\n",
					"type": "object",
					"required": ["href"],
					"properties": {
						"href": {
							"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
							"type": "string",
							"format": "url"
						}
					}
				},
				"nestedNsInstances": {
					"description": "Links to resources related to this notification.\n",
					"type": "array",
					"items": {
						"description": "This type represents a link to a resource.\n",
						"type": "object",
						"required": ["href"],
						"properties": {
							"href": {
								"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
								"type": "string",
								"format": "url"
							}
						}
					}
				},
				"vnfSnapshotInfos": {
					"description": "Links to the VNF snapshots associated to VNF instances which are part of this NS instance.\n",
					"type": "array",
					"items": {
						"description": "This type represents a link to a resource.\n",
						"type": "object",
						"required": ["href"],
						"properties": {
							"href": {
								"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
								"type": "string",
								"format": "url"
							}
						}
					}
				},
				"instantiate": {
					"description": "This type represents a link to a resource.\n",
					"type": "object",
					"required": ["href"],
					"properties": {
						"href": {
							"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
							"type": "string",
							"format": "url"
						}
					}
				},
				"terminate": {
					"description": "This type represents a link to a resource.\n",
					"type": "object",
					"required": ["href"],
					"properties": {
						"href": {
							"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
							"type": "string",
							"format": "url"
						}
					}
				},
				"update": {
					"description": "This type represents a link to a resource.\n",
					"type": "object",
					"required": ["href"],
					"properties": {
						"href": {
							"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
							"type": "string",
							"format": "url"
						}
					}
				},
				"scale": {
					"description": "This type represents a link to a resource.\n",
					"type": "object",
					"required": ["href"],
					"properties": {
						"href": {
							"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
							"type": "string",
							"format": "url"
						}
					}
				},
				"heal": {
					"description": "This type represents a link to a resource.\n",
					"type": "object",
					"required": ["href"],
					"properties": {
						"href": {
							"description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
							"type": "string",
							"format": "url"
						}
					}
				}
			}
		}
	}
}