rw-project - User documentation
Schema Globals
| Global Schema Type | rw_ypbc_ProjectVnfd_RwProject_t_schema |
| Global Schema Pointer | rw_ypbc_ProjectVnfd_RwProject_g_schema |
rw-project data
This yang module defines project-based tenancy for RIFT.ware. Authorization for project access is defined in terms of RIFT.ware's Role-Based Access Control (RBAC) model.
rw-project:project
Configuration and state for individual projects. RIFT.ware applications and projects are expected to augment this list in order to add configuration for projects that is specific to the product or application. As such, this list contains minimal data defined in this yang module. When augmenting this element, other yang modules should prefer to define containers with the same name as the augmenting module. (Augmenting RIFT.ware modules should prefer to augment without the rw prefix [for new features], or should prefer to augment the augmented container of an existing augment, to ease future adoption and/or standardization.)
Key Identifiers:| XPath Path | /rw-project:project |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the project. |
| description | STRING | Information about project |
| project-config | CONTAINER | General Project configuration supported by all products. |
| project-state | CONTAINER | General Project operational state supported by all products. |
| vnfd-catalog | CONTAINER | Virtual Network Function Descriptor (VNFD). |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-project:project-config
General Project configuration supported by all products.
Key Identifiers:| XPath Path | /rw-project:project/rw-project:project-config |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-config |
| RW.REST URI Path | /rw-project:project/STRING/project-config |
Fields
| Name | Type | Description |
|---|---|---|
| user | LIST | The list of Users who have been assigned Roles within this Project. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-project:user
The list of Users who have been assigned Roles within this Project.
Key Identifiers:| XPath Path | /rw-project:project/rw-project:project-config/rw-project:user |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-config/user/STRING,STRING |
Fields
| Name | Type | Description |
|---|---|---|
| user-domain | LEAFREF | The user domain. This is the source of the user identity. Different domains may duplicate a user-name, but such users would be considered distinct by RIFT.ware. |
| user-name | LEAFREF | The user name. The syntax of this name depends on the domain. For example, if the domain is a login name, it might be limited to alphanumeric characters. However, if the domain is email address, the syntax could include additional characters, such as the at(@) sign. |
| role | LIST | The list of Roles the User has been assigned. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-project:role
The list of Roles the User has been assigned.
Key Identifiers:| XPath Path | /rw-project:project/rw-project:project-config/rw-project:user/rw-project:role |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-config/user/STRING,STRING/role/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| role | STRING | The Role, independent of Keys. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
rw-project:project-state
General Project operational state supported by all products.
Key Identifiers:| XPath Path | /rw-project:project/rw-project:project-state |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-state |
| RW.REST URI Path | /rw-project:project/STRING/project-state |
Fields
| Name | Type | Description |
|---|---|---|
| user | LIST | The state of Users who have been assigned Roles within this Project. |
| role | LIST | The set of Roles that may be configured into /rw-project:project/rw-project:config/rw-project:user/ rw-project:role. |
JSON Sample
XML Sample
rw-project:user
The state of Users who have been assigned Roles within this Project.
Key Identifiers:| XPath Path | /rw-project:project/rw-project:project-state/rw-project:user |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-state/user/STRING,STRING |
Fields
| Name | Type | Description |
|---|---|---|
| user-domain | STRING | The user domain. This is the source of the user identity. Different domains may duplicate a user-name, but such users would be considered distinct by RIFT.ware. |
| user-name | STRING | The user name. The syntax of this name depends on the domain. For example, if the domain is a login name, it might be limited to alphanumeric characters. However, if the domain is some kind of email address, the syntax could include assitional characters, such as the at sign. |
| role | LIST | The state of the Roles the User has been assigned. |
JSON Sample
XML Sample
rw-project:role
The state of the Roles the User has been assigned.
Key Identifiers:| XPath Path | /rw-project:project/rw-project:project-state/rw-project:user/rw-project:role |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-state/user/STRING,STRING/role/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| role | STRING | The Role, independent of Keys. |
| state | STRING | The assignment of a User to a Role may be an asynchronous operation. This value indicates whether the Role assignment is active. If the value is 'active', then the assignment is complete and active. Any other value indicates that Role assignment is in a transitional or failed state, as described in the value. |
JSON Sample
XML Sample
rw-project:role
The set of Roles that may be configured into /rw-project:project/rw-project:config/rw-project:user/ rw-project:role.
Key Identifiers:| XPath Path | /rw-project:project/rw-project:project-state/rw-project:role |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:role[rw-project:role='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-state/role/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| role | STRING | The Role, independent of Keys. |
| description | STRING | A description of the Role. |
JSON Sample
XML Sample
project-vnfd:vnfd-catalog
Virtual Network Function Descriptor (VNFD).
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog |
Fields
| Name | Type | Description |
|---|---|---|
| vnfd | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vnfd
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the VNFD. |
| name | STRING | VNFD name. |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Vendor of the VNFD. |
| logo | STRING | Vendor logo for the Virtual Network Function |
| description | STRING | Description of the VNFD. |
| version | STRING | Version of the VNFD |
| vnf-configuration | CONTAINER | |
| operational-status | ENUM | The operational status of the VNF init : The VNF has just started. running : The VNF is active in VM upgrading : The VNF is being upgraded (EXPERIMENTAL) terminate : The VNF is being terminated terminated : The VNF is in the terminated state. failed : The VNF instantiation failed. |
| mgmt-interface | CONTAINER | Interface over which the VNF is managed. |
| internal-vld | LIST | List of Internal Virtual Link Descriptors (VLD). The internal VLD describes the basic topology of the connectivity such as E-LAN, E-Line, E-Tree. between internal VNF components of the system. |
| ip-profiles | LIST | List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link |
| connection-point | LIST | List for external connection points. Each VNF has one or more external connection points that connect the VNF to other VNFs or to external networks. Each VNF exposes connection points to the orchestrator, which can construct network services by connecting the connection points between different VNFs. The NFVO will use VLDs and VNFFGs at the network service level to construct network services. |
| vdu | LIST | List of Virtual Deployment Units |
| vdu-dependency | LIST | List of VDU dependencies. |
| service-function-chain | ENUM | Type of node in Service Function Chaining Architecture |
| service-function-type | STRING | Type of Service Function. NOTE: This needs to map with Service Function Type in ODL to support VNFFG. Service Function Type is mandatory param in ODL SFC. This is temporarily set to string for ease of use |
| http-endpoint | LIST | List of http endpoints to be used by monitoring params |
| monitoring-param | LIST | List of monitoring parameters at the network service level |
| placement-groups | LIST | List of placement groups at VNF level |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vnf-configuration
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration |
Fields
| Name | Type | Description |
|---|---|---|
| script | CONTAINER | |
| juju | CONTAINER | |
| config-primitive | LIST | List of config primitives supported by the configuration agent for this VNF or VDU. |
| initial-config-primitive | LIST | Initial set of configuration primitives. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:script
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:script |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:script |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/script |
Fields
| Name | Type | Description |
|---|---|---|
| script-type | ENUM | Script type - currently supported - Scripts confirming to Rift CA plugin |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:juju
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:juju |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:juju |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/juju |
Fields
| Name | Type | Description |
|---|---|---|
| charm | STRING | Juju charm to use with the VNF or VDU. |
| proxy | BOOLEAN | Is this a proxy charm? |
| vca-relationships | CONTAINER |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vca-relationships
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:juju/project-vnfd:vca-relationships |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:juju/project-vnfd:vca-relationships |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/juju/vca-relationships |
Fields
| Name | Type | Description |
|---|---|---|
| relation | LIST | List of relations between VCA componets. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:relation
List of relations between VCA componets.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:juju/project-vnfd:vca-relationships/project-vnfd:relation |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:juju/project-vnfd:vca-relationships/project-vnfd:relation[project-vnfd:requires='STRING'][project-vnfd:provides='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/juju/vca-relationships/relation/STRING,STRING |
Fields
| Name | Type | Description |
|---|---|---|
| requires | STRING | Name of the required relation. |
| provides | STRING | Name of the provided relation. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:config-primitive
List of config primitives supported by the configuration agent for this VNF or VDU.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:config-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:config-primitive[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/config-primitive/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the config primitive. |
| parameter | LIST | List of parameters to the config primitive. |
| user-defined-script | STRING | A user defined script. If user defined script is defined, the script will be executed using bash |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:parameter
List of parameters to the config primitive.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:config-primitive/project-vnfd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:config-primitive[project-vnfd:name='STRING']/project-vnfd:parameter[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/config-primitive/STRING/parameter/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| data-type | ENUM | Data type associated with the name. |
| mandatory | BOOLEAN | Is this field mandatory |
| default-value | STRING | The default value for this field |
| parameter-pool | STRING | NSD parameter pool name to use for this parameter |
| read-only | BOOLEAN | The value should be dimmed by the UI. Only applies to parameters with default values. |
| hidden | BOOLEAN | The value should be hidden by the UI. Only applies to parameters with default values. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:initial-config-primitive
Initial set of configuration primitives.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive[project-vnfd:seq='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/initial-config-primitive/0 |
Fields
| Name | Type | Description |
|---|---|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| parameter | LIST | List of parameters to the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:parameter
List of parameters to the configuration primitive.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive/project-vnfd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vnf-configuration/project-vnfd:initial-config-primitive[project-vnfd:seq='0']/project-vnfd:parameter[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vnf-configuration/initial-config-primitive/0/parameter/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| value | STRING | Value associated with the name. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:mgmt-interface
Interface over which the VNF is managed.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:mgmt-interface |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:mgmt-interface |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/mgmt-interface |
Fields
| Name | Type | Description |
|---|---|---|
| ip-address | UNION | |
| vdu-id | LEAFREF | |
| cp | LEAFREF | |
| port | UINT16 | Port for the management interface. |
| dashboard-params | CONTAINER | Parameters for the VNF dashboard |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:dashboard-params
Parameters for the VNF dashboard
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:mgmt-interface/project-vnfd:dashboard-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:mgmt-interface/project-vnfd:dashboard-params |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/mgmt-interface/dashboard-params |
Fields
| Name | Type | Description |
|---|---|---|
| path | STRING | The HTTP path for the dashboard |
| https | BOOLEAN | Pick HTTPS instead of HTTP , Default is false |
| port | UINT16 | The HTTP port for the dashboard |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:internal-vld
List of Internal Virtual Link Descriptors (VLD). The internal VLD describes the basic topology of the connectivity such as E-LAN, E-Line, E-Tree. between internal VNF components of the system.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the VLD |
| name | STRING | Name of the internal VLD |
| short-name | STRING | Short name to appear as label in the UI |
| description | STRING | |
| type | ENUM | |
| root-bandwidth | UINT64 | For ELAN this is the aggregate bandwidth. |
| leaf-bandwidth | UINT64 | For ELAN this is the bandwidth of branches. |
| internal-connection-point | LIST | List of internal connection points in this VLD |
| provider-network | CONTAINER | Container for the provider network. |
| vim-network-name | STRING | Name of network in VIM account. This is used to indicate pre-provisioned network name in cloud account. |
| ip-profile-ref | STRING | Named reference to IP-profile object |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:internal-connection-point
List of internal connection points in this VLD
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/project-vnfd:internal-connection-point |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/project-vnfd:internal-connection-point[project-vnfd:id-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING/internal-connection-point/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| id-ref | LEAFREF | reference to the internal connection point id |
| ip-address | UNION | IP address of the internal connection point |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:provider-network
Container for the provider network.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:internal-vld/project-vnfd:provider-network |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:internal-vld[project-vnfd:id='STRING']/project-vnfd:provider-network |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/internal-vld/STRING/provider-network |
Fields
| Name | Type | Description |
|---|---|---|
| physical-network | STRING | Name of the physical network on which the provider network is built. |
| segmentation_id | UINT32 | ID of segregated virtual networks |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:ip-profiles
List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the IP-Profile |
| description | STRING | Description for IP profile |
| ip-profile-params | CONTAINER |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:ip-profile-params
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params |
Fields
| Name | Type | Description |
|---|---|---|
| ip-version | ENUM | |
| subnet-address | UNION | Subnet IP prefix associated with IP Profile |
| gateway-address | UNION | IP Address of the default gateway associated with IP Profile |
| security-group | STRING | Name of the security group |
| dns-server | LIST | |
| dhcp-params | CONTAINER | |
| subnet-prefix-pool | STRING | VIM Specific reference to pre-created subnet prefix |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:dns-server
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params/project-vnfd:dns-server |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params/project-vnfd:dns-server[project-vnfd:address='UNION_VALUE'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params/dns-server/UNION_VALUE |
Fields
| Name | Type | Description |
|---|---|---|
| address | UNION | List of DNS Servers associated with IP Profile |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:dhcp-params
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:ip-profiles/project-vnfd:ip-profile-params/project-vnfd:dhcp-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:ip-profiles[project-vnfd:name='STRING']/project-vnfd:ip-profile-params/project-vnfd:dhcp-params |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/ip-profiles/STRING/ip-profile-params/dhcp-params |
Fields
| Name | Type | Description |
|---|---|---|
| enabled | BOOLEAN | This flag indicates if DHCP is enabled or not |
| start-address | UNION | Start IP address of the IP-Address range associated with DHCP domain |
| count | UINT32 | Size of the DHCP pool associated with DHCP domain |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:connection-point
List for external connection points. Each VNF has one or more external connection points that connect the VNF to other VNFs or to external networks. Each VNF exposes connection points to the orchestrator, which can construct network services by connecting the connection points between different VNFs. The NFVO will use VLDs and VNFFGs at the network service level to construct network services.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:connection-point |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:connection-point[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/connection-point/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the connection point |
| id | STRING | Identifier for the internal connection points |
| short-name | STRING | Short name to appear as label in the UI |
| type | ENUM | Type of the connection point. |
| port-security-enabled | BOOLEAN | Enables the port security for the port |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vdu
List of Virtual Deployment Units
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Unique id for the VDU |
| name | STRING | Unique name for the VDU |
| description | STRING | Description of the VDU. |
| count | UINT64 | Number of instances of VDU |
| mgmt-vpci | STRING | Specifies the virtual PCI address. Expressed in the following format dddd:dd:dd.d. For example 0000:00:12.0. This information can be used to pass as metadata during the VM creation. |
| vm-flavor | CONTAINER | |
| guest-epa | CONTAINER | |
| vswitch-epa | CONTAINER | |
| hypervisor-epa | CONTAINER | |
| host-epa | CONTAINER | Specifies the host level EPA attributes. |
| alarm | LIST | |
| image | STRING | Image name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here. |
| image-checksum | STRING | Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL. |
| alternative-images | LIST | List of alternative images per VIM type. Different images can be used for specific types of VIMs instead of the default image. This allows deployments in sites where the image identifier in the VIM is given by the VIM provider and cannot be modified. If an alternative image is specified for a VIM type, it will prevail over the default image |
| vdu-configuration | CONTAINER | |
| cloud-init | STRING | Contents of cloud-init script, provided inline, in cloud-config format |
| cloud-init-file | STRING | Name of file with contents of cloud-init script in cloud-config format |
| supplemental-boot-data | CONTAINER | |
| internal-connection-point | LIST | List for internal connection points. Each VNFC has zero or more internal connection points. Internal connection points are used for connecting the VNF with components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points. |
| interface | LIST | List of Interfaces (external and internal) for the VNF |
| volumes | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vm-flavor
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vm-flavor |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vm-flavor |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vm-flavor |
Fields
| Name | Type | Description |
|---|---|---|
| vcpu-count | UINT16 | Number of VCPUs for the VM. |
| memory-mb | UINT64 | Amount of memory in MB. |
| storage-gb | UINT64 | Amount of disk space in GB. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:guest-epa
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa |
Fields
| Name | Type | Description |
|---|---|---|
| trusted-execution | BOOLEAN | This VM should be allocated from trusted pool |
| mempage-size | ENUM | Memory page allocation size. If a VM requires hugepages, it should choose LARGE or SIZE_2MB or SIZE_1GB. If the VM prefers hugepages it should choose PREFER_LARGE. LARGE : Require hugepages (either 2MB or 1GB) SMALL : Doesn't require hugepages SIZE_2MB : Requires 2MB hugepages SIZE_1GB : Requires 1GB hugepages PREFER_LARGE : Application prefers hugepages |
| cpu-pinning-policy | ENUM | CPU pinning policy describes association between virtual CPUs in guest and the physical CPUs in the host. DEDICATED : Virtual CPUs are pinned to physical CPUs SHARED : Multiple VMs may share the same physical CPUs. ANY : Any policy is acceptable for the VM |
| cpu-thread-pinning-policy | ENUM | CPU thread pinning policy describes how to place the guest CPUs when the host supports hyper threads: AVOID : Avoids placing a guest on a host with threads. SEPARATE: Places vCPUs on separate cores, and avoids placing two vCPUs on two threads of same core. ISOLATE : Places each vCPU on a different core, and places no vCPUs from a different guest on the same core. PREFER : Attempts to place vCPUs on threads of the same core. |
| pcie-device | LIST | List of pcie passthrough devices. |
| numa-unaware | EMPTY | |
| numa-node-policy | CONTAINER | This policy defines NUMA topology of the guest. Specifically identifies if the guest should be run on a host with one NUMA node or multiple NUMA nodes. As an example a guest might need 8 VCPUs and 4 GB of memory. However, it might need the VCPUs and memory distributed across multiple NUMA nodes. In this scenario, NUMA node 1 could run with 6 VCPUs and 3GB, and NUMA node 2 could run with 2 VCPUs and 1GB. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:pcie-device
List of pcie passthrough devices.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:pcie-device |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:pcie-device[project-vnfd:device-id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/pcie-device/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| device-id | STRING | Device identifier. |
| count | UINT64 | Number of devices to attach to the VM. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:numa-node-policy
This policy defines NUMA topology of the guest. Specifically identifies if the guest should be run on a host with one NUMA node or multiple NUMA nodes. As an example a guest might need 8 VCPUs and 4 GB of memory. However, it might need the VCPUs and memory distributed across multiple NUMA nodes. In this scenario, NUMA node 1 could run with 6 VCPUs and 3GB, and NUMA node 2 could run with 2 VCPUs and 1GB.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy |
Fields
| Name | Type | Description |
|---|---|---|
| node-cnt | UINT16 | The number of NUMA nodes to expose to the VM. |
| mem-policy | ENUM | This policy specifies how the memory should be allocated in a multi-node scenario. STRICT : The memory must be allocated strictly from the memory attached to the NUMA node. PREFERRED : The memory should be allocated preferentially from the memory attached to the NUMA node |
| node | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:node
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0 |
Fields
| Name | Type | Description |
|---|---|---|
| id | UINT64 | NUMA node identification. Typically it's 0 or 1 |
| vcpu | LIST | List of VCPUs to allocate on this NUMA node. |
| memory-mb | UINT64 | Memory size expressed in MB for this NUMA node. |
| num-cores | UINT8 | |
| paired-threads | CONTAINER | |
| num-threads | UINT8 |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vcpu
List of VCPUs to allocate on this NUMA node.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:vcpu |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:vcpu[project-vnfd:id='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/vcpu/0 |
Fields
| Name | Type | Description |
|---|---|---|
| id | UINT64 | List of VCPUs ids to allocate on this NUMA node |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:paired-threads
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:paired-threads |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:paired-threads |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads |
Fields
| Name | Type | Description |
|---|---|---|
| num-paired-threads | UINT8 | |
| paired-thread-ids | LIST | List of thread pairs to use in case of paired-thread NUMA |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:paired-thread-ids
List of thread pairs to use in case of paired-thread NUMA
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node/project-vnfd:paired-threads/project-vnfd:paired-thread-ids |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:guest-epa/project-vnfd:numa-node-policy/project-vnfd:node[project-vnfd:id='0']/project-vnfd:paired-threads/project-vnfd:paired-thread-ids[project-vnfd:thread-a='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads/paired-thread-ids/0 |
Fields
| Name | Type | Description |
|---|---|---|
| thread-a | UINT8 | |
| thread-b | UINT8 |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vswitch-epa
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vswitch-epa |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vswitch-epa |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vswitch-epa |
Fields
| Name | Type | Description |
|---|---|---|
| ovs-acceleration | ENUM | Specifies Open vSwitch acceleration mode. MANDATORY: OVS acceleration is required PREFERRED: OVS acceleration is preferred |
| ovs-offload | ENUM | Specifies Open vSwitch hardware offload mode. MANDATORY: OVS offload is required PREFERRED: OVS offload is preferred |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:hypervisor-epa
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:hypervisor-epa |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:hypervisor-epa |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/hypervisor-epa |
Fields
| Name | Type | Description |
|---|---|---|
| type | ENUM | Specifies the type of hypervisor. KVM: KVM XEN: XEN |
| version | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:host-epa
Specifies the host level EPA attributes.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa |
Fields
| Name | Type | Description |
|---|---|---|
| cpu-model | ENUM | Host CPU model. Examples include: SandyBridge, IvyBridge |
| cpu-arch | ENUM | Host CPU architecture. |
| cpu-vendor | ENUM | Host CPU Vendor. |
| cpu-socket-count | UINT64 | Number of sockets on the host. |
| cpu-core-count | UINT64 | Number of cores on the host. |
| cpu-core-thread-count | UINT64 | Number of threads per cores on the host. |
| cpu-feature | LIST | List of CPU features. |
| om-cpu-model-string | STRING | OpenMANO CPU model string |
| om-cpu-feature | LIST | List of OpenMANO CPU features |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:cpu-feature
List of CPU features.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa/project-vnfd:cpu-feature |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa/project-vnfd:cpu-feature[project-vnfd:feature='PREFER_AES'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa/cpu-feature/PREFER_AES |
Fields
| Name | Type | Description |
|---|---|---|
| feature | ENUM | CPU feature. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:om-cpu-feature
List of OpenMANO CPU features
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:host-epa/project-vnfd:om-cpu-feature |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:host-epa/project-vnfd:om-cpu-feature[project-vnfd:feature='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/host-epa/om-cpu-feature/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| feature | STRING | CPU feature |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:alarm
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:alarm |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:alarm[project-vnfd:alarm-id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| alarm-id | STRING | This field is reserved for the identifier assigned by the VIM provider |
| name | STRING | A human readable string to identify the alarm |
| description | STRING | A description of this alarm |
| vdur-id | STRING | The identifier of the VDUR that the alarm is associated with |
| actions | CONTAINER | |
| repeat | BOOLEAN | This flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed. |
| enabled | BOOLEAN | This flag indicates whether the alarm has been enabled or disabled. |
| severity | ENUM | A measure of the importance or urgency of the alarm |
| metric | ENUM | The metric to be tracked by this alarm. |
| statistic | ENUM | The type of metric statistic that is tracked by this alarm |
| operation | ENUM | The relational operator used to define whether an alarm should be triggered in certain scenarios, such as if the metric statistic goes above or below a specified value. |
| value | DECIMAL64 | This value defines the threshold that, if crossed, will trigger the alarm. |
| period | UINT32 | The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic. |
| evaluations | UINT32 | Defines the length of time (seconds) in which metric data are collected in order to evaluate the chosen statistic. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:actions
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:alarm/project-vnfd:actions |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:alarm[project-vnfd:alarm-id='STRING']/project-vnfd:actions |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING/actions |
Fields
| Name | Type | Description |
|---|---|---|
| ok | LIST | |
| insufficient-data | LIST | |
| alarm | LIST |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:ok
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:alarm/project-vnfd:actions/project-vnfd:ok |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:alarm[project-vnfd:alarm-id='STRING']/project-vnfd:actions/project-vnfd:ok[project-vnfd:url='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING/actions/ok/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:insufficient-data
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:alarm/project-vnfd:actions/project-vnfd:insufficient-data |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:alarm[project-vnfd:alarm-id='STRING']/project-vnfd:actions/project-vnfd:insufficient-data[project-vnfd:url='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING/actions/insufficient-data/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:alarm
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:alarm/project-vnfd:actions/project-vnfd:alarm |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:alarm[project-vnfd:alarm-id='STRING']/project-vnfd:actions/project-vnfd:alarm[project-vnfd:url='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alarm/STRING/actions/alarm/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| url | STRING |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:alternative-images
List of alternative images per VIM type. Different images can be used for specific types of VIMs instead of the default image. This allows deployments in sites where the image identifier in the VIM is given by the VIM provider and cannot be modified. If an alternative image is specified for a VIM type, it will prevail over the default image
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:alternative-images |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:alternative-images[project-vnfd:vim-type='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/alternative-images/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| vim-type | STRING | VIM type: openvim, openstack, vmware, aws, etc. |
| image | STRING | Image name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here. |
| image-checksum | STRING | Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vdu-configuration
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration |
Fields
| Name | Type | Description |
|---|---|---|
| script | CONTAINER | |
| juju | CONTAINER | |
| config-primitive | LIST | List of config primitives supported by the configuration agent for this VNF or VDU. |
| initial-config-primitive | LIST | Initial set of configuration primitives. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:script
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration/project-vnfd:script |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration/project-vnfd:script |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/script |
Fields
| Name | Type | Description |
|---|---|---|
| script-type | ENUM | Script type - currently supported - Scripts confirming to Rift CA plugin |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:juju
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration/project-vnfd:juju |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration/project-vnfd:juju |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/juju |
Fields
| Name | Type | Description |
|---|---|---|
| charm | STRING | Juju charm to use with the VNF or VDU. |
| proxy | BOOLEAN | Is this a proxy charm? |
| vca-relationships | CONTAINER |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vca-relationships
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration/project-vnfd:juju/project-vnfd:vca-relationships |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration/project-vnfd:juju/project-vnfd:vca-relationships |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/juju/vca-relationships |
Fields
| Name | Type | Description |
|---|---|---|
| relation | LIST | List of relations between VCA componets. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:relation
List of relations between VCA componets.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration/project-vnfd:juju/project-vnfd:vca-relationships/project-vnfd:relation |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration/project-vnfd:juju/project-vnfd:vca-relationships/project-vnfd:relation[project-vnfd:requires='STRING'][project-vnfd:provides='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/juju/vca-relationships/relation/STRING,STRING |
Fields
| Name | Type | Description |
|---|---|---|
| requires | STRING | Name of the required relation. |
| provides | STRING | Name of the provided relation. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:config-primitive
List of config primitives supported by the configuration agent for this VNF or VDU.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration/project-vnfd:config-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration/project-vnfd:config-primitive[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/config-primitive/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the config primitive. |
| parameter | LIST | List of parameters to the config primitive. |
| user-defined-script | STRING | A user defined script. If user defined script is defined, the script will be executed using bash |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:parameter
List of parameters to the config primitive.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration/project-vnfd:config-primitive/project-vnfd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration/project-vnfd:config-primitive[project-vnfd:name='STRING']/project-vnfd:parameter[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/config-primitive/STRING/parameter/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| data-type | ENUM | Data type associated with the name. |
| mandatory | BOOLEAN | Is this field mandatory |
| default-value | STRING | The default value for this field |
| parameter-pool | STRING | NSD parameter pool name to use for this parameter |
| read-only | BOOLEAN | The value should be dimmed by the UI. Only applies to parameters with default values. |
| hidden | BOOLEAN | The value should be hidden by the UI. Only applies to parameters with default values. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:initial-config-primitive
Initial set of configuration primitives.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration/project-vnfd:initial-config-primitive |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration/project-vnfd:initial-config-primitive[project-vnfd:seq='0'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/initial-config-primitive/0 |
Fields
| Name | Type | Description |
|---|---|---|
| seq | UINT64 | Sequence number for the configuration primitive. |
| name | STRING | Name of the configuration primitive. |
| parameter | LIST | List of parameters to the configuration primitive. |
| user-defined-script | STRING | A user defined script. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:parameter
List of parameters to the configuration primitive.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:vdu-configuration/project-vnfd:initial-config-primitive/project-vnfd:parameter |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:vdu-configuration/project-vnfd:initial-config-primitive[project-vnfd:seq='0']/project-vnfd:parameter[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/vdu-configuration/initial-config-primitive/0/parameter/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the parameter. |
| value | STRING | Value associated with the name. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:supplemental-boot-data
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:supplemental-boot-data |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:supplemental-boot-data |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/supplemental-boot-data |
Fields
| Name | Type | Description |
|---|---|---|
| config-file | LIST | List of configuration files to be written on an additional drive |
| boot-data-drive | BOOLEAN | Some VIMs implement additional drives to host config-files or meta-data |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:config-file
List of configuration files to be written on an additional drive
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:supplemental-boot-data/project-vnfd:config-file |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:supplemental-boot-data/project-vnfd:config-file[project-vnfd:source='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/supplemental-boot-data/config-file/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| source | STRING | Name of the configuration file |
| dest | STRING | Full path of the destination in the guest |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:internal-connection-point
List for internal connection points. Each VNFC has zero or more internal connection points. Internal connection points are used for connecting the VNF with components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:internal-connection-point |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:internal-connection-point[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/internal-connection-point/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the connection point |
| id | STRING | Identifier for the internal connection points |
| short-name | STRING | Short name to appear as label in the UI |
| type | ENUM | Type of the connection point. |
| port-security-enabled | BOOLEAN | Enables the port security for the port |
| internal-vld-ref | LEAFREF |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:interface
List of Interfaces (external and internal) for the VNF
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:interface |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:interface[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/interface/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the interface. Note that this name has only local significance to the VDU. |
| position | UINT32 | Explicit Position of the interface within the list |
| type | ENUM | Type of the Interface |
| mac-address | STRING | MAC address of the interface. Some VNFs require a specific MAC address to be configured in the interface. While this is not recommended at all in NFV environments, this parameter exists to allow those scenarios. This parameter will be likely deprecated in the future. |
| internal-connection-point-ref | LEAFREF | Leaf Ref to the particular internal connection point |
| external-connection-point-ref | LEAFREF | Leaf Ref to the particular external connection point |
| virtual-interface | CONTAINER | Container for the virtual interface properties |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:virtual-interface
Container for the virtual interface properties
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:interface/project-vnfd:virtual-interface |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:interface[project-vnfd:name='STRING']/project-vnfd:virtual-interface |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/interface/STRING/virtual-interface |
Fields
| Name | Type | Description |
|---|---|---|
| type | ENUM | Specifies the type of virtual interface between VM and host. VIRTIO : Use the traditional VIRTIO interface. PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface. SR-IOV : Use SR-IOV interface. E1000 : Emulate E1000 interface. RTL8139 : Emulate RTL8139 interface. PCNET : Emulate PCNET interface. OM-MGMT : Deprecated! Use VIRTIO instead and set the VNF management interface at vnfd:mgmt-interface:cp |
| vpci | STRING | Specifies the virtual PCI address. Expressed in the following format dddd:dd:dd.d. For example 0000:00:12.0. This information can be used to pass as metadata during the VM creation. |
| bandwidth | UINT64 | Aggregate bandwidth of the NIC. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:volumes
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu/project-vnfd:volumes |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu[project-vnfd:id='STRING']/project-vnfd:volumes[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu/STRING/volumes/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Name of the disk-volumes, e.g. vda, vdb etc |
| description | STRING | Description for Volume |
| size | UINT64 | Size of disk in GB |
| ephemeral | EMPTY | |
| image | STRING | Image name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here. |
| image-checksum | STRING | Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL. |
| device-bus | ENUM | Type of disk-bus on which this disk is exposed to guest |
| device-type | ENUM | The type of device as exposed to guest |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:vdu-dependency
List of VDU dependencies.
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:vdu-dependency |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:vdu-dependency[project-vnfd:vdu-source-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/vdu-dependency/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| vdu-source-ref | LEAFREF | |
| vdu-depends-on-ref | LEAFREF | Reference to the VDU on which the source VDU depends. |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:http-endpoint
List of http endpoints to be used by monitoring params
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:http-endpoint |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:http-endpoint[project-vnfd:path='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/http-endpoint/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| path | STRING | The HTTP path on the management server |
| https | BOOLEAN | Pick HTTPS instead of HTTP , Default is false |
| port | UINT16 | The HTTP port to connect to |
| username | STRING | The HTTP basic auth username |
| password | STRING | The HTTP basic auth password |
| polling-interval-secs | UINT8 | The HTTP polling interval in seconds |
| method | ENUM | Method that the URI should perform. Deafult action is GET. |
| headers | LIST | Custom HTTP headers to put on HTTP request |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:headers
Custom HTTP headers to put on HTTP request
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:http-endpoint/project-vnfd:headers |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:http-endpoint[project-vnfd:path='STRING']/project-vnfd:headers[project-vnfd:key='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/http-endpoint/STRING/headers/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| key | STRING | HTTP header key |
| value | STRING | HTTP header value |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:monitoring-param
List of monitoring parameters at the network service level
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | |
| name | STRING | |
| http-endpoint-ref | LEAFREF | |
| json-query-method | ENUM | |
| json-query-params | CONTAINER | |
| description | STRING | |
| group-tag | STRING | A tag to group monitoring parameters |
| widget-type | ENUM | Defines the UI Display variant of measured counters. |
| units | STRING | Measured Counter Units (e.g., Packets, Kbps, Mbps, etc.) |
| value-type | ENUM | |
| numeric-constraints | CONTAINER | |
| text-constraints | CONTAINER | |
| value-integer | INT64 | Current value for an integer parameter |
| value-decimal | DECIMAL64 | Current value for a decimal parameter |
| value-string | STRING | Current value for a string parameter |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:json-query-params
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:json-query-params |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:json-query-params |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/json-query-params |
Fields
| Name | Type | Description |
|---|---|---|
| json-path | STRING | The jsonpath to use to extract value from JSON structure |
| object-path | STRING | The objectpath to use to extract value from JSON structure |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:numeric-constraints
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:numeric-constraints |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:numeric-constraints |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/numeric-constraints |
Fields
| Name | Type | Description |
|---|---|---|
| min-value | UINT64 | Minimum value for the parameter |
| max-value | UINT64 | Maximum value for the parameter |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:text-constraints
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:monitoring-param/project-vnfd:text-constraints |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:monitoring-param[project-vnfd:id='STRING']/project-vnfd:text-constraints |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/monitoring-param/STRING/text-constraints |
Fields
| Name | Type | Description |
|---|---|---|
| min-length | UINT8 | Minimum string length for the parameter |
| max-length | UINT8 | Maximum string length for the parameter |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:placement-groups
List of placement groups at VNF level
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:placement-groups |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:placement-groups[project-vnfd:name='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/placement-groups/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| name | STRING | Place group construct to define the compute resource placement strategy in cloud environment |
| requirement | STRING | This is free text space used to describe the intent/rationale behind this placement group. This is for human consumption only |
| strategy | ENUM | Strategy associated with this placement group Following values are possible - COLOCATION: Colocation strategy imply intent to share the physical infrastructure (hypervisor/network) among all members of this group. - ISOLATION: Isolation strategy imply intent to not share the physical infrastructure (hypervisor/network) among the members of this group. |
| member-vdus | LIST | List of VDUs that are part of this placement group |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd:member-vdus
List of VDUs that are part of this placement group
Key Identifiers:| XPath Path | /rw-project:project/project-vnfd:vnfd-catalog/project-vnfd:vnfd/project-vnfd:placement-groups/project-vnfd:member-vdus |
| XPath Keyed Path | /rw-project:project[rw-project:name='STRING']/project-vnfd:vnfd-catalog/project-vnfd:vnfd[project-vnfd:id='STRING']/project-vnfd:placement-groups[project-vnfd:name='STRING']/project-vnfd:member-vdus[project-vnfd:member-vdu-ref='STRING'] |
| RW.REST URI Path | /rw-project:project/STRING/project-vnfd:vnfd-catalog/vnfd/STRING/placement-groups/STRING/member-vdus/STRING |
Fields
| Name | Type | Description |
|---|---|---|
| member-vdu-ref | LEAFREF |
JSON Config Sample
JSON Sample
XML Config Sample
XML Sample
project-vnfd - User documentation
Schema Globals
| Global Schema Type | rw_ypbc_ProjectVnfd_ProjectVnfd_t_schema |
| Global Schema Pointer | rw_ypbc_ProjectVnfd_ProjectVnfd_g_schema |