Newer
Older
{
"description": "This type represents an \"Individual VNF snapshot\" resource. The \"id\" attributed is used by the NFVO to index and\nidentify the VNF snapshots information resources that are accessible via the NFVO. The identifier is still\ngenerated by the VNFM and copied into the present \"VnfSnapshotInfo\" representing the \"Individual VNF snapshot\"\nresource hold by the NFVO.\n",
"type": "object",
"required": ["id"],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfSnapshotPkgId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfSnapshot": {
"description": "This type represents a VNF Snapshot. It shall comply with the provisions defined in table 6.5.2.18-1.\n",
"type": "object",
"required": ["id", "vnfInstanceId", "triggeredAt", "createdAt", "vnfdId", "vnfInstance", "vnfcSnapshots"],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"creationStartedAt": {
"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"creationFinishedAt": {
"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstance": {
"description": "This type represents a VNF instance. It shall comply with the provisions defined in table 6.5.3.57-1.\nNOTE: Clause B.3.2 of ETSI GS NFV-SOL 003 provides examples illustrating the relationship among the different run-time information elements (CP, VL and link ports) used to represent the connectivity \n of a VNF.\n\nNOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist between the previous and the newly referred VNF package, i.e. when the new VNFD is changed with respect to \n the previous VNFD in other aspects than merely referencing to other VNF software images. \n In order to avoid misalignment of the VnfInstance with the current VNF's on-boarded VNF Package, \n the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall \n be kept in sync with the values in the VNFD.\nNOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. NOTE 3: VNF configurable properties are sometimes also referred to as configuration parameters applicable to a VNF. Some of these are set prior to instantiation and cannot be modified if the VNF is instantiated, \n some are set prior to instantiation (are part of initial configuration) and can be modified later, \n and others can be set only after instantiation. The applicability of certain configuration may depend \n on the VNF and the required operation of the VNF at a certain point in time.\nNOTE 4: It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding to the same \n VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed \n multi-site VL instance (refer to clause 6.5.3.59).\nNOTE 5: Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not be listed in the \"vnfVirtualLinkResourceInfo\" attribute as this would be redundant.\n",
"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. Modifications to this attribute can be requested using the \"ModifyVnfInfoData\" structure.\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "Human-readable description of the VNF instance. Modifications to this attribute can be requested using the \"ModifyVnfInfoData\" structure.\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. Representation: string of variable length.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A Version. Representation: string of variable length.\n",
"type": "string"
},
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
"versionDependency": {
"description": "Describes version dependencies currently valid for the VNF instance. Identifies versions of descriptors of other constituents in the NSD upon which the VNF depends. The dependencies may be described for the VNFD referenced in this VnfInfo with vnfdId and for VNFDs with the same VnfdExtInvariantId. There shall not be more than one versionDependency present with the same dependentConstituentId.\n",
"type": "array",
"items": {
"description": "This type represents the information related to all dependencies that an NSD constituent has on the versions of other NSD constituents. It shall comply with the provisions defined in table 6.5.3.112-1.\n",
"type": "object",
"required": ["dependentConstituentId"],
"properties": {
"dependentConstituentId": {
"description": "An identifier that is unique within a NS descriptor. Representation: string of variable length.\n",
"type": "string"
},
"versionDependencyStatement": {
"description": "Identifies one or multiple versions of an NSD constituents upon which the dependent constituent identified by dependentConstituentId has a dependency. Cardinality 0 is used to remove an existing version dependency in a profile.\n",
"type": "array",
"items": {
"description": "This type represents the information related to one or more VNF, NS or PNF descriptor identifiers which describe one single dependency. When more than one descriptor is indicated, they correspond to different versions of the same VNF, NS or PNF and they represent alternatives to fulfil the dependency. It shall comply with the provisions defined in table 6.5.3.113-1.\n",
"type": "object",
"required": ["descriptorId"],
"properties": {
"descriptorId": {
"description": "Identifies a VNFD, NSD or PNFD upon which the entity using this information element depends. When more than one descriptor is indicated, they shall correspond to versions of the same VNF, NS or PNF and they represent. alternatives, i.e. the presence of one of them fulfills the dependency.",
"type": "array",
"items": {
"description": "An identifier that is unique within a NS descriptor. Representation: string of variable length.\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.\nPermitted values: - NOT_INSTANTIATED: The VNF instance is terminated or not instantiated. - INSTANTIATED: The VNF instance is instantiated.\n",
"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", "extCpInfo"],
"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"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\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"
}
}
}
},
"maxScaleLevels": {
"description": "Maximum allowed scale levels of the VNF, one entry per aspect. This attribute shall be present if the VNF supports scaling.\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"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\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. When trunking is enabled, the list of entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated to sub-ports of a trunk.\n",
"type": "array",
"minItems": 1,
"items": {
"description": "This type represents information about an external CP of a VNF. It shall comply with the provisions defined in Table 6.5.3.70-1. NOTE 1: The attributes attributes \"associatedVnfcCpId\", \"associatedVipCpId\", \"associatedVirtualCpId\" and \"associatedVnfVirtualLinkId\" are mutually exclusive. Exactly one shall be present. NOTE 2: An external CP instance is not associated to a link port in the cases indicated for the extLinkPorts attribute in clause 6.5.3.26. NOTE 3: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment definition resource is needed to fulfil the connectivity requirements of the external CP, e.g. to build a link redundant mated pair in SR-IOV cases. NOTE 4: When more than one \"netAttDefResourceId\" is indicated, all shall belong to the same namespace.\n",
"required": ["id", "cpdId", "cpProtocolInfo"],
"required": ["associatedVnfcCpId"]
}, {
"required": ["associatedVipCpId"]
}, {
"required": ["associatedVirtualCpId"]
}, {
"required": ["associatedVnfVirtualLinkId"]
}],
"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"
},
"cpConfigId": {
"description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Network protocol information for this CP.\n",
"type": "array",
"minItems": 1,
"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. NOTE: This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\n",
"required": ["layerProtocol", "ipOverEthernet"],
"description": "The identifier of layer(s) and protocol(s) associated to the network address information. Permitted values: - IP_OVER_ETHERNET\n - IP_FOR_VIRTUAL_CP\nSee note.\n",
"enum": ["IP_OVER_ETHERNET", "IP_FOR_VIRTUAL_CP"]
"description": "This type represents information about a network address that has been assigned.\nNOTE 1: At least one of \"macAddress\" or \"ipAddresses\" shall be present. NOTE 2: Exactly one of \"addresses\" or \"addressRange\" shall be present. NOTE 3: If the Cp instance represents a subport in a trunk, \"segmentationId\" shall be present. Otherwise it shall not be present. NOTE 4: Depending on the NFVI networking infrastructure, the \"segmentationId\" may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local \"segmentationId\" to whatever \"segmentationId\" is actually used by the NFVI's transport technology.\n",
"required": ["macAddress"]
}, {
"required": ["ipAddresses"]
}],
"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"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. See note 3 and note 4.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. See note 1.\n",
"type": "array",
"items": {
"type": "object",
"required": ["type"],
"required": ["addresses"]
}, {
"required": ["addressRange"]
}],
"description": "The type of the IP addresses. Permitted values: - IPV4 - IPV6\n",
"enum": ["IPV4", "IPV6"]
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). See note 2.\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"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present. See note 2.\n",
"required": ["minAddress", "maxAddress"],
"properties": {
"minAddress": {
"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"
},
"maxAddress": {
"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"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
}
}
}
},
"type": {
"description": "The type of the IP addresses\n",
"type": "string",
"enum": ["PV4", "PV6"]
},
"addresses": {
"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"
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g. in case of egress connections. See note.\n",
"type": "object",
"required": ["minAddress", "maxAddress"],
"properties": {
"minAddress": {
"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"
},
"maxAddress": {
"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"
}
}
},
"minAddress": {
"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"
},
"maxAddress": {
"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"
},
"subnetId": {
"description": "An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
},
"virtualCpAddress": {
"description": "This type represents information about a network address that has been assigned to a virtual CP.\n",
"type": "object",
"required": ["type"],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: - IPV4 - IPV6\n",
"type": "string",
"enum": ["IPV4", "IPV6"]
},
"loadBalancerIp": {
"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"
}
}
}
}
}
},
"extLinkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"netAttDefResourceId": {
"description": "Identifier of the \"NetAttDefResourceInfo\" structure that provides the specification of the interface to attach the connection point to a secondary container cluster network. See notes 3 and 4.\nIt shall be present if the external CP is associated to a VNFC realized by one or a set of OS containers and is connected to a secondary container cluster network. It shall not be present otherwise.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"metadata": {
"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"
},
"associatedVnfcCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"associatedVipCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"associatedVirtualCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
}
}
},
"vipCpInfo": {
"description": "VIP CPs that are part of the VNF instance. Shall be present when that particular VIP CP of the VNFC instance is associated to an external CP of the VNF instance. May be present otherwise.\n",
"type": "array",
"items": {
"description": "This type provides information related to virtual IP (VIP) CP. It shall comply with the provisions defined in table 6.5.3.97 1. NOTE: It is possible that there is no associated VnfcCp because the VIP CP is available but not associated yet.\n",
"type": "object",
"required": ["cpInstanceId", "cpdId"],
"properties": {
"cpInstanceId": {
"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"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfExtCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Protocol information for this CP. There shall be one cpProtocolInfo for layer 3. There may be one cpProtocolInfo for layer 2.\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. NOTE: This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\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\n - IP_FOR_VIRTUAL_CP\nSee note.\n",
"type": "string",
"enum": ["IP_OVER_ETHERNET", "IP_FOR_VIRTUAL_CP"]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\nNOTE 1: At least one of \"macAddress\" or \"ipAddresses\" shall be present. NOTE 2: Exactly one of \"addresses\" or \"addressRange\" shall be present. NOTE 3: If the Cp instance represents a subport in a trunk, \"segmentationId\" shall be present. Otherwise it shall not be present. NOTE 4: Depending on the NFVI networking infrastructure, the \"segmentationId\" may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local \"segmentationId\" to whatever \"segmentationId\" is actually used by the NFVI's transport technology.\n",
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
"type": "object",
"anyOf": [{
"required": ["macAddress"]
}, {
"required": ["ipAddresses"]
}],
"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"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. See note 3 and note 4.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. See note 1.\n",
"type": "array",
"items": {
"type": "object",
"required": ["type"],
"oneOf": [{
"required": ["addresses"]
}, {
"required": ["addressRange"]
}],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: - IPV4 - IPV6\n",
"type": "string",
"enum": ["IPV4", "IPV6"]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). See note 2.\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"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present. See note 2.\n",
"type": "object",
"required": ["minAddress", "maxAddress"],
"properties": {
"minAddress": {
"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"
},
"maxAddress": {
"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"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
"type": "string"
}
}
}
},
"type": {
"description": "The type of the IP addresses\n",
"type": "string",
"enum": ["PV4", "PV6"]
},
"addresses": {
"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"
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g. in case of egress connections. See note.\n",
"type": "object",
"required": ["minAddress", "maxAddress"],
"properties": {
"minAddress": {
"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"
},
"maxAddress": {
"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"
}
}
},
"minAddress": {
"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"
},
"maxAddress": {
"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"
},
"subnetId": {
"description": "An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
}
}
},
"virtualCpAddress": {
"description": "This type represents information about a network address that has been assigned to a virtual CP.\n",
"type": "object",
"required": ["type"],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: - IPV4 - IPV6\n",
"type": "string",
"enum": ["IPV4", "IPV6"]
},
"loadBalancerIp": {
"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"
}
}
}
}
}
},
"associatedVnfcCpIds": {
"description": "Identifiers of the VnfcCps that share the virtual IP addresse allocated to the VIP CP instance. See note.\n",
"type": "array",
"items": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
}
},
"vnfLinkPortId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"metadata": {
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
"description": "Allows the OSS/BSS to provide additional parameter(s) to the termination process at the NS level.\n",
"type": "array",
"items": {
"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"
}
}
}
}
},
"virtualCpInfo": {
"description": "virtual CPs that are part of the VNF instance. Shall be present when a particular virtual CP is associated to an external CP of the VNF instance. May be present otherwise.\n",
"type": "array",
"items": {
"description": "This type represents the information related to a virtual CP instance of a VNF. NOTE: A consumer of the VNF LCM interface can learn the actual VNFC instances implementing the service accessible via the virtual CP instance by querying the \"vnfcResourceInfo\" from the \"InstantiatedVnfInfo\" and filtering by corresponding \"vduId\" values.",
"type": "object",
"required": ["cpInstanceId", "cpdId", "resourceHandle", "vduId"],
"properties": {
"cpInstanceId": {
"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"
},
"resourceHandle": {
"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.\nNOTE 1:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the CISM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. When the container infrastructure service is a Kubernetes® instance the vimLevelResourceType is the type of resource, as would correspond to the kind field if the resource is declared in its own Kubernetes® manifest, e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition. NOTE 2:\tWhen the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the following way: * For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide per resource type. * For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, i.e. the value of the claimName field in the Kubernetes® manifest, or a compound name built by Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own manifest. * For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of the metadata.name field in Kubernetes® manifest. \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 the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "Additional resource information which is specific to this resource and its type, and which is available from the VIM or the CISM or the resource provider. See note 1.\n",
"type": "string"
},
"vimLevelAdditionalResourceInfo": {
"description": "This type represents additional resource information which resource and resource type specific, and which is available from the VIM or the CISM or the resource provider. NOTE:\tAt least one attribute shall be present. \n",
"type": "object",
"properties": {
"hostName": {
"description": "Name of the host where the resource is allocated. It shall be present for compute resources in the scope of the CISM and shall be absent otherwise. See note.\n",
"type": "string"
},
"persistentVolume": {
"description": "Name of the persistent volume to which the persistent volume claim representing the storage resource is bound. It may be present for storage resources in the scope of the CISM and shall be absent otherwise. See note.\n",
"type": "string"
},
"additionalInfo": {
"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"
}
}
},
"containerNamespace": {
"description": "The value of the namespace in which the MCIO corresponding to the resource is deployed. This attribute shall be present if the resource is managed by a CISM and it shall be absent otherwise.\n",
"type": "string"
}
}
},
"vnfExtCpId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"cpProtocolInfo": {
"description": "Protocol information for this CP. There shall be one cpProtocolInfo for each layer protocol supported.\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. NOTE: This attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported.\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\n - IP_FOR_VIRTUAL_CP\nSee note.\n",
"type": "string",
"enum": ["IP_OVER_ETHERNET", "IP_FOR_VIRTUAL_CP"]
},
"ipOverEthernet": {
"description": "This type represents information about a network address that has been assigned.\nNOTE 1: At least one of \"macAddress\" or \"ipAddresses\" shall be present. NOTE 2: Exactly one of \"addresses\" or \"addressRange\" shall be present. NOTE 3: If the Cp instance represents a subport in a trunk, \"segmentationId\" shall be present. Otherwise it shall not be present. NOTE 4: Depending on the NFVI networking infrastructure, the \"segmentationId\" may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local \"segmentationId\" to whatever \"segmentationId\" is actually used by the NFVI's transport technology.\n",
"type": "object",
"anyOf": [{
"required": ["macAddress"]
}, {
"required": ["ipAddresses"]
}],
"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"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. See note 3 and note 4.\n",
"type": "string"
},
"ipAddresses": {
"description": "Addresses assigned to the CP instance. Each entry represents IP addresses assigned by fixed or dynamic IP address assignment per subnet. See note 1.\n",
"type": "array",
"items": {
"type": "object",
"required": ["type"],
"oneOf": [{
"required": ["addresses"]
}, {
"required": ["addressRange"]
}],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: - IPV4 - IPV6\n",
"type": "string",
"enum": ["IPV4", "IPV6"]
},
"addresses": {
"description": "Fixed addresses assigned (from the subnet defined by \"subnetId\" if provided). See note 2.\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"
}
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g., in case of egress connections. Exactly one of \"addresses\" or \"addressRange\" shall be present. See note 2.\n",
"type": "object",
"required": ["minAddress", "maxAddress"],
"properties": {
"minAddress": {
"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"
},
"maxAddress": {
"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"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
}
}
}
},
"type": {
"description": "The type of the IP addresses\n",
"type": "string",
"enum": ["PV4", "PV6"]
},
"addresses": {
"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"
},
"isDynamic": {
"description": "Indicates whether this set of addresses was assigned dynamically (true) or based on address information provided as input from the API consumer (false). Shall be present if \"addresses\" is present and shall be absent otherwise.\n",
"type": "boolean"
},
"addressRange": {
"description": "An IP address range used, e.g. in case of egress connections. See note.\n",
"type": "object",
"required": ["minAddress", "maxAddress"],
"properties": {
"minAddress": {
"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"
},
"maxAddress": {
"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"
}
}
},
"minAddress": {
"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"
},
"maxAddress": {
"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"
},
"subnetId": {
"description": "An identifier maintained by the VIM or the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
}
}
},
"virtualCpAddress": {
"description": "This type represents information about a network address that has been assigned to a virtual CP.\n",
"type": "object",
"required": ["type"],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: - IPV4 - IPV6\n",
"type": "string",
"enum": ["IPV4", "IPV6"]
},
"loadBalancerIp": {
"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"
}
}
}
}
}
},
"vduId": {
"description": "Reference to the VDU(s) which implement the service accessible via the virtual CP instance. See note.\n",
"type": "array",
"items": {
"description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
"type": "string"
}
},
"additionalServiceInfo": {
"description": "Additional service identification information of the virtual CP instance.\n",
"type": "array",
"items": {
"description": "This type represents the additional service information of the virtual CP instance used to expose properties of the virtual CP to NFV-MANO.\nNOTE: This attribute shall only be present if additional information is needed to identify the service termination within the VNF, such as for example a URL path information in an HTTP request required to allow a single virtual CP IP address to be used for several HTTP based services that use the same port number.",
"type": "object",
"required": ["portInfo"],
"properties": {
"portInfo": {
"description": "Service port numbers exposed by the virtual CP instance.\n",
"type": "array",
"items": {
"description": "This type represents the information related to the service identifying port properties exposed by the virtual CP instance.",
"type": "object",
"required": ["name", "protocol", "port", "isPortConfigurable"],
"properties": {
"name": {
"description": "The name of the port exposed by the virtual CP instance.\n",
"type": "string"
},
"protocol": {
"description": "The L4 protocol for this port exposed by the virtual CP instance. Permitted values:\n - TCP\n - UDP\n - SCTP\n",
"type": "string",
"enum": ["TCP", "UDP", "SCTP"]
},
"port": {
"description": "The L4 port number exposed by the virtual CP instance.\n",
"type": "integer"
},
"isPortConfigurable": {
"description": "Specifies whether the port attribute value is allowed to be configurable.\n",
"type": "boolean"
}
}
}
},
"serviceInfo": {
"description": "Service matching information exposed by the virtual CP instance. See note.\n",
"type": "array",
"items": {
"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"
}
}
}
}
},
"metadata": {
"description": "Metadata about this virtual CP instance.\n",
"type": "array",
"items": {
"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"
}
}
}
}
},
"extVirtualLinkInfo": {
"description": "Information about the external VLs the VNF instance is connected to.\n",
"type": "array",
"items": {
"description": "This type represents information about an VNF external VL.",
"required": ["id", "resourceHandle", "currentVnfExtCpData"],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"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.\nNOTE 1:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the CISM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. When the container infrastructure service is a Kubernetes® instance the vimLevelResourceType is the type of resource, as would correspond to the kind field if the resource is declared in its own Kubernetes® manifest, e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition. NOTE 2:\tWhen the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the following way: * For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide per resource type. * For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, i.e. the value of the claimName field in the Kubernetes® manifest, or a compound name built by Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own manifest. * For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of the metadata.name field in Kubernetes® manifest. \n",
"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 the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "Additional resource information which is specific to this resource and its type, and which is available from the VIM or the CISM or the resource provider. See note 1.\n",
"type": "string"
},
"vimLevelAdditionalResourceInfo": {
"description": "This type represents additional resource information which resource and resource type specific, and which is available from the VIM or the CISM or the resource provider. NOTE:\tAt least one attribute shall be present. \n",
"type": "object",
"properties": {
"hostName": {
"description": "Name of the host where the resource is allocated. It shall be present for compute resources in the scope of the CISM and shall be absent otherwise. See note.\n",
"type": "string"
},
"persistentVolume": {
"description": "Name of the persistent volume to which the persistent volume claim representing the storage resource is bound. It may be present for storage resources in the scope of the CISM and shall be absent otherwise. See note.\n",
"type": "string"
},
"additionalInfo": {
"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"
}
}
},
"containerNamespace": {
"description": "The value of the namespace in which the MCIO corresponding to the resource is deployed. This attribute shall be present if the resource is managed by a CISM and it shall be absent otherwise.\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"description": "This type represents information about a link port of an external VL, i.e. a port providing connectivity for the VNF to an NS VL. NOTE 1: The use cases UC#4 and UC#5 in Annex A.4 of ETSI GS NFV-IFA 007 provide examples for such a configuration. NOTE 2: The value of \"trunkResourceId\" is scoped by the value of \"vimConnectionId\" in the \"resourceHandle\" attribute.\n",
"required": ["id", "resourceHandle"],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"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.\nNOTE 1:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the CISM, the WIM or the resource provider and can be used as information that complements the ResourceHandle. When the container infrastructure service is a Kubernetes® instance the vimLevelResourceType is the type of resource, as would correspond to the kind field if the resource is declared in its own Kubernetes® manifest, e.g.: Pod, PersistentVolumeClaim, NetworkAttachmentDefinition. NOTE 2:\tWhen the container infrastructure service is a Kubernetes® instance the resourceId shall be populated in the following way: * For a compute MCIO, it is the instance identifier that Kubernetes® assigns, which is unique cluster wide per resource type. * For a storage MCIO modelled as a persistent volume claim, it is the name of the persistent volume claim, i.e. the value of the claimName field in the Kubernetes® manifest, or a compound name built by Kubernetes® if the persistent volume claim is defined inline in another template instead of in its own manifest. * For a network MCIO representing a NetworkAttachmentDefinition, a Service or an Ingress, it is the value of the metadata.name field in Kubernetes® manifest. \n",
"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 the CISM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "Additional resource information which is specific to this resource and its type, and which is available from the VIM or the CISM or the resource provider. See note 1.\n",
"type": "string"
},
"vimLevelAdditionalResourceInfo": {
"description": "This type represents additional resource information which resource and resource type specific, and which is available from the VIM or the CISM or the resource provider. NOTE:\tAt least one attribute shall be present. \n",
"type": "object",
"properties": {
"hostName": {
"description": "Name of the host where the resource is allocated. It shall be present for compute resources in the scope of the CISM and shall be absent otherwise. See note.\n",
"type": "string"
},
"persistentVolume": {
"description": "Name of the persistent volume to which the persistent volume claim representing the storage resource is bound. It may be present for storage resources in the scope of the CISM and shall be absent otherwise. See note.\n",
"type": "string"
},
"additionalInfo": {
"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"
}
}
},
"containerNamespace": {
"description": "The value of the namespace in which the MCIO corresponding to the resource is deployed. This attribute shall be present if the resource is managed by a CISM and it shall be absent otherwise.\n",