Skip to content
NsInstance.schema.json 91.6 KiB
Newer Older
AHMADABB's avatar
AHMADABB committed
{
  "description": "This type represents a response for Query NS operation.  It shall comply with the provisions defined in Table 6.5.2.10-1.\n",
  "type": "object",
  "required": [
    "id",
    "nsInstanceName",
    "nsInstanceDescription",
    "nsdId",
    "nsdInfoId",
    "nsState"
  ],
  "properties": {
    "id": {
      "description": "An identifier with the intention of being globally unique.\n",
      "type": "string"
    },
    "nsInstanceName": {
      "description": "Human readable name of the NS instance.\n",
      "type": "string"
    },
    "nsInstanceDescription": {
      "description": "Human readable description of the NS instance.\n",
      "type": "string"
    },
    "nsdId": {
      "description": "An identifier with the intention of being globally unique.\n",
      "type": "string"
    },
    "nsdInfoId": {
      "description": "An identifier with the intention of being globally unique.\n",
      "type": "string"
    },
    "flavourId": {
      "description": "An identifier that is unique within a NS descriptor. Representation: string of variable length.\n",
      "type": "string"
    },
    "vnfInstance": {
      "description": "Information on constituent VNF(s) of the NS instance.\n",
      "type": "array",
      "items": {
        "description": "This type represents a VNF instance.\n",
        "type": "object",
        "required": [
          "id",
          "vnfdId",
          "vnfProvider",
          "vnfProductName",
          "vnfSoftwareVersion",
          "vnfdVersion",
          "vnfPkgId",
          "instantiationState"
        ],
        "properties": {
          "id": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          },
          "vnfInstanceName": {
            "description": "Name of the VNF instance. This attribute can be modified with the PATCH method.\n",
            "type": "string"
          },
          "vnfInstanceDescription": {
            "description": "Human-readable description of the VNF instance. This attribute can be modified with the PATCH method.\n",
            "type": "string"
          },
          "vnfdId": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          },
          "vnfProvider": {
            "description": "Provider of the VNF and the VNFD. The value is copied from the VNFD.\n",
            "type": "string"
          },
          "vnfProductName": {
            "description": "Name to identify the VNF Product. The value is copied from the VNFD.\n",
            "type": "string"
          },
          "vnfSoftwareVersion": {
            "description": "A Version.\n",
            "type": "string"
          },
          "vnfdVersion": {
            "description": "A Version.\n",
            "type": "string"
          },
          "vnfPkgId": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          },
          "vnfConfigurableProperties": {
            "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"
          },
          "vimId": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          },
          "instantiationState": {
            "description": "The instantiation state of the VNF.\n",
            "type": "string",
            "enum": [
              "NOT_INSTANTIATED",
              "INSTANTIATED"
            ]
          },
          "instantiatedVnfInfo": {
            "description": "Information specific to an instantiated VNF instance. This attribute shall be present if the instantiateState attribute value is INSTANTIATED.\n",
            "type": "object",
            "required": [
              "flavourId",
              "vnfState"
            ],
            "properties": {
              "flavourId": {
                "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
                "type": "string"
              },
              "vnfState": {
                "type": "string",
                "enum": [
                  "STARTED",
                  "STOPPED"
                ]
              },
              "scaleStatus": {
                "description": "Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how \"big\" the VNF has been scaled w.r.t. that aspect.\n",
                "type": "array",
                "items": {
                  "required": [
                    "aspectId",
                    "scaleLevel"
                  ],
                  "type": "object",
                  "properties": {
                    "aspectId": {
                      "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
                      "type": "string"
                    },
                    "scaleLevel": {
                      "description": "Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.\n",
                      "type": "integer"
                    }
                  }
                }
              },
              "extCpInfo": {
                "description": "Information about the external CPs exposed by the VNF instance.\n",
                "type": "array",
                "minItems": 1,
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "cpdId"
                  ],
                  "properties": {
                    "id": {
                      "description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
                      "type": "string"
                    },
                    "cpdId": {
                      "description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
                      "type": "string"
                    },
                    "cpProtocolInfo": {
                      "description": "Network protocol information for this CP.\n",
                      "type": "array",
                      "items": {
                        "description": "This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.\n",
                        "type": "object",
                        "required": [
                          "layerProtocol",
                          "ipOverEthernet"
                        ],
                        "properties": {
                          "layerProtocol": {
                            "description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: IP_OVER_ETHERNET See note.\n",
                            "type": "string",
                            "enum": [
                              "IP_OVER_ETHERNET"
                            ]
                          },
                          "ipOverEthernet": {
                            "description": "This type represents information about a network address that has been assigned.  It shall comply with the provisions defined in Table 6.5.3.18-1.\n",
                            "type": "object",
                            "required": [
                              "macAddress",
                              "ipAddresses",
                              "subnetId",
                              "addresses",
                              "addressRange"
                            ],
                            "properties": {
                              "macAddress": {
                                "description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
                                "type": "string",
                                "format": "MAC"
                              },
                              "ipAddresses": {
                                "description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet.\n",
Loading
Loading full blame…