NsLcmOperationOccurrenceNotification.schema.json 84.6 KB
Newer Older
																		"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: - IPV4 - IPV6\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: - IPV4 - IPV6\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: - PERMIT - DENY\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"
															}
														}
													}
												}
											}
										},
										"removeConnectivityServiceEndpoints": {
											"description": "If present, this attribute signals the deletion of certain entries in the \"connectivityServiceEndpoints\" attribute array in \"WanConnectionProtocolInfo\", as defined in clause 6.5.3.91.\n",
											"type": "array",
											"items": {
												"description": "An identifier with the intention of being globally unique.\n",
												"type": "string"
											}
										}
									}
								}
							}
						}
					}
				}
			}
		},
		"affectedSap": {
			"description": "Information about the SAP instances that were affected during the lifecycle operation. See note 1.\n",
			"type": "array",
			"items": {
				"description": "This type provides information about added, deleted and modified SAP of a NS. It shall comply with the provisions in Table 6.5.3.7-1.\n",
				"type": "object",
				"required": ["sapInstanceId", "sapdId"],
				"properties": {
					"sapInstanceId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"sapdId": {
						"description": "An identifier with the intention of being globally unique.\n",
						"type": "string"
					},
					"sapName": {
						"description": "Human readable name for the SAP.\n",
						"type": "string"
					},
					"changeType": {
						"description": "Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - MODIFY\n",
						"type": "string",
						"enum": ["ADD", "REMOVE", "MODIFY"]
					},
					"changeResult": {
						"description": "Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n",
						"type": "string",
						"enum": ["COMPLETED", "ROLLED_BACK", "FAILED"]
					}
				}
			}
		},
		"feasibilityCheckResult": {
			"description": "The enumeration FeasibilityCheckResultType defines the permitted values to represent the result of  executing a feasibility check according to the options defined in clause 6.5.4.14. It shall comply  with the provisions defined in table 6.5.4.15-1.\n",
			"type": "string",
			"enum": ["FEASIBILITY_CHECK_DONE", "FEASIBILITY_CHECK_DONE_WITH_RESERVATION"]
		},
		"error": {
			"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
			"type": "object",
			"required": ["status", "detail"],
			"properties": {
				"type": {
					"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
					"type": "string",
					"format": "URI"
				},
				"title": {
					"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
					"type": "string"
				},
				"status": {
					"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
					"type": "integer"
				},
				"detail": {
					"description": "A human-readable explanation specific to this occurrence of the problem.\n",
					"type": "string"
				},
				"instance": {
					"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
					"type": "string",
					"format": "URI"
				}
			}
		},
		"_links": {
			"type": "object",
			"required": ["nsInstance"],
			"properties": {
				"nsInstance": {
					"description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\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"
						}
					}
				},
				"subscription": {
					"description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\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"
						}
					}
				},
				"nslcmOpOcc": {
					"description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\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"
						}
					}
				}
			}
		}
	}
AHMADABB's avatar
AHMADABB committed
}