"description":"This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n\"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\nfollow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n",
"description":"This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n\"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2: With this information, the NFVO has available information about the set of VIMs and associated VIM\n connection information that have been configured into the VNFM.\n",
"description":"An identifier with the intention of being globally unique.\n",
@@ -18,9 +24,19 @@
"type":"string"
},
"type":{
"description":"The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - CISM The peer functional entity is a CISM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n",
"description":"The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - CISM The peer functional entity is a CISM. - CIR The NFV-MANO functional entity is a CIR. - CCM The NFV-MANO functional entity is a CCM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n",
"description":"Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n",
@@ -28,11 +44,33 @@
},
"consumedManoInterfaces":{
"description":"Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n",
"type":"object",
"type":"object"
},
"vimConnectionInfos":{
"description":"Map of VIM connection information. The VimConnectionInfo is specified in clause 4.4.1.6 of ETSI GS NFV-SOL 003. This attribute can be modified with the PATCH method. May be present only if the \"type\" attribute in the \"PeerEntity” is either a \"VIM\", a \"CISM\" or a \"CIR\", and the NFV-MANO entity being configured is a \"VNFM\" or \"NFVO\" as indicated by the \"type\" attribute in the \"ManoEntity\". In case it is present, the value of the \"vimId\" in the \"VimConnectionInfo\" shall be equal to the value of \"peerEntityId\". In addition, the content of \"interfaceInfo\", \"accessInfo” and \"extra\" (if applicable) of the “VimConnectionInfo\" shall be provided by means in scope of the present document.\n",
"type":"array",
"items":{
"type":"object"
}
},
"vnfmConfiguredVimConnectionInfoIds":{
"description":"List of VIM connection information identifiers that identify the set of VIMs and associated VIM connection information that have been configured into the VNFM whose identifier is equal to the “peerEntityId“. See note 2. Only applicable if the \"type” attribute in the \"ManoEntity\" is \"NFVO\" and the \"type” attribute in the \"PeerEntity\" is a \"VNFM\".\n",
"type":"array",
"items":{
"description":"An identifier with the intention of being globally unique.\n",
"type":"string"
},
"additionalProperties":{
"description":"This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n",
"description":"Human-readable name of the NFV-MANO interface.\n",
@@ -71,19 +109,28 @@
"type":"string"
}
},
"required":["apiUri"]
"required":[
"apiUri"
]
},
"securityInfo":{
"description":"This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n",
"type":"object",
"required":["authType","oauthServerInfo"],
"required":[
"authType",
"oauthServerInfo"
],
"properties":{
"authType":{
"description":"Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749.\n",
"description":"Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - TLS_TUNNEL_13: Using TLS tunnel, as defined by TLS 1.3 in IETF RFC 8446. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749.\n",
"type":"array",
"items":{
"type":"string",
"enum":["TLS_TUNNEL","OAUTH2"]
"enum":[
"TLS_TUNNEL",
"TLS_TUNNEL_13",
"OAUTH2"
]
},
"minItems":1
},
@@ -94,7 +141,9 @@
"dynamicDiscovery":{
"description":"Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n",
"type":"object",
"required":["webFingerHost"],
"required":[
"webFingerHost"
],
"properties":{
"webFingerHost":{
"description":"Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n",
@@ -106,7 +155,9 @@
"providedConfiguration":{
"description":"Configuration data used to setup the authorization server identifier. See note.\n",
"type":"object",
"required":["authServerId"],
"required":[
"authServerId"
],
"properties":{
"authServerId":{
"description":"Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n",
@@ -151,15 +202,28 @@
"operationalState":{
"description":"The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n",
"description":"The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n",
