Newer
Older
type: string
enum:
- ALL
- LB
forwardingBehaviourInputParameters:
description: >
Provides input parameters to configure the forwarding behaviour (e.g. identifies
a load balancing algorithm and criteria).
$ref: "#/definitions/ForwardingBehaviourInputParameters"
CpPairInfo:
description: >
This type represents describes a pair of ingress and egress CPs or SAPs which
the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.
type: object
properties:
vnfExtCpIds:
description: >
Identifier(s) of the VNF CP(s) which form the pair.
The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates
that the CP or SAP is used both as an ingress and egress port at a particular
NFP position.
type: array
maxItems: 2
items:
$ref: "#/definitions/IdentifierInVnf"
pnfExtCpIds:
description: >
Identifier(s) of the PNF CP(s) which form the pair.
The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates
that the CP or SAP is used both as an ingress and egress port at a particular
NFP position.
type: array
maxItems: 2
items:
$ref: "#/definitions/IdentifierInPnf"
sapIds:
description: >
Identifier(s) of the SAP(s) which form the pair.
The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates
that the CP or SAP is used both as an ingress and egress port at a particular
NFP position.
type: array
maxItems: 2
items:
$ref: "#/definitions/IdentifierInNs"
Samir Medjiah
committed
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
ForwardingBehaviourInputParameters:
description: >
This type represents provides input parameters to configure the forwarding behaviour.
It shall comply with the provisions defined in Table 6.5.3.73-1.
type: object
properties:
algortihmName:
description: >
May be included if forwarding behaviour is equal to LB. Shall not be included otherwise.
Permitted values:
* ROUND_ROBIN
* LEAST_CONNECTION
* LEAST_TRAFFIC
* LEAST_RESPONSE_TIME
* CHAINED_FAILOVER
* SOURCE_IP_HASH
* SOURCE_MAC_HASH
type: string
enum:
- ROUND_ROBIN
- LEAST_CONNECTION
- LEAST_TRAFFIC
- LEAST_RESPONSE_TIME
- CHAINED_FAILOVER
- SOURCE_IP_HASH
Samir Medjiah
committed
algorithmWeights:
description: >
Percentage of messages sent to a CP instance. May be included if applicable to
the algorithm.
If applicable to the algorithm but not provided, default values determined by
the VIM or NFVI are expected to be used.
Weight applies to the CP instances in the order they have been created.
type: array
items:
type: integer
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
CpProtocolInfo:
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.
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.
type: string
enum:
- IP_OVER_ETHERNET
ipOverEthernet:
description: >
IP addresses over Ethernet to assign to the CP
or SAP instance. Shall be present if
layerProtocol is equal to "
IP_OVER_ETHERNET", and shall be absent otherwise.
$ref: "#/definitions/IpOverEthernetAddressInfo"
IpOverEthernetAddressInfo:
moscatelli
committed
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.
type: object
required:
- macAddress
- ipAddresses
- subnetId
- addresses
- addressRange
properties:
macAddress:
description: >
Assigned MAC address.
$ref: "#/definitions/MacAddress"
moscatelli
committed
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
ipAddresses:
description: >
Addresses assigned to the CP instance. Each entry represents IP
addresses assigned by fixed or dynamic IP address assignment per
subnet.
type: array
items:
type: object
required:
- type
properties:
type:
description: >
The type of the IP addresses.
Permitted values: IPV4, IPV6.
type: string
enum:
- IPV4
- IPV6
addresses:
description: >
Fixed addresses assigned (from the subnet defined by
"subnetId" if provided).
type: array
items:
$ref: "#/definitions/IpAddress"
moscatelli
committed
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.
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.
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
description: >
Lowest IP address belonging to the range.
$ref: "#/definitions/IpAddress"
moscatelli
committed
maxAddress:
description: >
Highest IP address belonging to the range
$ref: "#/definitions/IpAddress"
moscatelli
committed
subnetId:
description: >
Subnet defined by the identifier of the subnet resource in
the VIM.
In case this attribute is present, IP addresses are bound
to that subnet.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
moscatelli
committed
type:
description: >
The type of the IP addresses
type: string
enum:
- PV4
- PV6
addresses:
description: >
Fixed addresses assigned (from the subnet
defined by "subnetId" if provided). See note.
type: array
items:
$ref: "#/definitions/IpAddress"
moscatelli
committed
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.
type: boolean
addressRange:
description: >
An IP address range used, e.g. in case of egress
connections. See note.
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
description: >
Lowest IP address belonging to the range.
$ref: "#/definitions/IpAddress"
moscatelli
committed
maxAddress:
description: >
Highest IP address belonging to the range
$ref: "#/definitions/IpAddress"
moscatelli
committed
minAddress:
description: >
Lowest IP address belonging to the range
$ref: "#/definitions/IpAddress"
moscatelli
committed
maxAddress:
description: >
Highest IP address belonging to the range.
$ref: "#/definitions/IpAddress"
moscatelli
committed
subnetId:
description: >
Subnet defined by the identifier of the subnet
resource in the VIM.
In case this attribute is present, IP addresses
are bound to that subnet.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim"
moscatelli
committed
ExtVirtualLinkInfo:
type: object
required:
- id
- resourceHandle
properties:
id:
moscatelli
committed
description: >
Identifier of the external VL and the related external VL
information instance.
The identifier is assigned by the NFV-MANO entity that manages this
VL instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Reference to the resource realizing this VL.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
extLinkPorts:
description: >
Link ports of this VL.
type: array
items:
$ref: "#/definitions/ExtLinkPortInfo"
ExtLinkPortInfo:
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.
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that has
created the link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Reference to the virtualised resource realizing this link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
cpInstanceId:
description: >
Identifier of the external CP of the VNF connected to this link
port. There shall be at most one link port associated with any
external connection point instance. The value refers to an
"extCpInfo" item in the VnfInstance.
$ref: "#/definitions/IdentifierInVnf"
ExtManagedVirtualLinkInfo:
type: object
required:
- id
- vnfVirtualLinkDescId
properties:
id:
description: >
Identifier of the externally-managed internal VL and the related
externally-managed VL information instance.
The identifier is assigned by the NFV-MANO entity that manages this
VL instance.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
networkResource:
description: >
Reference to the VirtualNetwork resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
vnfLinkPorts:
description: >
Link ports of this VL.
type: array
items:
$ref: "#/definitions/VnfLinkPortInfo"
VnfLinkPortInfo:
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that has created the link port.
$ref: "#/definitions/IdentifierInVnf"
resourceHandle:
description: >
Reference to the virtualised network resource realizing this link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
cpInstanceId:
description: >
When the link port is used for external connectivity by the VNF,
this attribute represents the identifier of the external CP of the
VNF to be connected to this link port.
When the link port is used for internal connectivity in the VNF,
this attribute represents the VNFC CP to be connected to this link
port.
Shall be present when the link port is used for external
connectivity by the VNF.
may be present if used to reference a VNFC CP instance.
There shall be at most one link port associated with any external
connection point instance or internal connection point
(i.e. VNFC CP) instance.
The value refers to an "extCpInfo" item in the VnfInstance or a
"vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance.
$ref: "#/definitions/IdentifierInVnf"
cpInstanceType:
description: >
Type of the CP instance that is identified by cpInstanceId.
Shall be present if "cpInstanceId" is present, and shall be
absent otherwise.
Permitted values:
* VNFC_CP: The link port is connected to a VNFC CP
* EXT_CP: The link port is associated to an external CP.
type: string
enum:
- VNFC_CP
- EXT_CP
MonitoringParameter:
type: object
required:
- id
- value
- timeStamp
properties:
id:
description: >
Identifier of the monitoring parameter defined in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
name:
description: >
Human readable name of the monitoring parameter, as defined in the VNFD.
type: string
value:
description: >
Value of the monitoring parameter known to the VNFM (e.g. obtained
rameshnaraya
committed
for auto-scaling purposes).
The type of the "value" attribute (i.e. scalar, structure (Object in
JSON), or array (of scalars, arrays or structures/Objects)) is
assumed to be defined in an external measurement specification.
type: object
rameshnaraya
committed
timeStamp:
description: >
Represents the point in time when the measurement has been performed,
as known to the VNFM.
Should be formatted according to ETF RFC 3339.
type: string
VnfcResourceInfo:
description: >
This type represents the information on virtualised compute and storage
resources used by a VNFC in a VNF instance.
type: object
required:
- id
- vduId
- computeResource
properties:
id:
description: >
Identifier of this VnfcResourceInfo instance.
$ref: "#/definitions/IdentifierInVnf"
vduId:
description: >
Reference to the applicable VDU in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
computeResource:
description: >
Reference to the VirtualCompute resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
storageResourceIds:
description: >
References to the VirtualStorage resources. The value refers to a
VirtualStorageResourceInfo item in the VnfInstance.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfcCpInfo:
description: >
CPs of the VNFC instance.
Shall be present when that particular CP of the VNFC instance is
associated to an external CP of the VNF instance.
May be present otherwise.
type: array
items:
type: object
required:
- id
- cpdId
properties:
id:
description: >
Identifier of this VNFC CP instance and the associated array
entry.
$ref: "#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the VDU CPD, cpdId, in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfExtCpId:
description: >
When the VNFC CP is exposed as external CP of the VNF, the
identifier of this external VNF CP.
$ref: "#/definitions/IdentifierInVnf"
cpProtocolInfo:
description: >
Network protocol information for this CP.
type: array
items:
$ref: "#/definitions/CpProtocolInfo"
vnfLinkPortId:
description: >
Identifier of the "vnfLinkPorts" structure in the
"VnfVirtualLinkResourceInfo" structure. Shall be present if
the CP is associated to a link port.
$ref: "#/definitions/IdentifierInVnf"
metadata:
description: >
Metadata about this CP.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Metadata about this resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
VnfVirtualLinkResourceInfo:
moscatelli
committed
description: >
This type represents the information that allows addressing a virtualised
resource that is used by an internal VL instance in a VNF instance.
type: object
required:
- id
- vnfVirtualLinkDescId
- networkResource
properties:
id:
description: >
Identifier of this VnfVirtualLinkResourceInfo instance.
$ref: "#/definitions/IdentifierInVnf"
moscatelli
committed
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
networkResource:
description: >
Reference to the VirtualNetwork resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfLinkPorts:
description: >
Links ports of this VL.
Shall be present when the linkPort is used for external connectivity
by the VNF (refer to VnfLinkPortInfo).
May be present otherwise.
type: array
items:
$ref: "#/definitions/VnfLinkPortInfo"
metadata:
description: >
Metadata about this resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
VirtualStorageResourceInfo:
moscatelli
committed
description: >
This type represents the information that allows addressing a virtualised
resource that is used by a VNF instance.
type: object
required:
- id
- virtualStorageDescId
- storageResource
properties:
id:
description: >
Identifier of this VirtualStorageResourceInfo instance.
$ref: "#/definitions/IdentifierInVnf"
moscatelli
committed
virtualStorageDescId:
description: >
Identifier of the VirtualStorageDesc in the VNFD.
$ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
moscatelli
committed
storageResource:
description: >
Reference to the VirtualStorage resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
metadata:
description: >
Metadata about this resource.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
moscatelli
committed
description: >
This type represents information about a link port of a VL instance.
It shall comply with the provisions defined in Table 6.5.3.55-1.
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that
has created the link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
resourceHandle:
description: >
Identifier of the virtualised network resource realizing
this link port.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
moscatelli
committed
nsCpHandle:
description: >
Identifier of the CP/SAP instance to be connected to this
link port. The value refers to a vnfExtCpInfo item in the
VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a
sapInfo item in the NS instance.
There shall be at most one link port associated with any
connection point instance.
moscatelli
committed
AffinityOrAntiAffinityRule:
moscatelli
committed
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
description: >
This type describes the additional affinity or anti-affinity rule
applicable between the VNF instances to be instantiated
in the NS instantiation operation request or between the VNF instances
to be instantiated in the NS instantiation
operation request and the existing VNF instances..
type: object
required:
- affinityOrAntiAffiinty
- scope
properties:
vnfdId:
description: >
Reference to a VNFD.
When the VNFD which is not used to instantiate VNF, it
presents all VNF instances of this type as the subjects
of the affinity or anti-affinity rule. The VNF instance
which the VNFD presents is not necessary as a part of
the NS to be instantiated.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfProfileId:
description: >
Reference to a vnfProfile defined in the NSD.
At least one VnfProfile which is used to instantiate VNF
for the NS to be instantiated as the subject of the affinity
or anti-affinity rule shall be present. When the VnfProfile
which is not used to instantiate VNF, it presents all VNF
instances of this type as the subjects of the affinity or
anti-affinity rule. The VNF instance which the VnfProfile
presents is not necessary as a part of the NS to be instantiated.
type: array
items:
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
vnfInstanceId:
description: >
Reference to the existing VNF instance as the subject of
the affinity or anti-affinity rule. The existing VNF instance
is not necessary as a part of the NS to be instantiated.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
affinityOrAntiAffiinty:
description: >
The type of the constraint.
Permitted values:
AFFINITY
ANTI_AFFINITY.
type: string
enum:
- AFFINITY
- ANTI_AFFINITY
scope:
description: >
Specifies the scope of the rule where the placement
constraint applies.
Permitted values:
NFVI_POP
ZONE
ZONE_GROUP
NFVI_NODE.
type: string
enum:
- NFVI_POP
- ZONE
- ZONE_GROUP
- NFVI_NODE
InstantiateNsRequest:
type: object
required:
moscatelli
committed
- nsFlavourId
properties:
nsFlavourId:
description: >
Identifier of the NS deployment flavor to be instantiated.
$ref: "#/definitions/IdentifierInNsd"
sapData:
description: >
moscatelli
committed
Create data concerning the SAPs of this NS.
moscatelli
committed
items:
$ref: "#/definitions/SapData"
addpnfData:
description: >
Information on the PNF(s) that are part of this NS.
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddPnfData"
vnfInstanceData:
description: >
Specify an existing VNF instance to be used in the NS.
If needed, the VNF Profile to be used for this VNF
instance is also provided.
The DF of the VNF instance shall match the VNF DF
present in the associated VNF Profile.
moscatelli
committed
items:
$ref: "#/definitions/VnfInstanceData"
nestedNsInstanceData:
description: >
Specify an existing NS instance to be used as a nested
NS within the NS.
If needed, the NS Profile to be used for this nested NS
instance is also provided.
NOTE 2: The NS DF of each nested NS shall be one of the
allowed flavours in the associated NSD (as referenced in the
nestedNsd attribute of the NSD of the NS to be instantiated).
NOTE 3: The NSD of each referenced NSs (i.e. each
nestedInstanceId) shall match the one of the nested NSD in
the composite NSD.
moscatelli
committed
items:
$ref: "#/definitions/NestedNsInstanceData"
locationConstraints:
description: >
Defines the location constraints for the VNF to be
instantiated as part of the NS instantiation.
An example can be a constraint for the VNF to be in a
specific geographic location..
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfLocationConstraint"
additionalParamsForNs:
description: >
Allows the OSS/BSS to provide additional parameter(s)
at the composite NS level (as opposed to the VNF level,
which is covered in additionalParamsForVnf), and as
opposed to the nested NS level, which is covered in
additionalParamForNestedNs.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
additionalParamForNestedNs:
description: >
Allows the OSS/BSS to provide additional parameter(s)
per nested NS instance (as opposed to the composite NS
level, which is covered in additionalParamForNs, and as
opposed to the VNF level, which is covered in
additionalParamForVnf). This is for nested NS instances
that are to be created by the NFVO as part of the NS
instantiation and not for existing nested NS instances that
are referenced for reuse.
type: array
items:
$ref: "#/definitions/ParamsForNestedNs"
additionalParamsForVnf:
description: >
Allows the OSS/BSS to provide additional parameter(s)
per VNF instance (as opposed to the composite NS level,
which is covered in additionalParamsForNs and as opposed
to the nested NS level, which is covered in
additionalParamForNestedNs). This is for VNFs that are
to be created by the NFVO as part of the NS instantiation
and not for existing VNF that are referenced for reuse.
moscatelli
committed
items:
$ref: "#/definitions/ParamsForVnf"
startTime:
description: >
Timestamp indicating the earliest time to instantiate the NS.
Cardinality "0" indicates the NS instantiation takes place immediately.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsInstantiationLevelId:
description: >
Identifies one of the NS instantiation levels declared in
the DF applicable to this NS instance. If not present, the
default NS instantiation level as declared in the NSD
shall be used.
$ref: "#/definitions/IdentifierInNsd"
additionalAffinityOrAntiAffinityRule:
moscatelli
committed
Specifies additional affinity or anti-affinity constraint for
the VNF instances to be instantiated as part of the NS
instantiation.
Shall not conflict with rules already specified in the NSD.
moscatelli
committed
items:
$ref: "#/definitions/AffinityOrAntiAffinityRule"
ParamsForNestedNs:
description: >
This type specifies additional parameters on a per-nested NS instance basis.
It shall comply with the provisions defined in Table 6.5.3.21a-1.
type: object
required:
- nsProfileId
properties:
nsProfileId:
description: >
Identifier of a NsProfile to which the additional parameters apply.
$ref: "#/definitions/IdentifierInNsd"
additionalParam:
description: >
Additional parameters that are to be applied on a per nested NS instance.
type: array
items:
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
description: >
This type defines the additional parameters for the VNF instance
to be created associated with an NS instance.
It shall comply with the provisions defined in Table 6.5.3.22-1.
type: object
required:
- vnfProfileId
properties:
vnfProfileId:
description: >
Identifier of (reference to) a vnfProfile to which the
additional parameters apply.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
additionalParams:
description: >
Additional parameters that are applied for the VNF
instance to be created.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
moscatelli
committed
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
description: >
This type represents location constraints for a VNF to be instantiated.
The location constraints shall be presented as a
country code, optionally followed by a civic address based on
the format defined by IETF RFC 4776 [13].
type: object
required:
- countryCode
properties:
countryCode:
description: >
The two-letter ISO 3166 [29] country code in capital letters.
type: string
civicAddressElement:
description: >
Zero or more elements comprising the civic address.
type: array
items:
type: object
required:
- caType
- caValue
properties:
caType:
description: >
Describe the content type of caValue. The value of
caType shall comply with Section 3.4 of IETF
RFC 4776 [13].
type: integer
caValue:
description: >
Content of civic address element corresponding to the
caType. The format caValue shall comply with
Section 3.4 of IETF RFC 4776 [13].
type: string
moscatelli
committed
description: >
This type represents the association of location constraints to a VNF instance
to be created according to a specific VNF profile.
It shall comply with the provisions defined in Table 6.5.3.20-1.
type: object
required:
- vnfProfileId
properties:
vnfProfileId:
description: >
Identifier of (reference to) a vnfProfile to which the
additional parameters apply.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
locationConstraints:
description: >
Defines the location constraints for the VNF instance to
be created based on the VNF profile.
$ref: "#/definitions/LocationConstraints"
moscatelli
committed
description: >
This type specifies an existing VNF instance to be used in the NS instance and
if needed, the VNF Profile to use for this VNF instance.
It shall comply with the provisions defined in Table 6.5.3.19-1.
type: object
required:
- vnfInstanceId
- vnfProfileId
properties:
vnfInstanceId:
description: >
Identifier of the existing VNF instance to be used in the NS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
moscatelli
committed
vnfProfileId:
description: >
Identifier of (Reference to) a vnfProfile defined in the
NSD which the existing VNF instance shall be matched
with. If not present, the NFVO will select the VnfProfile
matching the information in the VNF instance.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
NestedNsInstanceData:
description: >
This type specifies an existing nested NS instance to be used in the NS instance
and if needed, the NsProfile to use for this nested NS instance.
It shall comply with the provisions defined in Table 6.5.3.19a-1.
type: object
required:
- nestedNsInstanceId
properties:
description: >
Identifier of the existing nested NS instance to be used in the NS.
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsProfileId:
description: >
Identifier of an NsProfile defined in the NSD which the existing
nested NS instance shall be matched with.
If not present, the NFVO will select the NsProfile matching the
information in the nested NS instance.
$ref: "#/definitions/IdentifierInNs"
moscatelli
committed
description: >
This type represents the information related to a SAP of a NS.
It shall comply with the provisions defined in Table 6.5.3.10-1.
type: object
required:
- sapdId
- sapName
- description
properties:
sapdId:
description: >
Reference to the SAPD for this SAP.
$ref: "#/definitions/IdentifierInNsd"
moscatelli
committed
sapName:
description: >
Human readable name for the SAP.
type: string
description:
description: >
Human readable description for the SAP.
type: string
sapProtocolData:
description: >
Parameters for configuring the network protocols on the SAP.
type: array
moscatelli
committed
items:
$ref: "#/definitions/CpProtocolData"
rameshnaraya
committed
description: >
moscatelli
committed
This type represents a request for the scale NS operation.
type: object
required:
moscatelli
committed
- scaleType
moscatelli
committed
scaleType:
moscatelli
committed
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
Indicates the type of scaling to be performed.
Possible values:
- SCALE_NS
- SCALE_VNF
type: string
enum:
- SCALE_NS
- SCALE_VNF
scaleNsData:
description: >
The necessary information to scale the referenced NS instance.
It shall be present when scaleType = SCALE_NS.
$ref: "#/definitions/ScaleNsData"
scaleVnfData:
description: >
The necessary information to scale the referenced NS instance.
It shall be present when scaleType = SCALE_VNF.
type: array
items:
$ref: "#/definitions/ScaleVnfData"
scaleTime:
description: >
Timestamp indicating the scale time of the NS, i.e. the
NS will be scaled at this timestamp. Cardinality "0"
indicates the NS scaling takes place immediately".
Samir Medjiah
committed
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
moscatelli
committed
UpdateNsRequest:
description: >
This operation supports the update of a NS instance,
It shall comply with the provisions defined in Table 6.5.2.12-1.
type: object
required:
- updateType
properties:
updateType:
description: >
The type of update. It determines also which one of the
following parameters is present in the operation.
Possible values include:
* ADD_VNF: Adding existing VNF instance(s)
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
* REMOVE_VNF: Removing VNF instance(s)
* INSTANTIATE_VNF: Instantiating new VNF(s)
* CHANGE_VNF_DF: Changing VNF DF
* OPERATE_VNF: Changing VNF state,
* MODIFY_VNF_INFORMATION: Modifying
VNF information and/or the configurable
properties of VNF instance(s)
* CHANGE_EXTERNAL_VNF_CONNECTIVITY:
Changing the external connectivity of VNF
instance(s)ADD_SAP: Adding SAP(s)
* REMOVE_SAP: Removing SAP(s)
* ADD_NESTED_NS: Adding existing NS
instance(s) as nested NS(s)
* REMOVE_NESTED_NS: Removing existing
nested NS instance(s)
* ASSOC_NEW_NSD_VERSION: Associating a
new NSD version to the NS instance
* MOVE_VNF: Moving VNF instance(s) from one
origin NS instance to another target NS
instance
* ADD_VNFFG: Adding VNFFG(s)
* REMOVE_VNFFG: Removing VNFFG(s)
* UPDATE_VNFFG: Updating VNFFG(s)
* CHANGE_NS_DF: Changing NS DF
* ADD_PNF: Adding PNF
* MODIFY_PNF: Modifying PNF
* REMOVE_PNF: Removing PNF