rw-project - User documentation

Schema Globals

Global Schema Type	rw_ypbc_Nsr_RwProject_t_schema
Global Schema Pointer	rw_ypbc_Nsr_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.
nsd-catalog	CONTAINER
vnfd-catalog	CONTAINER	Virtual Network Function Descriptor (VNFD).
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation
ns-instance-config	CONTAINER
vlr-catalog	CONTAINER
vnfr-catalog	CONTAINER
ns-instance-opdata	CONTAINER

JSON Config Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "project-config": {
      "user": [ { ... }, { ... } ]
    },
    "project-nsd:nsd-catalog": {
      "nsd": [ { ... }, { ... } ]
    },
    "project-vnfd:vnfd-catalog": {
      "vnfd": [ { ... }, { ... } ]
    },
    "nsr:key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ],
    "nsr:ns-instance-config": {
      "nsr": [ { ... }, { ... } ]
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "project-config": {
      "user": [ { ... }, { ... } ]
    },
    "project-state": {
      "user": [ { ... }, { ... } ],
      "role": [ { ... }, { ... } ]
    },
    "project-nsd:nsd-catalog": {
      "nsd": [ { ... }, { ... } ]
    },
    "project-vnfd:vnfd-catalog": {
      "vnfd": [ { ... }, { ... } ]
    },
    "nsr:key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ],
    "nsr:ns-instance-config": {
      "nsr": [ { ... }, { ... } ]
    },
    "vlr:vlr-catalog": {
      "schema-version": "v3.0",
      "vlr": [ { ... }, { ... } ]
    },
    "vnfr:vnfr-catalog": {
      "schema-version": "v3.0",
      "vnfr": [ { ... }, { ... } ]
    },
    "nsr:ns-instance-opdata": {
      "nsr": [ { ... }, { ... } ]
    }
  }, {
    ...
  }
]

XML Config Sample

<rw-project:project xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:name>STRING</rw-project:name>
  <rw-project:description>STRING</rw-project:description>
  <rw-project:project-config>
    <rw-project:user>...</rw-project:user>
  </rw-project:project-config>
  <project-nsd:nsd-catalog xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
    <project-nsd:nsd>...</project-nsd:nsd>
  </project-nsd:nsd-catalog>
  <project-vnfd:vnfd-catalog xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
    <project-vnfd:vnfd>...</project-vnfd:vnfd>
  </project-vnfd:vnfd-catalog>
  <nsr:key-pair xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
    <nsr:name>STRING</nsr:name>
    <nsr:key>STRING</nsr:key>
  </nsr:key-pair>
  <nsr:ns-instance-config xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
    <nsr:nsr>...</nsr:nsr>
  </nsr:ns-instance-config>
</rw-project:project>

XML Sample

<rw-project:project xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:name>STRING</rw-project:name>
  <rw-project:description>STRING</rw-project:description>
  <rw-project:project-config>
    <rw-project:user>...</rw-project:user>
  </rw-project:project-config>
  <rw-project:project-state>
    <rw-project:user>...</rw-project:user>
    <rw-project:role>...</rw-project:role>
  </rw-project:project-state>
  <project-nsd:nsd-catalog xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
    <project-nsd:nsd>...</project-nsd:nsd>
  </project-nsd:nsd-catalog>
  <project-vnfd:vnfd-catalog xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
    <project-vnfd:vnfd>...</project-vnfd:vnfd>
  </project-vnfd:vnfd-catalog>
  <nsr:key-pair xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
    <nsr:name>STRING</nsr:name>
    <nsr:key>STRING</nsr:key>
  </nsr:key-pair>
  <nsr:ns-instance-config xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
    <nsr:nsr>...</nsr:nsr>
  </nsr:ns-instance-config>
  <vlr:vlr-catalog xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
    <vlr:schema-version>v3.0</vlr:schema-version>
    <vlr:vlr>...</vlr:vlr>
  </vlr:vlr-catalog>
  <vnfr:vnfr-catalog xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
    <vnfr:schema-version>v3.0</vnfr:schema-version>
    <vnfr:vnfr>...</vnfr:vnfr>
  </vnfr:vnfr-catalog>
  <nsr:ns-instance-opdata xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
    <nsr:nsr>...</nsr:nsr>
  </nsr:ns-instance-opdata>
</rw-project:project>

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

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<rw-project:project-config xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
  </rw-project:user>
</rw-project:project-config>

XML Sample

<rw-project:project-config xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
  </rw-project:user>
</rw-project:project-config>

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

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
  </rw-project:role>
</rw-project:user>

XML Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
  </rw-project:role>
</rw-project:user>

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

[
  {
    "role": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "role": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
</rw-project:role>

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
</rw-project:role>

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

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "role": [
    {
      "role": "STRING",
      "description": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<rw-project:project-state xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
  </rw-project:user>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
    <rw-project:description>STRING</rw-project:description>
  </rw-project:role>
</rw-project:project-state>

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

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING",
        "state": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
    <rw-project:state>STRING</rw-project:state>
  </rw-project:role>
</rw-project:user>

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

[
  {
    "role": "STRING",
    "state": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
  <rw-project:state>STRING</rw-project:state>
</rw-project:role>

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

[
  {
    "role": "STRING",
    "description": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
  <rw-project:description>STRING</rw-project:description>
</rw-project:role>

project-nsd:nsd-catalog

Key Identifiers:

XPath Path	/rw-project:project/project-nsd:nsd-catalog
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog
RW.REST URI Path	/rw-project:project/STRING/project-nsd:nsd-catalog

Fields

Name	Type	Description
nsd	LIST

JSON Config Sample

{
  "nsd": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "connection-point": [ { ... }, { ... } ],
      "scaling-group-descriptor": [ { ... }, { ... } ],
      "vnffgd": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "initial-service-primitive": [ { ... }, { ... } ],
      "terminate-service-primitive": [ { ... }, { ... } ],
      "input-parameter-xpath": [ { ... }, { ... } ],
      "parameter-pool": [ { ... }, { ... } ],
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ],
      "vld": [ { ... }, { ... } ],
      "constituent-vnfd": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ],
      "vnf-dependency": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "service-primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "nsd": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "connection-point": [ { ... }, { ... } ],
      "scaling-group-descriptor": [ { ... }, { ... } ],
      "vnffgd": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "initial-service-primitive": [ { ... }, { ... } ],
      "terminate-service-primitive": [ { ... }, { ... } ],
      "input-parameter-xpath": [ { ... }, { ... } ],
      "parameter-pool": [ { ... }, { ... } ],
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ],
      "vld": [ { ... }, { ... } ],
      "constituent-vnfd": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ],
      "vnf-dependency": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "service-primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-nsd:nsd-catalog xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:nsd>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:short-name>STRING</project-nsd:short-name>
    <project-nsd:vendor>STRING</project-nsd:vendor>
    <project-nsd:logo>STRING</project-nsd:logo>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:version>STRING</project-nsd:version>
    <project-nsd:connection-point>...</project-nsd:connection-point>
    <project-nsd:scaling-group-descriptor>...</project-nsd:scaling-group-descriptor>
    <project-nsd:vnffgd>...</project-nsd:vnffgd>
    <project-nsd:ip-profiles>...</project-nsd:ip-profiles>
    <project-nsd:initial-service-primitive>...</project-nsd:initial-service-primitive>
    <project-nsd:terminate-service-primitive>...</project-nsd:terminate-service-primitive>
    <project-nsd:input-parameter-xpath>...</project-nsd:input-parameter-xpath>
    <project-nsd:parameter-pool>...</project-nsd:parameter-pool>
    <project-nsd:key-pair>...</project-nsd:key-pair>
    <project-nsd:user>...</project-nsd:user>
    <project-nsd:vld>...</project-nsd:vld>
    <project-nsd:constituent-vnfd>...</project-nsd:constituent-vnfd>
    <project-nsd:placement-groups>...</project-nsd:placement-groups>
    <project-nsd:vnf-dependency>...</project-nsd:vnf-dependency>
    <project-nsd:monitoring-param>...</project-nsd:monitoring-param>
    <project-nsd:service-primitive>...</project-nsd:service-primitive>
  </project-nsd:nsd>
</project-nsd:nsd-catalog>

XML Sample

<project-nsd:nsd-catalog xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:nsd>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:short-name>STRING</project-nsd:short-name>
    <project-nsd:vendor>STRING</project-nsd:vendor>
    <project-nsd:logo>STRING</project-nsd:logo>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:version>STRING</project-nsd:version>
    <project-nsd:connection-point>...</project-nsd:connection-point>
    <project-nsd:scaling-group-descriptor>...</project-nsd:scaling-group-descriptor>
    <project-nsd:vnffgd>...</project-nsd:vnffgd>
    <project-nsd:ip-profiles>...</project-nsd:ip-profiles>
    <project-nsd:initial-service-primitive>...</project-nsd:initial-service-primitive>
    <project-nsd:terminate-service-primitive>...</project-nsd:terminate-service-primitive>
    <project-nsd:input-parameter-xpath>...</project-nsd:input-parameter-xpath>
    <project-nsd:parameter-pool>...</project-nsd:parameter-pool>
    <project-nsd:key-pair>...</project-nsd:key-pair>
    <project-nsd:user>...</project-nsd:user>
    <project-nsd:vld>...</project-nsd:vld>
    <project-nsd:constituent-vnfd>...</project-nsd:constituent-vnfd>
    <project-nsd:placement-groups>...</project-nsd:placement-groups>
    <project-nsd:vnf-dependency>...</project-nsd:vnf-dependency>
    <project-nsd:monitoring-param>...</project-nsd:monitoring-param>
    <project-nsd:service-primitive>...</project-nsd:service-primitive>
  </project-nsd:nsd>
</project-nsd:nsd-catalog>

project-nsd:nsd

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the NSD.
name	STRING	NSD name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Vendor of the NSD.
logo	STRING	File path for the vendor specific logo. For example icons/mylogo.png. The logo should be part of the network service
description	STRING	Description of the NSD.
version	STRING	Version of the NSD
connection-point	LIST	List for external connection points. Each NS has one or more external connection points. As the name implies that external connection points are used for connecting the NS to other NS or to external networks. Each NS exposes these connection points to the orchestrator. The orchestrator can construct network service chains by connecting the connection points between different NS.
scaling-group-descriptor	LIST	scaling group descriptor within this network service. The scaling group defines a group of VNFs, and the ratio of VNFs in the network service that is used as target for scaling action
vnffgd	LIST	List of VNF Forwarding Graph Descriptors (VNFFGD).
ip-profiles	LIST	List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
initial-service-primitive	LIST	Initial set of service primitives for NSD.
terminate-service-primitive	LIST	Set of service primitives during termination for NSD.
input-parameter-xpath	LIST	List of xpaths to parameters inside the NSD the can be customized during the instantiation.
parameter-pool	LIST	Pool of parameter values which must be pulled from during configuration
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation
user	LIST	List of users to be added through cloud-config
vld	LIST
constituent-vnfd	LIST	List of VNFDs that are part of this network service.
placement-groups	LIST	List of placement groups at NS level
vnf-dependency	LIST	List of VNF dependencies.
monitoring-param	LIST
service-primitive	LIST	Network service level service primitives.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "logo": "STRING",
    "description": "STRING",
    "version": "STRING",
    "connection-point": [
      {
        "name": "STRING",
        "type": "VPORT"
      }, {
        ...
      }
    ],
    "scaling-group-descriptor": [
      {
        "name": "STRING",
        "scaling-policy": [ { ... }, { ... } ],
        "vnfd-member": [ { ... }, { ... } ],
        "min-instance-count": 0,
        "max-instance-count": 10,
        "scaling-config-action": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnffgd": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "rsp": [ { ... }, { ... } ],
        "classifier": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "ip-profiles": [
      {
        "name": "STRING",
        "description": "STRING",
        "ip-profile-params": { ... }
      }, {
        ...
      }
    ],
    "initial-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "terminate-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "input-parameter-xpath": [
      {
        "xpath": "STRING",
        "label": "STRING",
        "default-value": "STRING"
      }, {
        ...
      }
    ],
    "parameter-pool": [
      {
        "name": "STRING",
        "range": { ... }
      }, {
        ...
      }
    ],
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "key-pair": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vld": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "type": "ELAN",
        "root-bandwidth": 0,
        "leaf-bandwidth": 0,
        "provider-network": { ... },
        "mgmt-network": false,
        "vim-network-name": "STRING",
        "ip-profile-ref": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "constituent-vnfd": [
      {
        "member-vnf-index": 0,
        "vnfd-id-ref": "STRING",
        "start-by-default": true
      }, {
        ...
      }
    ],
    "placement-groups": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "member-vnfd": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnf-dependency": [
      {
        "vnf-source-ref": "STRING",
        "vnf-depends-on-ref": "STRING"
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING",
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "COUNTER",
        "units": "STRING",
        "aggregation-type": "AVERAGE",
        "vnfd-monitoring-param": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "service-primitive": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "parameter-group": [ { ... }, { ... } ],
        "vnf-primitive-group": [ { ... }, { ... } ],
        "user-defined-script": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "logo": "STRING",
    "description": "STRING",
    "version": "STRING",
    "connection-point": [
      {
        "name": "STRING",
        "type": "VPORT"
      }, {
        ...
      }
    ],
    "scaling-group-descriptor": [
      {
        "name": "STRING",
        "scaling-policy": [ { ... }, { ... } ],
        "vnfd-member": [ { ... }, { ... } ],
        "min-instance-count": 0,
        "max-instance-count": 10,
        "scaling-config-action": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnffgd": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "rsp": [ { ... }, { ... } ],
        "classifier": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "ip-profiles": [
      {
        "name": "STRING",
        "description": "STRING",
        "ip-profile-params": { ... }
      }, {
        ...
      }
    ],
    "initial-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "terminate-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "input-parameter-xpath": [
      {
        "xpath": "STRING",
        "label": "STRING",
        "default-value": "STRING"
      }, {
        ...
      }
    ],
    "parameter-pool": [
      {
        "name": "STRING",
        "range": { ... }
      }, {
        ...
      }
    ],
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "key-pair": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vld": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "type": "ELAN",
        "root-bandwidth": 0,
        "leaf-bandwidth": 0,
        "provider-network": { ... },
        "mgmt-network": false,
        "vim-network-name": "STRING",
        "ip-profile-ref": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "constituent-vnfd": [
      {
        "member-vnf-index": 0,
        "vnfd-id-ref": "STRING",
        "start-by-default": true
      }, {
        ...
      }
    ],
    "placement-groups": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "member-vnfd": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnf-dependency": [
      {
        "vnf-source-ref": "STRING",
        "vnf-depends-on-ref": "STRING"
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING",
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "COUNTER",
        "units": "STRING",
        "aggregation-type": "AVERAGE",
        "vnfd-monitoring-param": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "service-primitive": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "parameter-group": [ { ... }, { ... } ],
        "vnf-primitive-group": [ { ... }, { ... } ],
        "user-defined-script": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:nsd xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:short-name>STRING</project-nsd:short-name>
  <project-nsd:vendor>STRING</project-nsd:vendor>
  <project-nsd:logo>STRING</project-nsd:logo>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:version>STRING</project-nsd:version>
  <project-nsd:connection-point>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:type>VPORT</project-nsd:type>
  </project-nsd:connection-point>
  <project-nsd:scaling-group-descriptor>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:scaling-policy>...</project-nsd:scaling-policy>
    <project-nsd:vnfd-member>...</project-nsd:vnfd-member>
    <project-nsd:min-instance-count>0</project-nsd:min-instance-count>
    <project-nsd:max-instance-count>10</project-nsd:max-instance-count>
    <project-nsd:scaling-config-action>...</project-nsd:scaling-config-action>
  </project-nsd:scaling-group-descriptor>
  <project-nsd:vnffgd>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:short-name>STRING</project-nsd:short-name>
    <project-nsd:vendor>STRING</project-nsd:vendor>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:version>STRING</project-nsd:version>
    <project-nsd:rsp>...</project-nsd:rsp>
    <project-nsd:classifier>...</project-nsd:classifier>
  </project-nsd:vnffgd>
  <project-nsd:ip-profiles>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:ip-profile-params>...</project-nsd:ip-profile-params>
  </project-nsd:ip-profiles>
  <project-nsd:initial-service-primitive>
    <project-nsd:seq>0</project-nsd:seq>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
    <project-nsd:parameter>...</project-nsd:parameter>
  </project-nsd:initial-service-primitive>
  <project-nsd:terminate-service-primitive>
    <project-nsd:seq>0</project-nsd:seq>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
    <project-nsd:parameter>...</project-nsd:parameter>
  </project-nsd:terminate-service-primitive>
  <project-nsd:input-parameter-xpath>
    <project-nsd:xpath>STRING</project-nsd:xpath>
    <project-nsd:label>STRING</project-nsd:label>
    <project-nsd:default-value>STRING</project-nsd:default-value>
  </project-nsd:input-parameter-xpath>
  <project-nsd:parameter-pool>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:range>...</project-nsd:range>
  </project-nsd:parameter-pool>
  <project-nsd:key-pair>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:key>STRING</project-nsd:key>
  </project-nsd:key-pair>
  <project-nsd:user>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:user-info>STRING</project-nsd:user-info>
    <project-nsd:key-pair>...</project-nsd:key-pair>
  </project-nsd:user>
  <project-nsd:vld>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:short-name>STRING</project-nsd:short-name>
    <project-nsd:vendor>STRING</project-nsd:vendor>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:version>STRING</project-nsd:version>
    <project-nsd:type>ELAN</project-nsd:type>
    <project-nsd:root-bandwidth>0</project-nsd:root-bandwidth>
    <project-nsd:leaf-bandwidth>0</project-nsd:leaf-bandwidth>
    <project-nsd:provider-network>...</project-nsd:provider-network>
    <project-nsd:mgmt-network>false</project-nsd:mgmt-network>
    <project-nsd:vim-network-name>STRING</project-nsd:vim-network-name>
    <project-nsd:ip-profile-ref>STRING</project-nsd:ip-profile-ref>
    <project-nsd:vnfd-connection-point-ref>...</project-nsd:vnfd-connection-point-ref>
  </project-nsd:vld>
  <project-nsd:constituent-vnfd>
    <project-nsd:member-vnf-index>0</project-nsd:member-vnf-index>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
    <project-nsd:start-by-default>true</project-nsd:start-by-default>
  </project-nsd:constituent-vnfd>
  <project-nsd:placement-groups>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:requirement>STRING</project-nsd:requirement>
    <project-nsd:strategy>COLOCATION</project-nsd:strategy>
    <project-nsd:member-vnfd>...</project-nsd:member-vnfd>
  </project-nsd:placement-groups>
  <project-nsd:vnf-dependency>
    <project-nsd:vnf-source-ref>STRING</project-nsd:vnf-source-ref>
    <project-nsd:vnf-depends-on-ref>STRING</project-nsd:vnf-depends-on-ref>
  </project-nsd:vnf-dependency>
  <project-nsd:monitoring-param>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:value-type>INT</project-nsd:value-type>
    <project-nsd:numeric-constraints>...</project-nsd:numeric-constraints>
    <project-nsd:text-constraints>...</project-nsd:text-constraints>
    <project-nsd:value-integer>0</project-nsd:value-integer>
    <project-nsd:value-decimal>0.0</project-nsd:value-decimal>
    <project-nsd:value-string>STRING</project-nsd:value-string>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:group-tag>STRING</project-nsd:group-tag>
    <project-nsd:widget-type>COUNTER</project-nsd:widget-type>
    <project-nsd:units>STRING</project-nsd:units>
    <project-nsd:aggregation-type>AVERAGE</project-nsd:aggregation-type>
    <project-nsd:vnfd-monitoring-param>...</project-nsd:vnfd-monitoring-param>
  </project-nsd:monitoring-param>
  <project-nsd:service-primitive>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:parameter>...</project-nsd:parameter>
    <project-nsd:parameter-group>...</project-nsd:parameter-group>
    <project-nsd:vnf-primitive-group>...</project-nsd:vnf-primitive-group>
    <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
  </project-nsd:service-primitive>
</project-nsd:nsd>

XML Sample

<project-nsd:nsd xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:short-name>STRING</project-nsd:short-name>
  <project-nsd:vendor>STRING</project-nsd:vendor>
  <project-nsd:logo>STRING</project-nsd:logo>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:version>STRING</project-nsd:version>
  <project-nsd:connection-point>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:type>VPORT</project-nsd:type>
  </project-nsd:connection-point>
  <project-nsd:scaling-group-descriptor>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:scaling-policy>...</project-nsd:scaling-policy>
    <project-nsd:vnfd-member>...</project-nsd:vnfd-member>
    <project-nsd:min-instance-count>0</project-nsd:min-instance-count>
    <project-nsd:max-instance-count>10</project-nsd:max-instance-count>
    <project-nsd:scaling-config-action>...</project-nsd:scaling-config-action>
  </project-nsd:scaling-group-descriptor>
  <project-nsd:vnffgd>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:short-name>STRING</project-nsd:short-name>
    <project-nsd:vendor>STRING</project-nsd:vendor>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:version>STRING</project-nsd:version>
    <project-nsd:rsp>...</project-nsd:rsp>
    <project-nsd:classifier>...</project-nsd:classifier>
  </project-nsd:vnffgd>
  <project-nsd:ip-profiles>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:ip-profile-params>...</project-nsd:ip-profile-params>
  </project-nsd:ip-profiles>
  <project-nsd:initial-service-primitive>
    <project-nsd:seq>0</project-nsd:seq>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
    <project-nsd:parameter>...</project-nsd:parameter>
  </project-nsd:initial-service-primitive>
  <project-nsd:terminate-service-primitive>
    <project-nsd:seq>0</project-nsd:seq>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
    <project-nsd:parameter>...</project-nsd:parameter>
  </project-nsd:terminate-service-primitive>
  <project-nsd:input-parameter-xpath>
    <project-nsd:xpath>STRING</project-nsd:xpath>
    <project-nsd:label>STRING</project-nsd:label>
    <project-nsd:default-value>STRING</project-nsd:default-value>
  </project-nsd:input-parameter-xpath>
  <project-nsd:parameter-pool>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:range>...</project-nsd:range>
  </project-nsd:parameter-pool>
  <project-nsd:key-pair>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:key>STRING</project-nsd:key>
  </project-nsd:key-pair>
  <project-nsd:user>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:user-info>STRING</project-nsd:user-info>
    <project-nsd:key-pair>...</project-nsd:key-pair>
  </project-nsd:user>
  <project-nsd:vld>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:short-name>STRING</project-nsd:short-name>
    <project-nsd:vendor>STRING</project-nsd:vendor>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:version>STRING</project-nsd:version>
    <project-nsd:type>ELAN</project-nsd:type>
    <project-nsd:root-bandwidth>0</project-nsd:root-bandwidth>
    <project-nsd:leaf-bandwidth>0</project-nsd:leaf-bandwidth>
    <project-nsd:provider-network>...</project-nsd:provider-network>
    <project-nsd:mgmt-network>false</project-nsd:mgmt-network>
    <project-nsd:vim-network-name>STRING</project-nsd:vim-network-name>
    <project-nsd:ip-profile-ref>STRING</project-nsd:ip-profile-ref>
    <project-nsd:vnfd-connection-point-ref>...</project-nsd:vnfd-connection-point-ref>
  </project-nsd:vld>
  <project-nsd:constituent-vnfd>
    <project-nsd:member-vnf-index>0</project-nsd:member-vnf-index>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
    <project-nsd:start-by-default>true</project-nsd:start-by-default>
  </project-nsd:constituent-vnfd>
  <project-nsd:placement-groups>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:requirement>STRING</project-nsd:requirement>
    <project-nsd:strategy>COLOCATION</project-nsd:strategy>
    <project-nsd:member-vnfd>...</project-nsd:member-vnfd>
  </project-nsd:placement-groups>
  <project-nsd:vnf-dependency>
    <project-nsd:vnf-source-ref>STRING</project-nsd:vnf-source-ref>
    <project-nsd:vnf-depends-on-ref>STRING</project-nsd:vnf-depends-on-ref>
  </project-nsd:vnf-dependency>
  <project-nsd:monitoring-param>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:value-type>INT</project-nsd:value-type>
    <project-nsd:numeric-constraints>...</project-nsd:numeric-constraints>
    <project-nsd:text-constraints>...</project-nsd:text-constraints>
    <project-nsd:value-integer>0</project-nsd:value-integer>
    <project-nsd:value-decimal>0.0</project-nsd:value-decimal>
    <project-nsd:value-string>STRING</project-nsd:value-string>
    <project-nsd:description>STRING</project-nsd:description>
    <project-nsd:group-tag>STRING</project-nsd:group-tag>
    <project-nsd:widget-type>COUNTER</project-nsd:widget-type>
    <project-nsd:units>STRING</project-nsd:units>
    <project-nsd:aggregation-type>AVERAGE</project-nsd:aggregation-type>
    <project-nsd:vnfd-monitoring-param>...</project-nsd:vnfd-monitoring-param>
  </project-nsd:monitoring-param>
  <project-nsd:service-primitive>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:parameter>...</project-nsd:parameter>
    <project-nsd:parameter-group>...</project-nsd:parameter-group>
    <project-nsd:vnf-primitive-group>...</project-nsd:vnf-primitive-group>
    <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
  </project-nsd:service-primitive>
</project-nsd:nsd>

project-nsd:connection-point

List for external connection points. Each NS has one or more external connection points. As the name implies that external connection points are used for connecting the NS to other NS or to external networks. Each NS exposes these connection points to the orchestrator. The orchestrator can construct network service chains by connecting the connection points between different NS.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:connection-point

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:connection-point[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/connection-point/STRING

Fields

Name	Type	Description
name	STRING	Name of the NS connection point.
type	ENUM	Type of the connection point.

JSON Config Sample

[
  {
    "name": "STRING",
    "type": "VPORT"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "type": "VPORT"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:connection-point xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:type>VPORT</project-nsd:type>
</project-nsd:connection-point>

XML Sample

<project-nsd:connection-point xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:type>VPORT</project-nsd:type>
</project-nsd:connection-point>

project-nsd:scaling-group-descriptor

scaling group descriptor within this network service. The scaling group defines a group of VNFs, and the ratio of VNFs in the network service that is used as target for scaling action

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING

Fields

Name	Type	Description
name	STRING	Name of this scaling group.
scaling-policy	LIST
vnfd-member	LIST	List of VNFs in this scaling group
min-instance-count	UINT32	Minimum instances of the scaling group which are allowed. These instances are created by default when the network service is instantiated.
max-instance-count	UINT32	Maximum instances of this scaling group that are allowed in a single network service. The network service scaling will fail, when the number of service group instances exceed the max-instance-count specified.
scaling-config-action	LIST	List of scaling config actions

JSON Config Sample

[
  {
    "name": "STRING",
    "scaling-policy": [
      {
        "name": "STRING",
        "scaling-type": "manual",
        "enabled": true,
        "scale-in-operation-type": "AND",
        "scale-out-operation-type": "OR",
        "threshold-time": 0,
        "cooldown-time": 0,
        "scaling-criteria": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnfd-member": [
      {
        "member-vnf-index-ref": 0,
        "count": 1
      }, {
        ...
      }
    ],
    "min-instance-count": 0,
    "max-instance-count": 10,
    "scaling-config-action": [
      {
        "trigger": "pre-scale-in",
        "ns-service-primitive-name-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scaling-policy": [
      {
        "name": "STRING",
        "scaling-type": "manual",
        "enabled": true,
        "scale-in-operation-type": "AND",
        "scale-out-operation-type": "OR",
        "threshold-time": 0,
        "cooldown-time": 0,
        "scaling-criteria": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnfd-member": [
      {
        "member-vnf-index-ref": 0,
        "count": 1
      }, {
        ...
      }
    ],
    "min-instance-count": 0,
    "max-instance-count": 10,
    "scaling-config-action": [
      {
        "trigger": "pre-scale-in",
        "ns-service-primitive-name-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:scaling-group-descriptor xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:scaling-policy>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:scaling-type>manual</project-nsd:scaling-type>
    <project-nsd:enabled>true</project-nsd:enabled>
    <project-nsd:scale-in-operation-type>AND</project-nsd:scale-in-operation-type>
    <project-nsd:scale-out-operation-type>OR</project-nsd:scale-out-operation-type>
    <project-nsd:threshold-time>0</project-nsd:threshold-time>
    <project-nsd:cooldown-time>0</project-nsd:cooldown-time>
    <project-nsd:scaling-criteria>...</project-nsd:scaling-criteria>
  </project-nsd:scaling-policy>
  <project-nsd:vnfd-member>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:count>1</project-nsd:count>
  </project-nsd:vnfd-member>
  <project-nsd:min-instance-count>0</project-nsd:min-instance-count>
  <project-nsd:max-instance-count>10</project-nsd:max-instance-count>
  <project-nsd:scaling-config-action>
    <project-nsd:trigger>pre-scale-in</project-nsd:trigger>
    <project-nsd:ns-service-primitive-name-ref>STRING</project-nsd:ns-service-primitive-name-ref>
  </project-nsd:scaling-config-action>
</project-nsd:scaling-group-descriptor>

XML Sample

<project-nsd:scaling-group-descriptor xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:scaling-policy>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:scaling-type>manual</project-nsd:scaling-type>
    <project-nsd:enabled>true</project-nsd:enabled>
    <project-nsd:scale-in-operation-type>AND</project-nsd:scale-in-operation-type>
    <project-nsd:scale-out-operation-type>OR</project-nsd:scale-out-operation-type>
    <project-nsd:threshold-time>0</project-nsd:threshold-time>
    <project-nsd:cooldown-time>0</project-nsd:cooldown-time>
    <project-nsd:scaling-criteria>...</project-nsd:scaling-criteria>
  </project-nsd:scaling-policy>
  <project-nsd:vnfd-member>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:count>1</project-nsd:count>
  </project-nsd:vnfd-member>
  <project-nsd:min-instance-count>0</project-nsd:min-instance-count>
  <project-nsd:max-instance-count>10</project-nsd:max-instance-count>
  <project-nsd:scaling-config-action>
    <project-nsd:trigger>pre-scale-in</project-nsd:trigger>
    <project-nsd:ns-service-primitive-name-ref>STRING</project-nsd:ns-service-primitive-name-ref>
  </project-nsd:scaling-config-action>
</project-nsd:scaling-group-descriptor>

project-nsd:scaling-policy

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-policy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-policy[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-policy/STRING

Fields

Name	Type	Description
name	STRING	Name of the scaling policy
scaling-type	ENUM	Type of scaling
enabled	BOOLEAN	Specifies if the scaling policy can be applied
scale-in-operation-type	ENUM	Operation to be applied to check between scaling criterias to check if the scale in threshold condition has been met. Defaults to AND
scale-out-operation-type	ENUM	Operation to be applied to check between scaling criterias to check if the scale out threshold condition has been met. Defauls to OR
threshold-time	UINT32	The duration for which the criteria must hold true
cooldown-time	UINT32	The duration after a scaling-in/scaling-out action has been triggered, for which there will be no further optional
scaling-criteria	LIST	list of conditions to be met for generating scaling requests

JSON Config Sample

[
  {
    "name": "STRING",
    "scaling-type": "manual",
    "enabled": true,
    "scale-in-operation-type": "AND",
    "scale-out-operation-type": "OR",
    "threshold-time": 0,
    "cooldown-time": 0,
    "scaling-criteria": [
      {
        "name": "STRING",
        "scale-in-threshold": 0,
        "scale-out-threshold": 0,
        "ns-monitoring-param-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scaling-type": "manual",
    "enabled": true,
    "scale-in-operation-type": "AND",
    "scale-out-operation-type": "OR",
    "threshold-time": 0,
    "cooldown-time": 0,
    "scaling-criteria": [
      {
        "name": "STRING",
        "scale-in-threshold": 0,
        "scale-out-threshold": 0,
        "ns-monitoring-param-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:scaling-policy xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:scaling-type>manual</project-nsd:scaling-type>
  <project-nsd:enabled>true</project-nsd:enabled>
  <project-nsd:scale-in-operation-type>AND</project-nsd:scale-in-operation-type>
  <project-nsd:scale-out-operation-type>OR</project-nsd:scale-out-operation-type>
  <project-nsd:threshold-time>0</project-nsd:threshold-time>
  <project-nsd:cooldown-time>0</project-nsd:cooldown-time>
  <project-nsd:scaling-criteria>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:scale-in-threshold>0</project-nsd:scale-in-threshold>
    <project-nsd:scale-out-threshold>0</project-nsd:scale-out-threshold>
    <project-nsd:ns-monitoring-param-ref>STRING</project-nsd:ns-monitoring-param-ref>
  </project-nsd:scaling-criteria>
</project-nsd:scaling-policy>

XML Sample

<project-nsd:scaling-policy xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:scaling-type>manual</project-nsd:scaling-type>
  <project-nsd:enabled>true</project-nsd:enabled>
  <project-nsd:scale-in-operation-type>AND</project-nsd:scale-in-operation-type>
  <project-nsd:scale-out-operation-type>OR</project-nsd:scale-out-operation-type>
  <project-nsd:threshold-time>0</project-nsd:threshold-time>
  <project-nsd:cooldown-time>0</project-nsd:cooldown-time>
  <project-nsd:scaling-criteria>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:scale-in-threshold>0</project-nsd:scale-in-threshold>
    <project-nsd:scale-out-threshold>0</project-nsd:scale-out-threshold>
    <project-nsd:ns-monitoring-param-ref>STRING</project-nsd:ns-monitoring-param-ref>
  </project-nsd:scaling-criteria>
</project-nsd:scaling-policy>

project-nsd:scaling-criteria

list of conditions to be met for generating scaling requests

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-policy/project-nsd:scaling-criteria

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-policy[project-nsd:name='STRING']/project-nsd:scaling-criteria[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-policy/STRING/scaling-criteria/STRING

Fields

Name	Type	Description
name	STRING
scale-in-threshold	UINT64	Value below which scale-in requests are generated
scale-out-threshold	UINT64	Value above which scale-out requests are generated
ns-monitoring-param-ref	LEAFREF	Reference to the NS level monitoring parameter that is aggregated

JSON Config Sample

[
  {
    "name": "STRING",
    "scale-in-threshold": 0,
    "scale-out-threshold": 0,
    "ns-monitoring-param-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scale-in-threshold": 0,
    "scale-out-threshold": 0,
    "ns-monitoring-param-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:scaling-criteria xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:scale-in-threshold>0</project-nsd:scale-in-threshold>
  <project-nsd:scale-out-threshold>0</project-nsd:scale-out-threshold>
  <project-nsd:ns-monitoring-param-ref>STRING</project-nsd:ns-monitoring-param-ref>
</project-nsd:scaling-criteria>

XML Sample

<project-nsd:scaling-criteria xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:scale-in-threshold>0</project-nsd:scale-in-threshold>
  <project-nsd:scale-out-threshold>0</project-nsd:scale-out-threshold>
  <project-nsd:ns-monitoring-param-ref>STRING</project-nsd:ns-monitoring-param-ref>
</project-nsd:scaling-criteria>

project-nsd:vnfd-member

List of VNFs in this scaling group

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:vnfd-member

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:vnfd-member[project-nsd:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/vnfd-member/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	member VNF index of this member VNF
count	UINT32	count of this member VNF within this scaling group. The count allows to define the number of instances when a scaling action targets this scaling group

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "count": 1
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "count": 1
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:vnfd-member xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:count>1</project-nsd:count>
</project-nsd:vnfd-member>

XML Sample

<project-nsd:vnfd-member xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:count>1</project-nsd:count>
</project-nsd:vnfd-member>

project-nsd:scaling-config-action

List of scaling config actions

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:scaling-group-descriptor/project-nsd:scaling-config-action

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:scaling-group-descriptor[project-nsd:name='STRING']/project-nsd:scaling-config-action[project-nsd:trigger='pre-scale-in']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-config-action/pre-scale-in

Fields

Name	Type	Description
trigger	ENUM	scaling trigger
ns-service-primitive-name-ref	LEAFREF	Reference to the NS service primitive

JSON Config Sample

[
  {
    "trigger": "pre-scale-in",
    "ns-service-primitive-name-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "trigger": "pre-scale-in",
    "ns-service-primitive-name-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:scaling-config-action xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:trigger>pre-scale-in</project-nsd:trigger>
  <project-nsd:ns-service-primitive-name-ref>STRING</project-nsd:ns-service-primitive-name-ref>
</project-nsd:scaling-config-action>

XML Sample

<project-nsd:scaling-config-action xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:trigger>pre-scale-in</project-nsd:trigger>
  <project-nsd:ns-service-primitive-name-ref>STRING</project-nsd:ns-service-primitive-name-ref>
</project-nsd:scaling-config-action>

project-nsd:vnffgd

List of VNF Forwarding Graph Descriptors (VNFFGD).

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VNFFGD.
name	STRING	VNFFGD name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Provider of the VNFFGD.
description	STRING	Description of the VNFFGD.
version	STRING	Version of the VNFFGD
rsp	LIST	List of Rendered Service Paths (RSP).
classifier	LIST	List of classifier rules.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "rsp": [
      {
        "id": "STRING",
        "name": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier": [
      {
        "id": "STRING",
        "name": "STRING",
        "rsp-id-ref": "STRING",
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING",
        "match-attributes": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "rsp": [
      {
        "id": "STRING",
        "name": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier": [
      {
        "id": "STRING",
        "name": "STRING",
        "rsp-id-ref": "STRING",
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING",
        "match-attributes": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:vnffgd xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:short-name>STRING</project-nsd:short-name>
  <project-nsd:vendor>STRING</project-nsd:vendor>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:version>STRING</project-nsd:version>
  <project-nsd:rsp>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:vnfd-connection-point-ref>...</project-nsd:vnfd-connection-point-ref>
  </project-nsd:rsp>
  <project-nsd:classifier>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:rsp-id-ref>STRING</project-nsd:rsp-id-ref>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
    <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
    <project-nsd:match-attributes>...</project-nsd:match-attributes>
  </project-nsd:classifier>
</project-nsd:vnffgd>

XML Sample

<project-nsd:vnffgd xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:short-name>STRING</project-nsd:short-name>
  <project-nsd:vendor>STRING</project-nsd:vendor>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:version>STRING</project-nsd:version>
  <project-nsd:rsp>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:vnfd-connection-point-ref>...</project-nsd:vnfd-connection-point-ref>
  </project-nsd:rsp>
  <project-nsd:classifier>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:rsp-id-ref>STRING</project-nsd:rsp-id-ref>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
    <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
    <project-nsd:match-attributes>...</project-nsd:match-attributes>
  </project-nsd:classifier>
</project-nsd:vnffgd>

project-nsd:rsp

List of Rendered Service Paths (RSP).

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:rsp

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:rsp[project-nsd:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/rsp/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the RSP.
name	STRING	RSP name.
vnfd-connection-point-ref	LIST	A list of references to connection points.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "order": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "order": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:rsp xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:vnfd-connection-point-ref>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:order>0</project-nsd:order>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
    <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
  </project-nsd:vnfd-connection-point-ref>
</project-nsd:rsp>

XML Sample

<project-nsd:rsp xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:vnfd-connection-point-ref>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:order>0</project-nsd:order>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
    <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
  </project-nsd:vnfd-connection-point-ref>
</project-nsd:rsp>

project-nsd:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:rsp/project-nsd:vnfd-connection-point-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:rsp[project-nsd:id='STRING']/project-nsd:vnfd-connection-point-ref[project-nsd:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/rsp/STRING/vnfd-connection-point-ref/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
order	UINT8	A number that denotes the order of a VNF in a chain
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref
vnfd-connection-point-ref	STRING	A reference to a connection point name in a vnfd. This is a leafref to path: /vnfd:vnfd-catalog/vnfd:vnfd + [vnfd:id = current()/../nsd:vnfd-id-ref] + /vnfd:connection-point/vnfd:name NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "order": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "order": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:vnfd-connection-point-ref xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:order>0</project-nsd:order>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
</project-nsd:vnfd-connection-point-ref>

XML Sample

<project-nsd:vnfd-connection-point-ref xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:order>0</project-nsd:order>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
</project-nsd:vnfd-connection-point-ref>

project-nsd:classifier

List of classifier rules.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:classifier

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:classifier[project-nsd:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/classifier/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the classifier rule.
name	STRING	Name of the classifier.
rsp-id-ref	LEAFREF	A reference to the RSP.
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref to path: ../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref
vnfd-connection-point-ref	STRING	A reference to a connection point name in a vnfd. This is a leafref to path: /vnfd:vnfd-catalog/vnfd:vnfd + [vnfd:id = current()/../nsd:vnfd-id-ref] + /vnfd:connection-point/vnfd:name NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
match-attributes	LIST	List of match attributes.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "rsp-id-ref": "STRING",
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING",
    "match-attributes": [
      {
        "id": "STRING",
        "ip-proto": 0,
        "source-ip-address": "UNION_VALUE",
        "destination-ip-address": "UNION_VALUE",
        "source-port": 0,
        "destination-port": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "rsp-id-ref": "STRING",
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING",
    "match-attributes": [
      {
        "id": "STRING",
        "ip-proto": 0,
        "source-ip-address": "UNION_VALUE",
        "destination-ip-address": "UNION_VALUE",
        "source-port": 0,
        "destination-port": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:classifier xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:rsp-id-ref>STRING</project-nsd:rsp-id-ref>
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
  <project-nsd:match-attributes>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:ip-proto>0</project-nsd:ip-proto>
    <project-nsd:source-ip-address>UNION_VALUE</project-nsd:source-ip-address>
    <project-nsd:destination-ip-address>UNION_VALUE</project-nsd:destination-ip-address>
    <project-nsd:source-port>0</project-nsd:source-port>
    <project-nsd:destination-port>0</project-nsd:destination-port>
  </project-nsd:match-attributes>
</project-nsd:classifier>

XML Sample

<project-nsd:classifier xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:rsp-id-ref>STRING</project-nsd:rsp-id-ref>
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
  <project-nsd:match-attributes>
    <project-nsd:id>STRING</project-nsd:id>
    <project-nsd:ip-proto>0</project-nsd:ip-proto>
    <project-nsd:source-ip-address>UNION_VALUE</project-nsd:source-ip-address>
    <project-nsd:destination-ip-address>UNION_VALUE</project-nsd:destination-ip-address>
    <project-nsd:source-port>0</project-nsd:source-port>
    <project-nsd:destination-port>0</project-nsd:destination-port>
  </project-nsd:match-attributes>
</project-nsd:classifier>

project-nsd:match-attributes

List of match attributes.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnffgd/project-nsd:classifier/project-nsd:match-attributes

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnffgd[project-nsd:id='STRING']/project-nsd:classifier[project-nsd:id='STRING']/project-nsd:match-attributes[project-nsd:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/classifier/STRING/match-attributes/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the classifier match attribute rule.
ip-proto	UINT8	IP Protocol.
source-ip-address	UNION	Source IP address.
destination-ip-address	UNION	Destination IP address.
source-port	UINT16	Source port number.
destination-port	UINT16	Destination port number.

JSON Config Sample

[
  {
    "id": "STRING",
    "ip-proto": 0,
    "source-ip-address": "UNION_VALUE",
    "destination-ip-address": "UNION_VALUE",
    "source-port": 0,
    "destination-port": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "ip-proto": 0,
    "source-ip-address": "UNION_VALUE",
    "destination-ip-address": "UNION_VALUE",
    "source-port": 0,
    "destination-port": 0
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:match-attributes xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:ip-proto>0</project-nsd:ip-proto>
  <project-nsd:source-ip-address>UNION_VALUE</project-nsd:source-ip-address>
  <project-nsd:destination-ip-address>UNION_VALUE</project-nsd:destination-ip-address>
  <project-nsd:source-port>0</project-nsd:source-port>
  <project-nsd:destination-port>0</project-nsd:destination-port>
</project-nsd:match-attributes>

XML Sample

<project-nsd:match-attributes xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:ip-proto>0</project-nsd:ip-proto>
  <project-nsd:source-ip-address>UNION_VALUE</project-nsd:source-ip-address>
  <project-nsd:destination-ip-address>UNION_VALUE</project-nsd:destination-ip-address>
  <project-nsd:source-port>0</project-nsd:source-port>
  <project-nsd:destination-port>0</project-nsd:destination-port>
</project-nsd:match-attributes>

project-nsd:ip-profiles

List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/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

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:ip-profiles xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:ip-profile-params>
    <project-nsd:ip-version>ipv4</project-nsd:ip-version>
    <project-nsd:subnet-address>UNION_VALUE</project-nsd:subnet-address>
    <project-nsd:gateway-address>UNION_VALUE</project-nsd:gateway-address>
    <project-nsd:security-group>STRING</project-nsd:security-group>
    <project-nsd:dns-server>...</project-nsd:dns-server>
    <project-nsd:dhcp-params>...</project-nsd:dhcp-params>
    <project-nsd:subnet-prefix-pool>STRING</project-nsd:subnet-prefix-pool>
  </project-nsd:ip-profile-params>
</project-nsd:ip-profiles>

XML Sample

<project-nsd:ip-profiles xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:ip-profile-params>
    <project-nsd:ip-version>ipv4</project-nsd:ip-version>
    <project-nsd:subnet-address>UNION_VALUE</project-nsd:subnet-address>
    <project-nsd:gateway-address>UNION_VALUE</project-nsd:gateway-address>
    <project-nsd:security-group>STRING</project-nsd:security-group>
    <project-nsd:dns-server>...</project-nsd:dns-server>
    <project-nsd:dhcp-params>...</project-nsd:dhcp-params>
    <project-nsd:subnet-prefix-pool>STRING</project-nsd:subnet-prefix-pool>
  </project-nsd:ip-profile-params>
</project-nsd:ip-profiles>

project-nsd:ip-profile-params

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/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

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

JSON Sample

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

XML Config Sample

<project-nsd:ip-profile-params xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:ip-version>ipv4</project-nsd:ip-version>
  <project-nsd:subnet-address>UNION_VALUE</project-nsd:subnet-address>
  <project-nsd:gateway-address>UNION_VALUE</project-nsd:gateway-address>
  <project-nsd:security-group>STRING</project-nsd:security-group>
  <project-nsd:dns-server>
    <project-nsd:address>UNION_VALUE</project-nsd:address>
  </project-nsd:dns-server>
  <project-nsd:dhcp-params>
    <project-nsd:enabled>true</project-nsd:enabled>
    <project-nsd:start-address>UNION_VALUE</project-nsd:start-address>
    <project-nsd:count>0</project-nsd:count>
  </project-nsd:dhcp-params>
  <project-nsd:subnet-prefix-pool>STRING</project-nsd:subnet-prefix-pool>
</project-nsd:ip-profile-params>

XML Sample

<project-nsd:ip-profile-params xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:ip-version>ipv4</project-nsd:ip-version>
  <project-nsd:subnet-address>UNION_VALUE</project-nsd:subnet-address>
  <project-nsd:gateway-address>UNION_VALUE</project-nsd:gateway-address>
  <project-nsd:security-group>STRING</project-nsd:security-group>
  <project-nsd:dns-server>
    <project-nsd:address>UNION_VALUE</project-nsd:address>
  </project-nsd:dns-server>
  <project-nsd:dhcp-params>
    <project-nsd:enabled>true</project-nsd:enabled>
    <project-nsd:start-address>UNION_VALUE</project-nsd:start-address>
    <project-nsd:count>0</project-nsd:count>
  </project-nsd:dhcp-params>
  <project-nsd:subnet-prefix-pool>STRING</project-nsd:subnet-prefix-pool>
</project-nsd:ip-profile-params>

project-nsd:dns-server

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params/project-nsd:dns-server

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params/project-nsd:dns-server[project-nsd:address='UNION_VALUE']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/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

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:dns-server xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:address>UNION_VALUE</project-nsd:address>
</project-nsd:dns-server>

XML Sample

<project-nsd:dns-server xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:address>UNION_VALUE</project-nsd:address>
</project-nsd:dns-server>

project-nsd:dhcp-params

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:ip-profiles/project-nsd:ip-profile-params/project-nsd:dhcp-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:ip-profiles[project-nsd:name='STRING']/project-nsd:ip-profile-params/project-nsd:dhcp-params

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/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

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

JSON Sample

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

XML Config Sample

<project-nsd:dhcp-params xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:enabled>true</project-nsd:enabled>
  <project-nsd:start-address>UNION_VALUE</project-nsd:start-address>
  <project-nsd:count>0</project-nsd:count>
</project-nsd:dhcp-params>

XML Sample

<project-nsd:dhcp-params xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:enabled>true</project-nsd:enabled>
  <project-nsd:start-address>UNION_VALUE</project-nsd:start-address>
  <project-nsd:count>0</project-nsd:count>
</project-nsd:dhcp-params>

project-nsd:initial-service-primitive

Initial set of service primitives for NSD.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:initial-service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:initial-service-primitive[project-nsd:seq='0']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/initial-service-primitive/0

Fields

Name	Type	Description
seq	UINT64	Sequence number for the configuration primitive.
name	STRING	Name of the configuration primitive.
user-defined-script	STRING	A user defined script.
parameter	LIST

JSON Config Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:initial-service-primitive xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:seq>0</project-nsd:seq>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
  <project-nsd:parameter>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:value>STRING</project-nsd:value>
  </project-nsd:parameter>
</project-nsd:initial-service-primitive>

XML Sample

<project-nsd:initial-service-primitive xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:seq>0</project-nsd:seq>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
  <project-nsd:parameter>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:value>STRING</project-nsd:value>
  </project-nsd:parameter>
</project-nsd:initial-service-primitive>

project-nsd:parameter

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:initial-service-primitive/project-nsd:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:initial-service-primitive[project-nsd:seq='0']/project-nsd:parameter[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/initial-service-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING
value	STRING	Value of the configuration primitive.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:parameter xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:value>STRING</project-nsd:value>
</project-nsd:parameter>

XML Sample

<project-nsd:parameter xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:value>STRING</project-nsd:value>
</project-nsd:parameter>

project-nsd:terminate-service-primitive

Set of service primitives during termination for NSD.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:terminate-service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:terminate-service-primitive[project-nsd:seq='0']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/terminate-service-primitive/0

Fields

Name	Type	Description
seq	UINT64	Sequence number for the configuration primitive.
name	STRING	Name of the configuration primitive.
user-defined-script	STRING	A user defined script.
parameter	LIST

JSON Config Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:terminate-service-primitive xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:seq>0</project-nsd:seq>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
  <project-nsd:parameter>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:value>STRING</project-nsd:value>
  </project-nsd:parameter>
</project-nsd:terminate-service-primitive>

XML Sample

<project-nsd:terminate-service-primitive xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:seq>0</project-nsd:seq>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
  <project-nsd:parameter>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:value>STRING</project-nsd:value>
  </project-nsd:parameter>
</project-nsd:terminate-service-primitive>

project-nsd:parameter

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:terminate-service-primitive/project-nsd:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:terminate-service-primitive[project-nsd:seq='0']/project-nsd:parameter[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/terminate-service-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING
value	STRING	Value of the configuration primitive.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:parameter xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:value>STRING</project-nsd:value>
</project-nsd:parameter>

XML Sample

<project-nsd:parameter xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:value>STRING</project-nsd:value>
</project-nsd:parameter>

project-nsd:input-parameter-xpath

List of xpaths to parameters inside the NSD the can be customized during the instantiation.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:input-parameter-xpath

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:input-parameter-xpath[project-nsd:xpath='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/input-parameter-xpath/STRING

Fields

Name	Type	Description
xpath	STRING	An xpath that specifies the element in a descriptor.
label	STRING	A descriptive string
default-value	STRING	Default Value for the Input Parameter

JSON Config Sample

[
  {
    "xpath": "STRING",
    "label": "STRING",
    "default-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "xpath": "STRING",
    "label": "STRING",
    "default-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:input-parameter-xpath xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:xpath>STRING</project-nsd:xpath>
  <project-nsd:label>STRING</project-nsd:label>
  <project-nsd:default-value>STRING</project-nsd:default-value>
</project-nsd:input-parameter-xpath>

XML Sample

<project-nsd:input-parameter-xpath xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:xpath>STRING</project-nsd:xpath>
  <project-nsd:label>STRING</project-nsd:label>
  <project-nsd:default-value>STRING</project-nsd:default-value>
</project-nsd:input-parameter-xpath>

project-nsd:parameter-pool

Pool of parameter values which must be pulled from during configuration

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:parameter-pool

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:parameter-pool[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/parameter-pool/STRING

Fields

Name	Type	Description
name	STRING	Name of the configuration value pool
range	CONTAINER	Create a range of values to populate the pool with

JSON Config Sample

[
  {
    "name": "STRING",
    "range": {
      "start-value": 0,
      "end-value": 0
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "range": {
      "start-value": 0,
      "end-value": 0
    }
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:parameter-pool xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:range>
    <project-nsd:start-value>0</project-nsd:start-value>
    <project-nsd:end-value>0</project-nsd:end-value>
  </project-nsd:range>
</project-nsd:parameter-pool>

XML Sample

<project-nsd:parameter-pool xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:range>
    <project-nsd:start-value>0</project-nsd:start-value>
    <project-nsd:end-value>0</project-nsd:end-value>
  </project-nsd:range>
</project-nsd:parameter-pool>

project-nsd:range

Create a range of values to populate the pool with

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:parameter-pool/project-nsd:range

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:parameter-pool[project-nsd:name='STRING']/project-nsd:range

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/parameter-pool/STRING/range

Fields

Name	Type	Description
start-value	UINT32	Generated pool values start at this value
end-value	UINT32	Generated pool values stop at this value

JSON Config Sample

{
  "start-value": 0,
  "end-value": 0
}

JSON Sample

{
  "start-value": 0,
  "end-value": 0
}

XML Config Sample

<project-nsd:range xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:start-value>0</project-nsd:start-value>
  <project-nsd:end-value>0</project-nsd:end-value>
</project-nsd:range>

XML Sample

<project-nsd:range xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:start-value>0</project-nsd:start-value>
  <project-nsd:end-value>0</project-nsd:end-value>
</project-nsd:range>

project-nsd:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:key-pair

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:key-pair[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Config Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:key-pair xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:key>STRING</project-nsd:key>
</project-nsd:key-pair>

XML Sample

<project-nsd:key-pair xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:key>STRING</project-nsd:key>
</project-nsd:key-pair>

project-nsd:user

List of users to be added through cloud-config

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:user

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:user[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/user/STRING

Fields

Name	Type	Description
name	STRING	Name of the user
user-info	STRING	The user name's real name
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation

JSON Config Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:user xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:user-info>STRING</project-nsd:user-info>
  <project-nsd:key-pair>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:key>STRING</project-nsd:key>
  </project-nsd:key-pair>
</project-nsd:user>

XML Sample

<project-nsd:user xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:user-info>STRING</project-nsd:user-info>
  <project-nsd:key-pair>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:key>STRING</project-nsd:key>
  </project-nsd:key-pair>
</project-nsd:user>

project-nsd:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:user/project-nsd:key-pair

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:user[project-nsd:name='STRING']/project-nsd:key-pair[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/user/STRING/key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Config Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:key-pair xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:key>STRING</project-nsd:key>
</project-nsd:key-pair>

XML Sample

<project-nsd:key-pair xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:key>STRING</project-nsd:key>
</project-nsd:key-pair>

project-nsd:vld

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vld/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VLD.
name	STRING	Virtual Link Descriptor (VLD) name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Provider of the VLD.
description	STRING	Description of the VLD.
version	STRING	Version of the VLD
type	ENUM
root-bandwidth	UINT64	For ELAN this is the aggregate bandwidth.
leaf-bandwidth	UINT64	For ELAN this is the bandwidth of branches.
provider-network	CONTAINER	Container for the provider network.
mgmt-network	BOOLEAN	Flag indicating whether this network is a VIM management 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	LEAFREF	Named reference to IP-profile object
vnfd-connection-point-ref	LIST	A list of references to connection points.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "provider-network": {
      "physical-network": "STRING",
      "segmentation_id": 0
    },
    "mgmt-network": false,
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "provider-network": {
      "physical-network": "STRING",
      "segmentation_id": 0
    },
    "mgmt-network": false,
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:vld xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:short-name>STRING</project-nsd:short-name>
  <project-nsd:vendor>STRING</project-nsd:vendor>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:version>STRING</project-nsd:version>
  <project-nsd:type>ELAN</project-nsd:type>
  <project-nsd:root-bandwidth>0</project-nsd:root-bandwidth>
  <project-nsd:leaf-bandwidth>0</project-nsd:leaf-bandwidth>
  <project-nsd:provider-network>
    <project-nsd:physical-network>STRING</project-nsd:physical-network>
    <project-nsd:segmentation_id>0</project-nsd:segmentation_id>
  </project-nsd:provider-network>
  <project-nsd:mgmt-network>false</project-nsd:mgmt-network>
  <project-nsd:vim-network-name>STRING</project-nsd:vim-network-name>
  <project-nsd:ip-profile-ref>STRING</project-nsd:ip-profile-ref>
  <project-nsd:vnfd-connection-point-ref>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  </project-nsd:vnfd-connection-point-ref>
</project-nsd:vld>

XML Sample

<project-nsd:vld xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:short-name>STRING</project-nsd:short-name>
  <project-nsd:vendor>STRING</project-nsd:vendor>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:version>STRING</project-nsd:version>
  <project-nsd:type>ELAN</project-nsd:type>
  <project-nsd:root-bandwidth>0</project-nsd:root-bandwidth>
  <project-nsd:leaf-bandwidth>0</project-nsd:leaf-bandwidth>
  <project-nsd:provider-network>
    <project-nsd:physical-network>STRING</project-nsd:physical-network>
    <project-nsd:segmentation_id>0</project-nsd:segmentation_id>
  </project-nsd:provider-network>
  <project-nsd:mgmt-network>false</project-nsd:mgmt-network>
  <project-nsd:vim-network-name>STRING</project-nsd:vim-network-name>
  <project-nsd:ip-profile-ref>STRING</project-nsd:ip-profile-ref>
  <project-nsd:vnfd-connection-point-ref>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  </project-nsd:vnfd-connection-point-ref>
</project-nsd:vld>

project-nsd:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/project-nsd:provider-network

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/project-nsd:provider-network

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/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

{
  "physical-network": "STRING",
  "segmentation_id": 0
}

JSON Sample

{
  "physical-network": "STRING",
  "segmentation_id": 0
}

XML Config Sample

<project-nsd:provider-network xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:physical-network>STRING</project-nsd:physical-network>
  <project-nsd:segmentation_id>0</project-nsd:segmentation_id>
</project-nsd:provider-network>

XML Sample

<project-nsd:provider-network xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:physical-network>STRING</project-nsd:physical-network>
  <project-nsd:segmentation_id>0</project-nsd:segmentation_id>
</project-nsd:provider-network>

project-nsd:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vld/project-nsd:vnfd-connection-point-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vld[project-nsd:id='STRING']/project-nsd:vnfd-connection-point-ref[project-nsd:member-vnf-index-ref='0'][project-nsd:vnfd-connection-point-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vld/STRING/vnfd-connection-point-ref/0,STRING

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref to path: ../../constituent-vnfd + [id = current()/../id-ref] + /vnfd-id-ref NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
vnfd-connection-point-ref	LEAFREF	A reference to a connection point name

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:vnfd-connection-point-ref xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
</project-nsd:vnfd-connection-point-ref>

XML Sample

<project-nsd:vnfd-connection-point-ref xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-connection-point-ref>STRING</project-nsd:vnfd-connection-point-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
</project-nsd:vnfd-connection-point-ref>

project-nsd:constituent-vnfd

List of VNFDs that are part of this network service.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:constituent-vnfd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:constituent-vnfd[project-nsd:member-vnf-index='0']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/constituent-vnfd/0

Fields

Name	Type	Description
member-vnf-index	UINT64	Identifier/index for the VNFD. This separate id is required to ensure that multiple VNFs can be part of single NS
vnfd-id-ref	LEAFREF	Identifier for the VNFD.
start-by-default	BOOLEAN	VNFD is started as part of the NS instantiation

JSON Config Sample

[
  {
    "member-vnf-index": 0,
    "vnfd-id-ref": "STRING",
    "start-by-default": true
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index": 0,
    "vnfd-id-ref": "STRING",
    "start-by-default": true
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:constituent-vnfd xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index>0</project-nsd:member-vnf-index>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  <project-nsd:start-by-default>true</project-nsd:start-by-default>
</project-nsd:constituent-vnfd>

XML Sample

<project-nsd:constituent-vnfd xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index>0</project-nsd:member-vnf-index>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  <project-nsd:start-by-default>true</project-nsd:start-by-default>
</project-nsd:constituent-vnfd>

project-nsd:placement-groups

List of placement groups at NS level

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:placement-groups

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:placement-groups[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/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-vnfd	LIST	List of VNFDs that are part of this placement group

JSON Config Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vnfd": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vnfd": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:placement-groups xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:requirement>STRING</project-nsd:requirement>
  <project-nsd:strategy>COLOCATION</project-nsd:strategy>
  <project-nsd:member-vnfd>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  </project-nsd:member-vnfd>
</project-nsd:placement-groups>

XML Sample

<project-nsd:placement-groups xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:requirement>STRING</project-nsd:requirement>
  <project-nsd:strategy>COLOCATION</project-nsd:strategy>
  <project-nsd:member-vnfd>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  </project-nsd:member-vnfd>
</project-nsd:placement-groups>

project-nsd:member-vnfd

List of VNFDs that are part of this placement group

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:placement-groups/project-nsd:member-vnfd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:placement-groups[project-nsd:name='STRING']/project-nsd:member-vnfd[project-nsd:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/placement-groups/STRING/member-vnfd/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	member VNF index of this member VNF
vnfd-id-ref	LEAFREF	Identifier for the VNFD.

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:member-vnfd xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
</project-nsd:member-vnfd>

XML Sample

<project-nsd:member-vnfd xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
</project-nsd:member-vnfd>

project-nsd:vnf-dependency

List of VNF dependencies.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:vnf-dependency

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:vnf-dependency[project-nsd:vnf-source-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/vnf-dependency/STRING

Fields

Name	Type	Description
vnf-source-ref	LEAFREF
vnf-depends-on-ref	LEAFREF	Reference to VNF that sorce VNF depends.

JSON Config Sample

[
  {
    "vnf-source-ref": "STRING",
    "vnf-depends-on-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnf-source-ref": "STRING",
    "vnf-depends-on-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:vnf-dependency xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:vnf-source-ref>STRING</project-nsd:vnf-source-ref>
  <project-nsd:vnf-depends-on-ref>STRING</project-nsd:vnf-depends-on-ref>
</project-nsd:vnf-dependency>

XML Sample

<project-nsd:vnf-dependency xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:vnf-source-ref>STRING</project-nsd:vnf-source-ref>
  <project-nsd:vnf-depends-on-ref>STRING</project-nsd:vnf-depends-on-ref>
</project-nsd:vnf-dependency>

project-nsd:monitoring-param

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING

Fields

Name	Type	Description
id	STRING
name	STRING
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
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.)
aggregation-type	ENUM
vnfd-monitoring-param	LIST	A list of VNFD monitoring params

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "aggregation-type": "AVERAGE",
    "vnfd-monitoring-param": [
      {
        "vnfd-id-ref": "STRING",
        "vnfd-monitoring-param-ref": "STRING",
        "member-vnf-index-ref": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "aggregation-type": "AVERAGE",
    "vnfd-monitoring-param": [
      {
        "vnfd-id-ref": "STRING",
        "vnfd-monitoring-param-ref": "STRING",
        "member-vnf-index-ref": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:monitoring-param xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:value-type>INT</project-nsd:value-type>
  <project-nsd:numeric-constraints>
    <project-nsd:min-value>0</project-nsd:min-value>
    <project-nsd:max-value>0</project-nsd:max-value>
  </project-nsd:numeric-constraints>
  <project-nsd:text-constraints>
    <project-nsd:min-length>0</project-nsd:min-length>
    <project-nsd:max-length>0</project-nsd:max-length>
  </project-nsd:text-constraints>
  <project-nsd:value-integer>0</project-nsd:value-integer>
  <project-nsd:value-decimal>0.0</project-nsd:value-decimal>
  <project-nsd:value-string>STRING</project-nsd:value-string>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:group-tag>STRING</project-nsd:group-tag>
  <project-nsd:widget-type>COUNTER</project-nsd:widget-type>
  <project-nsd:units>STRING</project-nsd:units>
  <project-nsd:aggregation-type>AVERAGE</project-nsd:aggregation-type>
  <project-nsd:vnfd-monitoring-param>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-monitoring-param-ref>STRING</project-nsd:vnfd-monitoring-param-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  </project-nsd:vnfd-monitoring-param>
</project-nsd:monitoring-param>

XML Sample

<project-nsd:monitoring-param xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:id>STRING</project-nsd:id>
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:value-type>INT</project-nsd:value-type>
  <project-nsd:numeric-constraints>
    <project-nsd:min-value>0</project-nsd:min-value>
    <project-nsd:max-value>0</project-nsd:max-value>
  </project-nsd:numeric-constraints>
  <project-nsd:text-constraints>
    <project-nsd:min-length>0</project-nsd:min-length>
    <project-nsd:max-length>0</project-nsd:max-length>
  </project-nsd:text-constraints>
  <project-nsd:value-integer>0</project-nsd:value-integer>
  <project-nsd:value-decimal>0.0</project-nsd:value-decimal>
  <project-nsd:value-string>STRING</project-nsd:value-string>
  <project-nsd:description>STRING</project-nsd:description>
  <project-nsd:group-tag>STRING</project-nsd:group-tag>
  <project-nsd:widget-type>COUNTER</project-nsd:widget-type>
  <project-nsd:units>STRING</project-nsd:units>
  <project-nsd:aggregation-type>AVERAGE</project-nsd:aggregation-type>
  <project-nsd:vnfd-monitoring-param>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-monitoring-param-ref>STRING</project-nsd:vnfd-monitoring-param-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  </project-nsd:vnfd-monitoring-param>
</project-nsd:monitoring-param>

project-nsd:numeric-constraints

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:numeric-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:numeric-constraints

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/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

{
  "min-value": 0,
  "max-value": 0
}

JSON Sample

{
  "min-value": 0,
  "max-value": 0
}

XML Config Sample

<project-nsd:numeric-constraints xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:min-value>0</project-nsd:min-value>
  <project-nsd:max-value>0</project-nsd:max-value>
</project-nsd:numeric-constraints>

XML Sample

<project-nsd:numeric-constraints xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:min-value>0</project-nsd:min-value>
  <project-nsd:max-value>0</project-nsd:max-value>
</project-nsd:numeric-constraints>

project-nsd:text-constraints

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:text-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:text-constraints

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/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

{
  "min-length": 0,
  "max-length": 0
}

JSON Sample

{
  "min-length": 0,
  "max-length": 0
}

XML Config Sample

<project-nsd:text-constraints xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:min-length>0</project-nsd:min-length>
  <project-nsd:max-length>0</project-nsd:max-length>
</project-nsd:text-constraints>

XML Sample

<project-nsd:text-constraints xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:min-length>0</project-nsd:min-length>
  <project-nsd:max-length>0</project-nsd:max-length>
</project-nsd:text-constraints>

project-nsd:vnfd-monitoring-param

A list of VNFD monitoring params

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:monitoring-param/project-nsd:vnfd-monitoring-param

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:monitoring-param[project-nsd:id='STRING']/project-nsd:vnfd-monitoring-param[project-nsd:member-vnf-index-ref='0'][project-nsd:vnfd-monitoring-param-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/vnfd-monitoring-param/0,STRING

Fields

Name	Type	Description
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
vnfd-monitoring-param-ref	LEAFREF	A reference to the VNFD monitoring param
member-vnf-index-ref	LEAFREF	Optional reference to member-vnf within constituent-vnfds

JSON Config Sample

[
  {
    "vnfd-id-ref": "STRING",
    "vnfd-monitoring-param-ref": "STRING",
    "member-vnf-index-ref": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfd-id-ref": "STRING",
    "vnfd-monitoring-param-ref": "STRING",
    "member-vnf-index-ref": 0
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:vnfd-monitoring-param xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-monitoring-param-ref>STRING</project-nsd:vnfd-monitoring-param-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
</project-nsd:vnfd-monitoring-param>

XML Sample

<project-nsd:vnfd-monitoring-param xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-monitoring-param-ref>STRING</project-nsd:vnfd-monitoring-param-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
</project-nsd:vnfd-monitoring-param>

project-nsd:service-primitive

Network service level service primitives.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING

Fields

Name	Type	Description
name	STRING	Name of the service primitive.
parameter	LIST	List of parameters for the service primitive.
parameter-group	LIST	Grouping of parameters which are logically grouped in UI
vnf-primitive-group	LIST	List of service primitives grouped by VNF.
user-defined-script	STRING	A user defined script.

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "mandatory": true
      }, {
        ...
      }
    ],
    "vnf-primitive-group": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-name": "STRING",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "mandatory": true
      }, {
        ...
      }
    ],
    "vnf-primitive-group": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-name": "STRING",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:service-primitive xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:parameter>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:data-type>STRING</project-nsd:data-type>
    <project-nsd:mandatory>false</project-nsd:mandatory>
    <project-nsd:default-value>STRING</project-nsd:default-value>
    <project-nsd:parameter-pool>STRING</project-nsd:parameter-pool>
    <project-nsd:read-only>false</project-nsd:read-only>
    <project-nsd:hidden>false</project-nsd:hidden>
  </project-nsd:parameter>
  <project-nsd:parameter-group>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:parameter>...</project-nsd:parameter>
    <project-nsd:mandatory>true</project-nsd:mandatory>
  </project-nsd:parameter-group>
  <project-nsd:vnf-primitive-group>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
    <project-nsd:vnfd-name>STRING</project-nsd:vnfd-name>
    <project-nsd:primitive>...</project-nsd:primitive>
  </project-nsd:vnf-primitive-group>
  <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
</project-nsd:service-primitive>

XML Sample

<project-nsd:service-primitive xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:parameter>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:data-type>STRING</project-nsd:data-type>
    <project-nsd:mandatory>false</project-nsd:mandatory>
    <project-nsd:default-value>STRING</project-nsd:default-value>
    <project-nsd:parameter-pool>STRING</project-nsd:parameter-pool>
    <project-nsd:read-only>false</project-nsd:read-only>
    <project-nsd:hidden>false</project-nsd:hidden>
  </project-nsd:parameter>
  <project-nsd:parameter-group>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:parameter>...</project-nsd:parameter>
    <project-nsd:mandatory>true</project-nsd:mandatory>
  </project-nsd:parameter-group>
  <project-nsd:vnf-primitive-group>
    <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
    <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
    <project-nsd:vnfd-name>STRING</project-nsd:vnfd-name>
    <project-nsd:primitive>...</project-nsd:primitive>
  </project-nsd:vnf-primitive-group>
  <project-nsd:user-defined-script>STRING</project-nsd:user-defined-script>
</project-nsd:service-primitive>

project-nsd:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-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

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:parameter xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:data-type>STRING</project-nsd:data-type>
  <project-nsd:mandatory>false</project-nsd:mandatory>
  <project-nsd:default-value>STRING</project-nsd:default-value>
  <project-nsd:parameter-pool>STRING</project-nsd:parameter-pool>
  <project-nsd:read-only>false</project-nsd:read-only>
  <project-nsd:hidden>false</project-nsd:hidden>
</project-nsd:parameter>

XML Sample

<project-nsd:parameter xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:data-type>STRING</project-nsd:data-type>
  <project-nsd:mandatory>false</project-nsd:mandatory>
  <project-nsd:default-value>STRING</project-nsd:default-value>
  <project-nsd:parameter-pool>STRING</project-nsd:parameter-pool>
  <project-nsd:read-only>false</project-nsd:read-only>
  <project-nsd:hidden>false</project-nsd:hidden>
</project-nsd:parameter>

project-nsd:parameter-group

Grouping of parameters which are logically grouped in UI

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter-group[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter group
parameter	LIST	List of parameters for the service primitive.
mandatory	BOOLEAN	Is this parameter group mandatory

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "mandatory": true
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "mandatory": true
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:parameter-group xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:parameter>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:data-type>STRING</project-nsd:data-type>
    <project-nsd:mandatory>false</project-nsd:mandatory>
    <project-nsd:default-value>STRING</project-nsd:default-value>
    <project-nsd:parameter-pool>STRING</project-nsd:parameter-pool>
    <project-nsd:read-only>false</project-nsd:read-only>
    <project-nsd:hidden>false</project-nsd:hidden>
  </project-nsd:parameter>
  <project-nsd:mandatory>true</project-nsd:mandatory>
</project-nsd:parameter-group>

XML Sample

<project-nsd:parameter-group xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:parameter>
    <project-nsd:name>STRING</project-nsd:name>
    <project-nsd:data-type>STRING</project-nsd:data-type>
    <project-nsd:mandatory>false</project-nsd:mandatory>
    <project-nsd:default-value>STRING</project-nsd:default-value>
    <project-nsd:parameter-pool>STRING</project-nsd:parameter-pool>
    <project-nsd:read-only>false</project-nsd:read-only>
    <project-nsd:hidden>false</project-nsd:hidden>
  </project-nsd:parameter>
  <project-nsd:mandatory>true</project-nsd:mandatory>
</project-nsd:parameter-group>

project-nsd:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:parameter-group/project-nsd:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:parameter-group[project-nsd:name='STRING']/project-nsd:parameter[project-nsd:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter-group/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

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:parameter xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:data-type>STRING</project-nsd:data-type>
  <project-nsd:mandatory>false</project-nsd:mandatory>
  <project-nsd:default-value>STRING</project-nsd:default-value>
  <project-nsd:parameter-pool>STRING</project-nsd:parameter-pool>
  <project-nsd:read-only>false</project-nsd:read-only>
  <project-nsd:hidden>false</project-nsd:hidden>
</project-nsd:parameter>

XML Sample

<project-nsd:parameter xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:name>STRING</project-nsd:name>
  <project-nsd:data-type>STRING</project-nsd:data-type>
  <project-nsd:mandatory>false</project-nsd:mandatory>
  <project-nsd:default-value>STRING</project-nsd:default-value>
  <project-nsd:parameter-pool>STRING</project-nsd:parameter-pool>
  <project-nsd:read-only>false</project-nsd:read-only>
  <project-nsd:hidden>false</project-nsd:hidden>
</project-nsd:parameter>

project-nsd:vnf-primitive-group

List of service primitives grouped by VNF.

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:vnf-primitive-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:vnf-primitive-group[project-nsd:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/vnf-primitive-group/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref
vnfd-name	LEAFREF	Name of the VNFD
primitive	LIST

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-name": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-name": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:vnf-primitive-group xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  <project-nsd:vnfd-name>STRING</project-nsd:vnfd-name>
  <project-nsd:primitive>
    <project-nsd:index>0</project-nsd:index>
    <project-nsd:name>STRING</project-nsd:name>
  </project-nsd:primitive>
</project-nsd:vnf-primitive-group>

XML Sample

<project-nsd:vnf-primitive-group xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:member-vnf-index-ref>0</project-nsd:member-vnf-index-ref>
  <project-nsd:vnfd-id-ref>STRING</project-nsd:vnfd-id-ref>
  <project-nsd:vnfd-name>STRING</project-nsd:vnfd-name>
  <project-nsd:primitive>
    <project-nsd:index>0</project-nsd:index>
    <project-nsd:name>STRING</project-nsd:name>
  </project-nsd:primitive>
</project-nsd:vnf-primitive-group>

project-nsd:primitive

Key Identifiers:

XPath Path

/rw-project:project/project-nsd:nsd-catalog/project-nsd:nsd/project-nsd:service-primitive/project-nsd:vnf-primitive-group/project-nsd:primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/project-nsd:nsd-catalog/project-nsd:nsd[project-nsd:id='STRING']/project-nsd:service-primitive[project-nsd:name='STRING']/project-nsd:vnf-primitive-group[project-nsd:member-vnf-index-ref='0']/project-nsd:primitive[project-nsd:index='0']

RW.REST URI Path

/rw-project:project/STRING/project-nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/vnf-primitive-group/0/primitive/0

Fields

Name	Type	Description
index	UINT32	Index of this primitive
name	STRING	Name of the primitive in the VNF primitive

JSON Config Sample

[
  {
    "index": 0,
    "name": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "index": 0,
    "name": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-nsd:primitive xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:index>0</project-nsd:index>
  <project-nsd:name>STRING</project-nsd:name>
</project-nsd:primitive>

XML Sample

<project-nsd:primitive xmlns:project-nsd="http://riftio.com/ns/riftware-1.0/project-nsd">
  <project-nsd:index>0</project-nsd:index>
  <project-nsd:name>STRING</project-nsd:name>
</project-nsd:primitive>

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

{
  "vnfd": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "vnf-configuration": { ... },
      "operational-status": "init",
      "mgmt-interface": { ... },
      "internal-vld": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "connection-point": [ { ... }, { ... } ],
      "vdu": [ { ... }, { ... } ],
      "vdu-dependency": [ { ... }, { ... } ],
      "service-function-chain": "UNAWARE",
      "service-function-type": "STRING",
      "http-endpoint": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "vnfd": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "vnf-configuration": { ... },
      "operational-status": "init",
      "mgmt-interface": { ... },
      "internal-vld": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "connection-point": [ { ... }, { ... } ],
      "vdu": [ { ... }, { ... } ],
      "vdu-dependency": [ { ... }, { ... } ],
      "service-function-chain": "UNAWARE",
      "service-function-type": "STRING",
      "http-endpoint": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:vnfd-catalog xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:vnfd>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:short-name>STRING</project-vnfd:short-name>
    <project-vnfd:vendor>STRING</project-vnfd:vendor>
    <project-vnfd:logo>STRING</project-vnfd:logo>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:version>STRING</project-vnfd:version>
    <project-vnfd:vnf-configuration>...</project-vnfd:vnf-configuration>
    <project-vnfd:operational-status>init</project-vnfd:operational-status>
    <project-vnfd:mgmt-interface>...</project-vnfd:mgmt-interface>
    <project-vnfd:internal-vld>...</project-vnfd:internal-vld>
    <project-vnfd:ip-profiles>...</project-vnfd:ip-profiles>
    <project-vnfd:connection-point>...</project-vnfd:connection-point>
    <project-vnfd:vdu>...</project-vnfd:vdu>
    <project-vnfd:vdu-dependency>...</project-vnfd:vdu-dependency>
    <project-vnfd:service-function-chain>UNAWARE</project-vnfd:service-function-chain>
    <project-vnfd:service-function-type>STRING</project-vnfd:service-function-type>
    <project-vnfd:http-endpoint>...</project-vnfd:http-endpoint>
    <project-vnfd:monitoring-param>...</project-vnfd:monitoring-param>
    <project-vnfd:placement-groups>...</project-vnfd:placement-groups>
  </project-vnfd:vnfd>
</project-vnfd:vnfd-catalog>

XML Sample

<project-vnfd:vnfd-catalog xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:vnfd>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:short-name>STRING</project-vnfd:short-name>
    <project-vnfd:vendor>STRING</project-vnfd:vendor>
    <project-vnfd:logo>STRING</project-vnfd:logo>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:version>STRING</project-vnfd:version>
    <project-vnfd:vnf-configuration>...</project-vnfd:vnf-configuration>
    <project-vnfd:operational-status>init</project-vnfd:operational-status>
    <project-vnfd:mgmt-interface>...</project-vnfd:mgmt-interface>
    <project-vnfd:internal-vld>...</project-vnfd:internal-vld>
    <project-vnfd:ip-profiles>...</project-vnfd:ip-profiles>
    <project-vnfd:connection-point>...</project-vnfd:connection-point>
    <project-vnfd:vdu>...</project-vnfd:vdu>
    <project-vnfd:vdu-dependency>...</project-vnfd:vdu-dependency>
    <project-vnfd:service-function-chain>UNAWARE</project-vnfd:service-function-chain>
    <project-vnfd:service-function-type>STRING</project-vnfd:service-function-type>
    <project-vnfd:http-endpoint>...</project-vnfd:http-endpoint>
    <project-vnfd:monitoring-param>...</project-vnfd:monitoring-param>
    <project-vnfd:placement-groups>...</project-vnfd:placement-groups>
  </project-vnfd:vnfd>
</project-vnfd:vnfd-catalog>

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

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "logo": "STRING",
    "description": "STRING",
    "version": "STRING",
    "vnf-configuration": {
      "script": { ... },
      "juju": { ... },
      "config-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ]
    },
    "operational-status": "init",
    "mgmt-interface": {
      "ip-address": "UNION_VALUE",
      "vdu-id": "STRING",
      "cp": "STRING",
      "port": 0,
      "dashboard-params": { ... }
    },
    "internal-vld": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "description": "STRING",
        "type": "ELAN",
        "root-bandwidth": 0,
        "leaf-bandwidth": 0,
        "internal-connection-point": [ { ... }, { ... } ],
        "provider-network": { ... },
        "vim-network-name": "STRING",
        "ip-profile-ref": "STRING"
      }, {
        ...
      }
    ],
    "ip-profiles": [
      {
        "name": "STRING",
        "description": "STRING",
        "ip-profile-params": { ... }
      }, {
        ...
      }
    ],
    "connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true
      }, {
        ...
      }
    ],
    "vdu": [
      {
        "id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "count": 0,
        "mgmt-vpci": "STRING",
        "vm-flavor": { ... },
        "guest-epa": { ... },
        "vswitch-epa": { ... },
        "hypervisor-epa": { ... },
        "host-epa": { ... },
        "alarm": [ { ... }, { ... } ],
        "image": "STRING",
        "image-checksum": "STRING",
        "alternative-images": [ { ... }, { ... } ],
        "vdu-configuration": { ... },
        "cloud-init": "STRING",
        "cloud-init-file": "STRING",
        "supplemental-boot-data": { ... },
        "internal-connection-point": [ { ... }, { ... } ],
        "interface": [ { ... }, { ... } ],
        "volumes": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vdu-dependency": [
      {
        "vdu-source-ref": "STRING",
        "vdu-depends-on-ref": "STRING"
      }, {
        ...
      }
    ],
    "service-function-chain": "UNAWARE",
    "service-function-type": "STRING",
    "http-endpoint": [
      {
        "path": "STRING",
        "https": false,
        "port": 0,
        "username": "STRING",
        "password": "STRING",
        "polling-interval-secs": 2,
        "method": "GET",
        "headers": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "http-endpoint-ref": "STRING",
        "json-query-method": "NAMEKEY",
        "json-query-params": { ... },
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "COUNTER",
        "units": "STRING",
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING"
      }, {
        ...
      }
    ],
    "placement-groups": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "member-vdus": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "logo": "STRING",
    "description": "STRING",
    "version": "STRING",
    "vnf-configuration": {
      "script": { ... },
      "juju": { ... },
      "config-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ]
    },
    "operational-status": "init",
    "mgmt-interface": {
      "ip-address": "UNION_VALUE",
      "vdu-id": "STRING",
      "cp": "STRING",
      "port": 0,
      "dashboard-params": { ... }
    },
    "internal-vld": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "description": "STRING",
        "type": "ELAN",
        "root-bandwidth": 0,
        "leaf-bandwidth": 0,
        "internal-connection-point": [ { ... }, { ... } ],
        "provider-network": { ... },
        "vim-network-name": "STRING",
        "ip-profile-ref": "STRING"
      }, {
        ...
      }
    ],
    "ip-profiles": [
      {
        "name": "STRING",
        "description": "STRING",
        "ip-profile-params": { ... }
      }, {
        ...
      }
    ],
    "connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true
      }, {
        ...
      }
    ],
    "vdu": [
      {
        "id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "count": 0,
        "mgmt-vpci": "STRING",
        "vm-flavor": { ... },
        "guest-epa": { ... },
        "vswitch-epa": { ... },
        "hypervisor-epa": { ... },
        "host-epa": { ... },
        "alarm": [ { ... }, { ... } ],
        "image": "STRING",
        "image-checksum": "STRING",
        "alternative-images": [ { ... }, { ... } ],
        "vdu-configuration": { ... },
        "cloud-init": "STRING",
        "cloud-init-file": "STRING",
        "supplemental-boot-data": { ... },
        "internal-connection-point": [ { ... }, { ... } ],
        "interface": [ { ... }, { ... } ],
        "volumes": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vdu-dependency": [
      {
        "vdu-source-ref": "STRING",
        "vdu-depends-on-ref": "STRING"
      }, {
        ...
      }
    ],
    "service-function-chain": "UNAWARE",
    "service-function-type": "STRING",
    "http-endpoint": [
      {
        "path": "STRING",
        "https": false,
        "port": 0,
        "username": "STRING",
        "password": "STRING",
        "polling-interval-secs": 2,
        "method": "GET",
        "headers": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "http-endpoint-ref": "STRING",
        "json-query-method": "NAMEKEY",
        "json-query-params": { ... },
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "COUNTER",
        "units": "STRING",
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING"
      }, {
        ...
      }
    ],
    "placement-groups": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "member-vdus": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:vnfd xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:short-name>STRING</project-vnfd:short-name>
  <project-vnfd:vendor>STRING</project-vnfd:vendor>
  <project-vnfd:logo>STRING</project-vnfd:logo>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:version>STRING</project-vnfd:version>
  <project-vnfd:vnf-configuration>
    <project-vnfd:script>...</project-vnfd:script>
    <project-vnfd:juju>...</project-vnfd:juju>
    <project-vnfd:config-primitive>...</project-vnfd:config-primitive>
    <project-vnfd:initial-config-primitive>...</project-vnfd:initial-config-primitive>
  </project-vnfd:vnf-configuration>
  <project-vnfd:operational-status>init</project-vnfd:operational-status>
  <project-vnfd:mgmt-interface>
    <project-vnfd:ip-address>UNION_VALUE</project-vnfd:ip-address>
    <project-vnfd:vdu-id>STRING</project-vnfd:vdu-id>
    <project-vnfd:cp>STRING</project-vnfd:cp>
    <project-vnfd:port>0</project-vnfd:port>
    <project-vnfd:dashboard-params>...</project-vnfd:dashboard-params>
  </project-vnfd:mgmt-interface>
  <project-vnfd:internal-vld>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:short-name>STRING</project-vnfd:short-name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:type>ELAN</project-vnfd:type>
    <project-vnfd:root-bandwidth>0</project-vnfd:root-bandwidth>
    <project-vnfd:leaf-bandwidth>0</project-vnfd:leaf-bandwidth>
    <project-vnfd:internal-connection-point>...</project-vnfd:internal-connection-point>
    <project-vnfd:provider-network>...</project-vnfd:provider-network>
    <project-vnfd:vim-network-name>STRING</project-vnfd:vim-network-name>
    <project-vnfd:ip-profile-ref>STRING</project-vnfd:ip-profile-ref>
  </project-vnfd:internal-vld>
  <project-vnfd:ip-profiles>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:ip-profile-params>...</project-vnfd:ip-profile-params>
  </project-vnfd:ip-profiles>
  <project-vnfd:connection-point>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:short-name>STRING</project-vnfd:short-name>
    <project-vnfd:type>VPORT</project-vnfd:type>
    <project-vnfd:port-security-enabled>true</project-vnfd:port-security-enabled>
  </project-vnfd:connection-point>
  <project-vnfd:vdu>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:count>0</project-vnfd:count>
    <project-vnfd:mgmt-vpci>STRING</project-vnfd:mgmt-vpci>
    <project-vnfd:vm-flavor>...</project-vnfd:vm-flavor>
    <project-vnfd:guest-epa>...</project-vnfd:guest-epa>
    <project-vnfd:vswitch-epa>...</project-vnfd:vswitch-epa>
    <project-vnfd:hypervisor-epa>...</project-vnfd:hypervisor-epa>
    <project-vnfd:host-epa>...</project-vnfd:host-epa>
    <project-vnfd:alarm>...</project-vnfd:alarm>
    <project-vnfd:image>STRING</project-vnfd:image>
    <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
    <project-vnfd:alternative-images>...</project-vnfd:alternative-images>
    <project-vnfd:vdu-configuration>...</project-vnfd:vdu-configuration>
    <project-vnfd:cloud-init>STRING</project-vnfd:cloud-init>
    <project-vnfd:cloud-init-file>STRING</project-vnfd:cloud-init-file>
    <project-vnfd:supplemental-boot-data>...</project-vnfd:supplemental-boot-data>
    <project-vnfd:internal-connection-point>...</project-vnfd:internal-connection-point>
    <project-vnfd:interface>...</project-vnfd:interface>
    <project-vnfd:volumes>...</project-vnfd:volumes>
  </project-vnfd:vdu>
  <project-vnfd:vdu-dependency>
    <project-vnfd:vdu-source-ref>STRING</project-vnfd:vdu-source-ref>
    <project-vnfd:vdu-depends-on-ref>STRING</project-vnfd:vdu-depends-on-ref>
  </project-vnfd:vdu-dependency>
  <project-vnfd:service-function-chain>UNAWARE</project-vnfd:service-function-chain>
  <project-vnfd:service-function-type>STRING</project-vnfd:service-function-type>
  <project-vnfd:http-endpoint>
    <project-vnfd:path>STRING</project-vnfd:path>
    <project-vnfd:https>false</project-vnfd:https>
    <project-vnfd:port>0</project-vnfd:port>
    <project-vnfd:username>STRING</project-vnfd:username>
    <project-vnfd:password>STRING</project-vnfd:password>
    <project-vnfd:polling-interval-secs>2</project-vnfd:polling-interval-secs>
    <project-vnfd:method>GET</project-vnfd:method>
    <project-vnfd:headers>...</project-vnfd:headers>
  </project-vnfd:http-endpoint>
  <project-vnfd:monitoring-param>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:http-endpoint-ref>STRING</project-vnfd:http-endpoint-ref>
    <project-vnfd:json-query-method>NAMEKEY</project-vnfd:json-query-method>
    <project-vnfd:json-query-params>...</project-vnfd:json-query-params>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:group-tag>STRING</project-vnfd:group-tag>
    <project-vnfd:widget-type>COUNTER</project-vnfd:widget-type>
    <project-vnfd:units>STRING</project-vnfd:units>
    <project-vnfd:value-type>INT</project-vnfd:value-type>
    <project-vnfd:numeric-constraints>...</project-vnfd:numeric-constraints>
    <project-vnfd:text-constraints>...</project-vnfd:text-constraints>
    <project-vnfd:value-integer>0</project-vnfd:value-integer>
    <project-vnfd:value-decimal>0.0</project-vnfd:value-decimal>
    <project-vnfd:value-string>STRING</project-vnfd:value-string>
  </project-vnfd:monitoring-param>
  <project-vnfd:placement-groups>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:requirement>STRING</project-vnfd:requirement>
    <project-vnfd:strategy>COLOCATION</project-vnfd:strategy>
    <project-vnfd:member-vdus>...</project-vnfd:member-vdus>
  </project-vnfd:placement-groups>
</project-vnfd:vnfd>

XML Sample

<project-vnfd:vnfd xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:short-name>STRING</project-vnfd:short-name>
  <project-vnfd:vendor>STRING</project-vnfd:vendor>
  <project-vnfd:logo>STRING</project-vnfd:logo>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:version>STRING</project-vnfd:version>
  <project-vnfd:vnf-configuration>
    <project-vnfd:script>...</project-vnfd:script>
    <project-vnfd:juju>...</project-vnfd:juju>
    <project-vnfd:config-primitive>...</project-vnfd:config-primitive>
    <project-vnfd:initial-config-primitive>...</project-vnfd:initial-config-primitive>
  </project-vnfd:vnf-configuration>
  <project-vnfd:operational-status>init</project-vnfd:operational-status>
  <project-vnfd:mgmt-interface>
    <project-vnfd:ip-address>UNION_VALUE</project-vnfd:ip-address>
    <project-vnfd:vdu-id>STRING</project-vnfd:vdu-id>
    <project-vnfd:cp>STRING</project-vnfd:cp>
    <project-vnfd:port>0</project-vnfd:port>
    <project-vnfd:dashboard-params>...</project-vnfd:dashboard-params>
  </project-vnfd:mgmt-interface>
  <project-vnfd:internal-vld>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:short-name>STRING</project-vnfd:short-name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:type>ELAN</project-vnfd:type>
    <project-vnfd:root-bandwidth>0</project-vnfd:root-bandwidth>
    <project-vnfd:leaf-bandwidth>0</project-vnfd:leaf-bandwidth>
    <project-vnfd:internal-connection-point>...</project-vnfd:internal-connection-point>
    <project-vnfd:provider-network>...</project-vnfd:provider-network>
    <project-vnfd:vim-network-name>STRING</project-vnfd:vim-network-name>
    <project-vnfd:ip-profile-ref>STRING</project-vnfd:ip-profile-ref>
  </project-vnfd:internal-vld>
  <project-vnfd:ip-profiles>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:ip-profile-params>...</project-vnfd:ip-profile-params>
  </project-vnfd:ip-profiles>
  <project-vnfd:connection-point>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:short-name>STRING</project-vnfd:short-name>
    <project-vnfd:type>VPORT</project-vnfd:type>
    <project-vnfd:port-security-enabled>true</project-vnfd:port-security-enabled>
  </project-vnfd:connection-point>
  <project-vnfd:vdu>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:count>0</project-vnfd:count>
    <project-vnfd:mgmt-vpci>STRING</project-vnfd:mgmt-vpci>
    <project-vnfd:vm-flavor>...</project-vnfd:vm-flavor>
    <project-vnfd:guest-epa>...</project-vnfd:guest-epa>
    <project-vnfd:vswitch-epa>...</project-vnfd:vswitch-epa>
    <project-vnfd:hypervisor-epa>...</project-vnfd:hypervisor-epa>
    <project-vnfd:host-epa>...</project-vnfd:host-epa>
    <project-vnfd:alarm>...</project-vnfd:alarm>
    <project-vnfd:image>STRING</project-vnfd:image>
    <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
    <project-vnfd:alternative-images>...</project-vnfd:alternative-images>
    <project-vnfd:vdu-configuration>...</project-vnfd:vdu-configuration>
    <project-vnfd:cloud-init>STRING</project-vnfd:cloud-init>
    <project-vnfd:cloud-init-file>STRING</project-vnfd:cloud-init-file>
    <project-vnfd:supplemental-boot-data>...</project-vnfd:supplemental-boot-data>
    <project-vnfd:internal-connection-point>...</project-vnfd:internal-connection-point>
    <project-vnfd:interface>...</project-vnfd:interface>
    <project-vnfd:volumes>...</project-vnfd:volumes>
  </project-vnfd:vdu>
  <project-vnfd:vdu-dependency>
    <project-vnfd:vdu-source-ref>STRING</project-vnfd:vdu-source-ref>
    <project-vnfd:vdu-depends-on-ref>STRING</project-vnfd:vdu-depends-on-ref>
  </project-vnfd:vdu-dependency>
  <project-vnfd:service-function-chain>UNAWARE</project-vnfd:service-function-chain>
  <project-vnfd:service-function-type>STRING</project-vnfd:service-function-type>
  <project-vnfd:http-endpoint>
    <project-vnfd:path>STRING</project-vnfd:path>
    <project-vnfd:https>false</project-vnfd:https>
    <project-vnfd:port>0</project-vnfd:port>
    <project-vnfd:username>STRING</project-vnfd:username>
    <project-vnfd:password>STRING</project-vnfd:password>
    <project-vnfd:polling-interval-secs>2</project-vnfd:polling-interval-secs>
    <project-vnfd:method>GET</project-vnfd:method>
    <project-vnfd:headers>...</project-vnfd:headers>
  </project-vnfd:http-endpoint>
  <project-vnfd:monitoring-param>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:http-endpoint-ref>STRING</project-vnfd:http-endpoint-ref>
    <project-vnfd:json-query-method>NAMEKEY</project-vnfd:json-query-method>
    <project-vnfd:json-query-params>...</project-vnfd:json-query-params>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:group-tag>STRING</project-vnfd:group-tag>
    <project-vnfd:widget-type>COUNTER</project-vnfd:widget-type>
    <project-vnfd:units>STRING</project-vnfd:units>
    <project-vnfd:value-type>INT</project-vnfd:value-type>
    <project-vnfd:numeric-constraints>...</project-vnfd:numeric-constraints>
    <project-vnfd:text-constraints>...</project-vnfd:text-constraints>
    <project-vnfd:value-integer>0</project-vnfd:value-integer>
    <project-vnfd:value-decimal>0.0</project-vnfd:value-decimal>
    <project-vnfd:value-string>STRING</project-vnfd:value-string>
  </project-vnfd:monitoring-param>
  <project-vnfd:placement-groups>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:requirement>STRING</project-vnfd:requirement>
    <project-vnfd:strategy>COLOCATION</project-vnfd:strategy>
    <project-vnfd:member-vdus>...</project-vnfd:member-vdus>
  </project-vnfd:placement-groups>
</project-vnfd:vnfd>

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

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING",
    "proxy": true,
    "vca-relationships": { ... }
  },
  "config-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING",
    "proxy": true,
    "vca-relationships": { ... }
  },
  "config-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:vnf-configuration xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:script>
    <project-vnfd:script-type>rift</project-vnfd:script-type>
  </project-vnfd:script>
  <project-vnfd:juju>
    <project-vnfd:charm>STRING</project-vnfd:charm>
    <project-vnfd:proxy>true</project-vnfd:proxy>
    <project-vnfd:vca-relationships>...</project-vnfd:vca-relationships>
  </project-vnfd:juju>
  <project-vnfd:config-primitive>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:parameter>...</project-vnfd:parameter>
    <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
  </project-vnfd:config-primitive>
  <project-vnfd:initial-config-primitive>
    <project-vnfd:seq>0</project-vnfd:seq>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:parameter>...</project-vnfd:parameter>
    <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
  </project-vnfd:initial-config-primitive>
</project-vnfd:vnf-configuration>

XML Sample

<project-vnfd:vnf-configuration xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:script>
    <project-vnfd:script-type>rift</project-vnfd:script-type>
  </project-vnfd:script>
  <project-vnfd:juju>
    <project-vnfd:charm>STRING</project-vnfd:charm>
    <project-vnfd:proxy>true</project-vnfd:proxy>
    <project-vnfd:vca-relationships>...</project-vnfd:vca-relationships>
  </project-vnfd:juju>
  <project-vnfd:config-primitive>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:parameter>...</project-vnfd:parameter>
    <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
  </project-vnfd:config-primitive>
  <project-vnfd:initial-config-primitive>
    <project-vnfd:seq>0</project-vnfd:seq>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:parameter>...</project-vnfd:parameter>
    <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
  </project-vnfd:initial-config-primitive>
</project-vnfd:vnf-configuration>

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

{
  "script-type": "rift"
}

JSON Sample

{
  "script-type": "rift"
}

XML Config Sample

<project-vnfd:script xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:script-type>rift</project-vnfd:script-type>
</project-vnfd:script>

XML Sample

<project-vnfd:script xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:script-type>rift</project-vnfd:script-type>
</project-vnfd:script>

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

{
  "charm": "STRING",
  "proxy": true,
  "vca-relationships": {
    "relation": [ { ... }, { ... } ]
  }
}

JSON Sample

{
  "charm": "STRING",
  "proxy": true,
  "vca-relationships": {
    "relation": [ { ... }, { ... } ]
  }
}

XML Config Sample

<project-vnfd:juju xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:charm>STRING</project-vnfd:charm>
  <project-vnfd:proxy>true</project-vnfd:proxy>
  <project-vnfd:vca-relationships>
    <project-vnfd:relation>...</project-vnfd:relation>
  </project-vnfd:vca-relationships>
</project-vnfd:juju>

XML Sample

<project-vnfd:juju xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:charm>STRING</project-vnfd:charm>
  <project-vnfd:proxy>true</project-vnfd:proxy>
  <project-vnfd:vca-relationships>
    <project-vnfd:relation>...</project-vnfd:relation>
  </project-vnfd:vca-relationships>
</project-vnfd:juju>

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

{
  "relation": [
    {
      "requires": "STRING",
      "provides": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "relation": [
    {
      "requires": "STRING",
      "provides": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:vca-relationships xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:relation>
    <project-vnfd:requires>STRING</project-vnfd:requires>
    <project-vnfd:provides>STRING</project-vnfd:provides>
  </project-vnfd:relation>
</project-vnfd:vca-relationships>

XML Sample

<project-vnfd:vca-relationships xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:relation>
    <project-vnfd:requires>STRING</project-vnfd:requires>
    <project-vnfd:provides>STRING</project-vnfd:provides>
  </project-vnfd:relation>
</project-vnfd:vca-relationships>

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

[
  {
    "requires": "STRING",
    "provides": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "requires": "STRING",
    "provides": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:relation xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:requires>STRING</project-vnfd:requires>
  <project-vnfd:provides>STRING</project-vnfd:provides>
</project-vnfd:relation>

XML Sample

<project-vnfd:relation xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:requires>STRING</project-vnfd:requires>
  <project-vnfd:provides>STRING</project-vnfd:provides>
</project-vnfd:relation>

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

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:config-primitive xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:parameter>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:data-type>STRING</project-vnfd:data-type>
    <project-vnfd:mandatory>false</project-vnfd:mandatory>
    <project-vnfd:default-value>STRING</project-vnfd:default-value>
    <project-vnfd:parameter-pool>STRING</project-vnfd:parameter-pool>
    <project-vnfd:read-only>false</project-vnfd:read-only>
    <project-vnfd:hidden>false</project-vnfd:hidden>
  </project-vnfd:parameter>
  <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
</project-vnfd:config-primitive>

XML Sample

<project-vnfd:config-primitive xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:parameter>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:data-type>STRING</project-vnfd:data-type>
    <project-vnfd:mandatory>false</project-vnfd:mandatory>
    <project-vnfd:default-value>STRING</project-vnfd:default-value>
    <project-vnfd:parameter-pool>STRING</project-vnfd:parameter-pool>
    <project-vnfd:read-only>false</project-vnfd:read-only>
    <project-vnfd:hidden>false</project-vnfd:hidden>
  </project-vnfd:parameter>
  <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
</project-vnfd:config-primitive>

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

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:parameter xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:data-type>STRING</project-vnfd:data-type>
  <project-vnfd:mandatory>false</project-vnfd:mandatory>
  <project-vnfd:default-value>STRING</project-vnfd:default-value>
  <project-vnfd:parameter-pool>STRING</project-vnfd:parameter-pool>
  <project-vnfd:read-only>false</project-vnfd:read-only>
  <project-vnfd:hidden>false</project-vnfd:hidden>
</project-vnfd:parameter>

XML Sample

<project-vnfd:parameter xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:data-type>STRING</project-vnfd:data-type>
  <project-vnfd:mandatory>false</project-vnfd:mandatory>
  <project-vnfd:default-value>STRING</project-vnfd:default-value>
  <project-vnfd:parameter-pool>STRING</project-vnfd:parameter-pool>
  <project-vnfd:read-only>false</project-vnfd:read-only>
  <project-vnfd:hidden>false</project-vnfd:hidden>
</project-vnfd:parameter>

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

[
  {
    "seq": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:initial-config-primitive xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:seq>0</project-vnfd:seq>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:parameter>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:value>STRING</project-vnfd:value>
  </project-vnfd:parameter>
  <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
</project-vnfd:initial-config-primitive>

XML Sample

<project-vnfd:initial-config-primitive xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:seq>0</project-vnfd:seq>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:parameter>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:value>STRING</project-vnfd:value>
  </project-vnfd:parameter>
  <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
</project-vnfd:initial-config-primitive>

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

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:parameter xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:value>STRING</project-vnfd:value>
</project-vnfd:parameter>

XML Sample

<project-vnfd:parameter xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:value>STRING</project-vnfd:value>
</project-vnfd:parameter>

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

{
  "ip-address": "UNION_VALUE",
  "vdu-id": "STRING",
  "cp": "STRING",
  "port": 0,
  "dashboard-params": {
    "path": "STRING",
    "https": true,
    "port": 0
  }
}

JSON Sample

{
  "ip-address": "UNION_VALUE",
  "vdu-id": "STRING",
  "cp": "STRING",
  "port": 0,
  "dashboard-params": {
    "path": "STRING",
    "https": true,
    "port": 0
  }
}

XML Config Sample

<project-vnfd:mgmt-interface xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:ip-address>UNION_VALUE</project-vnfd:ip-address>
  <project-vnfd:vdu-id>STRING</project-vnfd:vdu-id>
  <project-vnfd:cp>STRING</project-vnfd:cp>
  <project-vnfd:port>0</project-vnfd:port>
  <project-vnfd:dashboard-params>
    <project-vnfd:path>STRING</project-vnfd:path>
    <project-vnfd:https>true</project-vnfd:https>
    <project-vnfd:port>0</project-vnfd:port>
  </project-vnfd:dashboard-params>
</project-vnfd:mgmt-interface>

XML Sample

<project-vnfd:mgmt-interface xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:ip-address>UNION_VALUE</project-vnfd:ip-address>
  <project-vnfd:vdu-id>STRING</project-vnfd:vdu-id>
  <project-vnfd:cp>STRING</project-vnfd:cp>
  <project-vnfd:port>0</project-vnfd:port>
  <project-vnfd:dashboard-params>
    <project-vnfd:path>STRING</project-vnfd:path>
    <project-vnfd:https>true</project-vnfd:https>
    <project-vnfd:port>0</project-vnfd:port>
  </project-vnfd:dashboard-params>
</project-vnfd:mgmt-interface>

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

{
  "path": "STRING",
  "https": true,
  "port": 0
}

JSON Sample

{
  "path": "STRING",
  "https": true,
  "port": 0
}

XML Config Sample

<project-vnfd:dashboard-params xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:path>STRING</project-vnfd:path>
  <project-vnfd:https>true</project-vnfd:https>
  <project-vnfd:port>0</project-vnfd:port>
</project-vnfd:dashboard-params>

XML Sample

<project-vnfd:dashboard-params xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:path>STRING</project-vnfd:path>
  <project-vnfd:https>true</project-vnfd:https>
  <project-vnfd:port>0</project-vnfd:port>
</project-vnfd:dashboard-params>

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

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "description": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "internal-connection-point": [
      {
        "id-ref": "STRING",
        "ip-address": "UNION_VALUE"
      }, {
        ...
      }
    ],
    "provider-network": {
      "physical-network": "STRING",
      "segmentation_id": 0
    },
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "description": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "internal-connection-point": [
      {
        "id-ref": "STRING",
        "ip-address": "UNION_VALUE"
      }, {
        ...
      }
    ],
    "provider-network": {
      "physical-network": "STRING",
      "segmentation_id": 0
    },
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:internal-vld xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:short-name>STRING</project-vnfd:short-name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:type>ELAN</project-vnfd:type>
  <project-vnfd:root-bandwidth>0</project-vnfd:root-bandwidth>
  <project-vnfd:leaf-bandwidth>0</project-vnfd:leaf-bandwidth>
  <project-vnfd:internal-connection-point>
    <project-vnfd:id-ref>STRING</project-vnfd:id-ref>
    <project-vnfd:ip-address>UNION_VALUE</project-vnfd:ip-address>
  </project-vnfd:internal-connection-point>
  <project-vnfd:provider-network>
    <project-vnfd:physical-network>STRING</project-vnfd:physical-network>
    <project-vnfd:segmentation_id>0</project-vnfd:segmentation_id>
  </project-vnfd:provider-network>
  <project-vnfd:vim-network-name>STRING</project-vnfd:vim-network-name>
  <project-vnfd:ip-profile-ref>STRING</project-vnfd:ip-profile-ref>
</project-vnfd:internal-vld>

XML Sample

<project-vnfd:internal-vld xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:short-name>STRING</project-vnfd:short-name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:type>ELAN</project-vnfd:type>
  <project-vnfd:root-bandwidth>0</project-vnfd:root-bandwidth>
  <project-vnfd:leaf-bandwidth>0</project-vnfd:leaf-bandwidth>
  <project-vnfd:internal-connection-point>
    <project-vnfd:id-ref>STRING</project-vnfd:id-ref>
    <project-vnfd:ip-address>UNION_VALUE</project-vnfd:ip-address>
  </project-vnfd:internal-connection-point>
  <project-vnfd:provider-network>
    <project-vnfd:physical-network>STRING</project-vnfd:physical-network>
    <project-vnfd:segmentation_id>0</project-vnfd:segmentation_id>
  </project-vnfd:provider-network>
  <project-vnfd:vim-network-name>STRING</project-vnfd:vim-network-name>
  <project-vnfd:ip-profile-ref>STRING</project-vnfd:ip-profile-ref>
</project-vnfd:internal-vld>

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

[
  {
    "id-ref": "STRING",
    "ip-address": "UNION_VALUE"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id-ref": "STRING",
    "ip-address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:internal-connection-point xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id-ref>STRING</project-vnfd:id-ref>
  <project-vnfd:ip-address>UNION_VALUE</project-vnfd:ip-address>
</project-vnfd:internal-connection-point>

XML Sample

<project-vnfd:internal-connection-point xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id-ref>STRING</project-vnfd:id-ref>
  <project-vnfd:ip-address>UNION_VALUE</project-vnfd:ip-address>
</project-vnfd:internal-connection-point>

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

{
  "physical-network": "STRING",
  "segmentation_id": 0
}

JSON Sample

{
  "physical-network": "STRING",
  "segmentation_id": 0
}

XML Config Sample

<project-vnfd:provider-network xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:physical-network>STRING</project-vnfd:physical-network>
  <project-vnfd:segmentation_id>0</project-vnfd:segmentation_id>
</project-vnfd:provider-network>

XML Sample

<project-vnfd:provider-network xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:physical-network>STRING</project-vnfd:physical-network>
  <project-vnfd:segmentation_id>0</project-vnfd:segmentation_id>
</project-vnfd:provider-network>

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

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:ip-profiles xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:ip-profile-params>
    <project-vnfd:ip-version>ipv4</project-vnfd:ip-version>
    <project-vnfd:subnet-address>UNION_VALUE</project-vnfd:subnet-address>
    <project-vnfd:gateway-address>UNION_VALUE</project-vnfd:gateway-address>
    <project-vnfd:security-group>STRING</project-vnfd:security-group>
    <project-vnfd:dns-server>...</project-vnfd:dns-server>
    <project-vnfd:dhcp-params>...</project-vnfd:dhcp-params>
    <project-vnfd:subnet-prefix-pool>STRING</project-vnfd:subnet-prefix-pool>
  </project-vnfd:ip-profile-params>
</project-vnfd:ip-profiles>

XML Sample

<project-vnfd:ip-profiles xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:ip-profile-params>
    <project-vnfd:ip-version>ipv4</project-vnfd:ip-version>
    <project-vnfd:subnet-address>UNION_VALUE</project-vnfd:subnet-address>
    <project-vnfd:gateway-address>UNION_VALUE</project-vnfd:gateway-address>
    <project-vnfd:security-group>STRING</project-vnfd:security-group>
    <project-vnfd:dns-server>...</project-vnfd:dns-server>
    <project-vnfd:dhcp-params>...</project-vnfd:dhcp-params>
    <project-vnfd:subnet-prefix-pool>STRING</project-vnfd:subnet-prefix-pool>
  </project-vnfd:ip-profile-params>
</project-vnfd:ip-profiles>

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

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

JSON Sample

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

XML Config Sample

<project-vnfd:ip-profile-params xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:ip-version>ipv4</project-vnfd:ip-version>
  <project-vnfd:subnet-address>UNION_VALUE</project-vnfd:subnet-address>
  <project-vnfd:gateway-address>UNION_VALUE</project-vnfd:gateway-address>
  <project-vnfd:security-group>STRING</project-vnfd:security-group>
  <project-vnfd:dns-server>
    <project-vnfd:address>UNION_VALUE</project-vnfd:address>
  </project-vnfd:dns-server>
  <project-vnfd:dhcp-params>
    <project-vnfd:enabled>true</project-vnfd:enabled>
    <project-vnfd:start-address>UNION_VALUE</project-vnfd:start-address>
    <project-vnfd:count>0</project-vnfd:count>
  </project-vnfd:dhcp-params>
  <project-vnfd:subnet-prefix-pool>STRING</project-vnfd:subnet-prefix-pool>
</project-vnfd:ip-profile-params>

XML Sample

<project-vnfd:ip-profile-params xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:ip-version>ipv4</project-vnfd:ip-version>
  <project-vnfd:subnet-address>UNION_VALUE</project-vnfd:subnet-address>
  <project-vnfd:gateway-address>UNION_VALUE</project-vnfd:gateway-address>
  <project-vnfd:security-group>STRING</project-vnfd:security-group>
  <project-vnfd:dns-server>
    <project-vnfd:address>UNION_VALUE</project-vnfd:address>
  </project-vnfd:dns-server>
  <project-vnfd:dhcp-params>
    <project-vnfd:enabled>true</project-vnfd:enabled>
    <project-vnfd:start-address>UNION_VALUE</project-vnfd:start-address>
    <project-vnfd:count>0</project-vnfd:count>
  </project-vnfd:dhcp-params>
  <project-vnfd:subnet-prefix-pool>STRING</project-vnfd:subnet-prefix-pool>
</project-vnfd:ip-profile-params>

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

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:dns-server xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:address>UNION_VALUE</project-vnfd:address>
</project-vnfd:dns-server>

XML Sample

<project-vnfd:dns-server xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:address>UNION_VALUE</project-vnfd:address>
</project-vnfd:dns-server>

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

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

JSON Sample

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

XML Config Sample

<project-vnfd:dhcp-params xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:enabled>true</project-vnfd:enabled>
  <project-vnfd:start-address>UNION_VALUE</project-vnfd:start-address>
  <project-vnfd:count>0</project-vnfd:count>
</project-vnfd:dhcp-params>

XML Sample

<project-vnfd:dhcp-params xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:enabled>true</project-vnfd:enabled>
  <project-vnfd:start-address>UNION_VALUE</project-vnfd:start-address>
  <project-vnfd:count>0</project-vnfd:count>
</project-vnfd:dhcp-params>

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

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:connection-point xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:short-name>STRING</project-vnfd:short-name>
  <project-vnfd:type>VPORT</project-vnfd:type>
  <project-vnfd:port-security-enabled>true</project-vnfd:port-security-enabled>
</project-vnfd:connection-point>

XML Sample

<project-vnfd:connection-point xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:short-name>STRING</project-vnfd:short-name>
  <project-vnfd:type>VPORT</project-vnfd:type>
  <project-vnfd:port-security-enabled>true</project-vnfd:port-security-enabled>
</project-vnfd:connection-point>

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

[
  {
    "id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "count": 0,
    "mgmt-vpci": "STRING",
    "vm-flavor": {
      "vcpu-count": 0,
      "memory-mb": 0,
      "storage-gb": 0
    },
    "guest-epa": {
      "trusted-execution": true,
      "mempage-size": "LARGE",
      "cpu-pinning-policy": "ANY",
      "cpu-thread-pinning-policy": "AVOID",
      "pcie-device": [ { ... }, { ... } ],
      "numa-unaware": [null],
      "numa-node-policy": { ... }
    },
    "vswitch-epa": {
      "ovs-acceleration": "MANDATORY",
      "ovs-offload": "MANDATORY"
    },
    "hypervisor-epa": {
      "type": "PREFER_KVM",
      "version": "STRING"
    },
    "host-epa": {
      "cpu-model": "PREFER_WESTMERE",
      "cpu-arch": "PREFER_X86",
      "cpu-vendor": "PREFER_INTEL",
      "cpu-socket-count": 0,
      "cpu-core-count": 0,
      "cpu-core-thread-count": 0,
      "cpu-feature": [ { ... }, { ... } ],
      "om-cpu-model-string": "STRING",
      "om-cpu-feature": [ { ... }, { ... } ]
    },
    "alarm": [
      {
        "alarm-id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "vdur-id": "STRING",
        "actions": { ... },
        "repeat": true,
        "enabled": true,
        "severity": "LOW",
        "metric": "CPU_UTILIZATION",
        "statistic": "AVERAGE",
        "operation": "GE",
        "value": 0.0,
        "period": 0,
        "evaluations": 0
      }, {
        ...
      }
    ],
    "image": "STRING",
    "image-checksum": "STRING",
    "alternative-images": [
      {
        "vim-type": "STRING",
        "image": "STRING",
        "image-checksum": "STRING"
      }, {
        ...
      }
    ],
    "vdu-configuration": {
      "script": { ... },
      "juju": { ... },
      "config-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ]
    },
    "cloud-init": "STRING",
    "cloud-init-file": "STRING",
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false
    },
    "internal-connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "internal-vld-ref": "STRING"
      }, {
        ...
      }
    ],
    "interface": [
      {
        "name": "STRING",
        "position": 0,
        "type": "EXTERNAL",
        "mac-address": "STRING",
        "internal-connection-point-ref": "STRING",
        "external-connection-point-ref": "STRING",
        "virtual-interface": { ... }
      }, {
        ...
      }
    ],
    "volumes": [
      {
        "name": "STRING",
        "description": "STRING",
        "size": 0,
        "ephemeral": [null],
        "image": "STRING",
        "image-checksum": "STRING",
        "device-bus": "ide",
        "device-type": "disk"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "count": 0,
    "mgmt-vpci": "STRING",
    "vm-flavor": {
      "vcpu-count": 0,
      "memory-mb": 0,
      "storage-gb": 0
    },
    "guest-epa": {
      "trusted-execution": true,
      "mempage-size": "LARGE",
      "cpu-pinning-policy": "ANY",
      "cpu-thread-pinning-policy": "AVOID",
      "pcie-device": [ { ... }, { ... } ],
      "numa-unaware": [null],
      "numa-node-policy": { ... }
    },
    "vswitch-epa": {
      "ovs-acceleration": "MANDATORY",
      "ovs-offload": "MANDATORY"
    },
    "hypervisor-epa": {
      "type": "PREFER_KVM",
      "version": "STRING"
    },
    "host-epa": {
      "cpu-model": "PREFER_WESTMERE",
      "cpu-arch": "PREFER_X86",
      "cpu-vendor": "PREFER_INTEL",
      "cpu-socket-count": 0,
      "cpu-core-count": 0,
      "cpu-core-thread-count": 0,
      "cpu-feature": [ { ... }, { ... } ],
      "om-cpu-model-string": "STRING",
      "om-cpu-feature": [ { ... }, { ... } ]
    },
    "alarm": [
      {
        "alarm-id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "vdur-id": "STRING",
        "actions": { ... },
        "repeat": true,
        "enabled": true,
        "severity": "LOW",
        "metric": "CPU_UTILIZATION",
        "statistic": "AVERAGE",
        "operation": "GE",
        "value": 0.0,
        "period": 0,
        "evaluations": 0
      }, {
        ...
      }
    ],
    "image": "STRING",
    "image-checksum": "STRING",
    "alternative-images": [
      {
        "vim-type": "STRING",
        "image": "STRING",
        "image-checksum": "STRING"
      }, {
        ...
      }
    ],
    "vdu-configuration": {
      "script": { ... },
      "juju": { ... },
      "config-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ]
    },
    "cloud-init": "STRING",
    "cloud-init-file": "STRING",
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false
    },
    "internal-connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "internal-vld-ref": "STRING"
      }, {
        ...
      }
    ],
    "interface": [
      {
        "name": "STRING",
        "position": 0,
        "type": "EXTERNAL",
        "mac-address": "STRING",
        "internal-connection-point-ref": "STRING",
        "external-connection-point-ref": "STRING",
        "virtual-interface": { ... }
      }, {
        ...
      }
    ],
    "volumes": [
      {
        "name": "STRING",
        "description": "STRING",
        "size": 0,
        "ephemeral": [null],
        "image": "STRING",
        "image-checksum": "STRING",
        "device-bus": "ide",
        "device-type": "disk"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:vdu xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:count>0</project-vnfd:count>
  <project-vnfd:mgmt-vpci>STRING</project-vnfd:mgmt-vpci>
  <project-vnfd:vm-flavor>
    <project-vnfd:vcpu-count>0</project-vnfd:vcpu-count>
    <project-vnfd:memory-mb>0</project-vnfd:memory-mb>
    <project-vnfd:storage-gb>0</project-vnfd:storage-gb>
  </project-vnfd:vm-flavor>
  <project-vnfd:guest-epa>
    <project-vnfd:trusted-execution>true</project-vnfd:trusted-execution>
    <project-vnfd:mempage-size>LARGE</project-vnfd:mempage-size>
    <project-vnfd:cpu-pinning-policy>ANY</project-vnfd:cpu-pinning-policy>
    <project-vnfd:cpu-thread-pinning-policy>AVOID</project-vnfd:cpu-thread-pinning-policy>
    <project-vnfd:pcie-device>...</project-vnfd:pcie-device>
    <project-vnfd:numa-unaware/>
    <project-vnfd:numa-node-policy>...</project-vnfd:numa-node-policy>
  </project-vnfd:guest-epa>
  <project-vnfd:vswitch-epa>
    <project-vnfd:ovs-acceleration>MANDATORY</project-vnfd:ovs-acceleration>
    <project-vnfd:ovs-offload>MANDATORY</project-vnfd:ovs-offload>
  </project-vnfd:vswitch-epa>
  <project-vnfd:hypervisor-epa>
    <project-vnfd:type>PREFER_KVM</project-vnfd:type>
    <project-vnfd:version>STRING</project-vnfd:version>
  </project-vnfd:hypervisor-epa>
  <project-vnfd:host-epa>
    <project-vnfd:cpu-model>PREFER_WESTMERE</project-vnfd:cpu-model>
    <project-vnfd:cpu-arch>PREFER_X86</project-vnfd:cpu-arch>
    <project-vnfd:cpu-vendor>PREFER_INTEL</project-vnfd:cpu-vendor>
    <project-vnfd:cpu-socket-count>0</project-vnfd:cpu-socket-count>
    <project-vnfd:cpu-core-count>0</project-vnfd:cpu-core-count>
    <project-vnfd:cpu-core-thread-count>0</project-vnfd:cpu-core-thread-count>
    <project-vnfd:cpu-feature>...</project-vnfd:cpu-feature>
    <project-vnfd:om-cpu-model-string>STRING</project-vnfd:om-cpu-model-string>
    <project-vnfd:om-cpu-feature>...</project-vnfd:om-cpu-feature>
  </project-vnfd:host-epa>
  <project-vnfd:alarm>
    <project-vnfd:alarm-id>STRING</project-vnfd:alarm-id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:vdur-id>STRING</project-vnfd:vdur-id>
    <project-vnfd:actions>...</project-vnfd:actions>
    <project-vnfd:repeat>true</project-vnfd:repeat>
    <project-vnfd:enabled>true</project-vnfd:enabled>
    <project-vnfd:severity>LOW</project-vnfd:severity>
    <project-vnfd:metric>CPU_UTILIZATION</project-vnfd:metric>
    <project-vnfd:statistic>AVERAGE</project-vnfd:statistic>
    <project-vnfd:operation>GE</project-vnfd:operation>
    <project-vnfd:value>0.0</project-vnfd:value>
    <project-vnfd:period>0</project-vnfd:period>
    <project-vnfd:evaluations>0</project-vnfd:evaluations>
  </project-vnfd:alarm>
  <project-vnfd:image>STRING</project-vnfd:image>
  <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
  <project-vnfd:alternative-images>
    <project-vnfd:vim-type>STRING</project-vnfd:vim-type>
    <project-vnfd:image>STRING</project-vnfd:image>
    <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
  </project-vnfd:alternative-images>
  <project-vnfd:vdu-configuration>
    <project-vnfd:script>...</project-vnfd:script>
    <project-vnfd:juju>...</project-vnfd:juju>
    <project-vnfd:config-primitive>...</project-vnfd:config-primitive>
    <project-vnfd:initial-config-primitive>...</project-vnfd:initial-config-primitive>
  </project-vnfd:vdu-configuration>
  <project-vnfd:cloud-init>STRING</project-vnfd:cloud-init>
  <project-vnfd:cloud-init-file>STRING</project-vnfd:cloud-init-file>
  <project-vnfd:supplemental-boot-data>
    <project-vnfd:config-file>...</project-vnfd:config-file>
    <project-vnfd:boot-data-drive>false</project-vnfd:boot-data-drive>
  </project-vnfd:supplemental-boot-data>
  <project-vnfd:internal-connection-point>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:short-name>STRING</project-vnfd:short-name>
    <project-vnfd:type>VPORT</project-vnfd:type>
    <project-vnfd:port-security-enabled>true</project-vnfd:port-security-enabled>
    <project-vnfd:internal-vld-ref>STRING</project-vnfd:internal-vld-ref>
  </project-vnfd:internal-connection-point>
  <project-vnfd:interface>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:position>0</project-vnfd:position>
    <project-vnfd:type>EXTERNAL</project-vnfd:type>
    <project-vnfd:mac-address>STRING</project-vnfd:mac-address>
    <project-vnfd:internal-connection-point-ref>STRING</project-vnfd:internal-connection-point-ref>
    <project-vnfd:external-connection-point-ref>STRING</project-vnfd:external-connection-point-ref>
    <project-vnfd:virtual-interface>...</project-vnfd:virtual-interface>
  </project-vnfd:interface>
  <project-vnfd:volumes>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:size>0</project-vnfd:size>
    <project-vnfd:ephemeral/>
    <project-vnfd:image>STRING</project-vnfd:image>
    <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
    <project-vnfd:device-bus>ide</project-vnfd:device-bus>
    <project-vnfd:device-type>disk</project-vnfd:device-type>
  </project-vnfd:volumes>
</project-vnfd:vdu>

XML Sample

<project-vnfd:vdu xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:count>0</project-vnfd:count>
  <project-vnfd:mgmt-vpci>STRING</project-vnfd:mgmt-vpci>
  <project-vnfd:vm-flavor>
    <project-vnfd:vcpu-count>0</project-vnfd:vcpu-count>
    <project-vnfd:memory-mb>0</project-vnfd:memory-mb>
    <project-vnfd:storage-gb>0</project-vnfd:storage-gb>
  </project-vnfd:vm-flavor>
  <project-vnfd:guest-epa>
    <project-vnfd:trusted-execution>true</project-vnfd:trusted-execution>
    <project-vnfd:mempage-size>LARGE</project-vnfd:mempage-size>
    <project-vnfd:cpu-pinning-policy>ANY</project-vnfd:cpu-pinning-policy>
    <project-vnfd:cpu-thread-pinning-policy>AVOID</project-vnfd:cpu-thread-pinning-policy>
    <project-vnfd:pcie-device>...</project-vnfd:pcie-device>
    <project-vnfd:numa-unaware/>
    <project-vnfd:numa-node-policy>...</project-vnfd:numa-node-policy>
  </project-vnfd:guest-epa>
  <project-vnfd:vswitch-epa>
    <project-vnfd:ovs-acceleration>MANDATORY</project-vnfd:ovs-acceleration>
    <project-vnfd:ovs-offload>MANDATORY</project-vnfd:ovs-offload>
  </project-vnfd:vswitch-epa>
  <project-vnfd:hypervisor-epa>
    <project-vnfd:type>PREFER_KVM</project-vnfd:type>
    <project-vnfd:version>STRING</project-vnfd:version>
  </project-vnfd:hypervisor-epa>
  <project-vnfd:host-epa>
    <project-vnfd:cpu-model>PREFER_WESTMERE</project-vnfd:cpu-model>
    <project-vnfd:cpu-arch>PREFER_X86</project-vnfd:cpu-arch>
    <project-vnfd:cpu-vendor>PREFER_INTEL</project-vnfd:cpu-vendor>
    <project-vnfd:cpu-socket-count>0</project-vnfd:cpu-socket-count>
    <project-vnfd:cpu-core-count>0</project-vnfd:cpu-core-count>
    <project-vnfd:cpu-core-thread-count>0</project-vnfd:cpu-core-thread-count>
    <project-vnfd:cpu-feature>...</project-vnfd:cpu-feature>
    <project-vnfd:om-cpu-model-string>STRING</project-vnfd:om-cpu-model-string>
    <project-vnfd:om-cpu-feature>...</project-vnfd:om-cpu-feature>
  </project-vnfd:host-epa>
  <project-vnfd:alarm>
    <project-vnfd:alarm-id>STRING</project-vnfd:alarm-id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:vdur-id>STRING</project-vnfd:vdur-id>
    <project-vnfd:actions>...</project-vnfd:actions>
    <project-vnfd:repeat>true</project-vnfd:repeat>
    <project-vnfd:enabled>true</project-vnfd:enabled>
    <project-vnfd:severity>LOW</project-vnfd:severity>
    <project-vnfd:metric>CPU_UTILIZATION</project-vnfd:metric>
    <project-vnfd:statistic>AVERAGE</project-vnfd:statistic>
    <project-vnfd:operation>GE</project-vnfd:operation>
    <project-vnfd:value>0.0</project-vnfd:value>
    <project-vnfd:period>0</project-vnfd:period>
    <project-vnfd:evaluations>0</project-vnfd:evaluations>
  </project-vnfd:alarm>
  <project-vnfd:image>STRING</project-vnfd:image>
  <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
  <project-vnfd:alternative-images>
    <project-vnfd:vim-type>STRING</project-vnfd:vim-type>
    <project-vnfd:image>STRING</project-vnfd:image>
    <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
  </project-vnfd:alternative-images>
  <project-vnfd:vdu-configuration>
    <project-vnfd:script>...</project-vnfd:script>
    <project-vnfd:juju>...</project-vnfd:juju>
    <project-vnfd:config-primitive>...</project-vnfd:config-primitive>
    <project-vnfd:initial-config-primitive>...</project-vnfd:initial-config-primitive>
  </project-vnfd:vdu-configuration>
  <project-vnfd:cloud-init>STRING</project-vnfd:cloud-init>
  <project-vnfd:cloud-init-file>STRING</project-vnfd:cloud-init-file>
  <project-vnfd:supplemental-boot-data>
    <project-vnfd:config-file>...</project-vnfd:config-file>
    <project-vnfd:boot-data-drive>false</project-vnfd:boot-data-drive>
  </project-vnfd:supplemental-boot-data>
  <project-vnfd:internal-connection-point>
    <project-vnfd:id>STRING</project-vnfd:id>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:short-name>STRING</project-vnfd:short-name>
    <project-vnfd:type>VPORT</project-vnfd:type>
    <project-vnfd:port-security-enabled>true</project-vnfd:port-security-enabled>
    <project-vnfd:internal-vld-ref>STRING</project-vnfd:internal-vld-ref>
  </project-vnfd:internal-connection-point>
  <project-vnfd:interface>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:position>0</project-vnfd:position>
    <project-vnfd:type>EXTERNAL</project-vnfd:type>
    <project-vnfd:mac-address>STRING</project-vnfd:mac-address>
    <project-vnfd:internal-connection-point-ref>STRING</project-vnfd:internal-connection-point-ref>
    <project-vnfd:external-connection-point-ref>STRING</project-vnfd:external-connection-point-ref>
    <project-vnfd:virtual-interface>...</project-vnfd:virtual-interface>
  </project-vnfd:interface>
  <project-vnfd:volumes>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:description>STRING</project-vnfd:description>
    <project-vnfd:size>0</project-vnfd:size>
    <project-vnfd:ephemeral/>
    <project-vnfd:image>STRING</project-vnfd:image>
    <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
    <project-vnfd:device-bus>ide</project-vnfd:device-bus>
    <project-vnfd:device-type>disk</project-vnfd:device-type>
  </project-vnfd:volumes>
</project-vnfd:vdu>

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

{
  "vcpu-count": 0,
  "memory-mb": 0,
  "storage-gb": 0
}

JSON Sample

{
  "vcpu-count": 0,
  "memory-mb": 0,
  "storage-gb": 0
}

XML Config Sample

<project-vnfd:vm-flavor xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:vcpu-count>0</project-vnfd:vcpu-count>
  <project-vnfd:memory-mb>0</project-vnfd:memory-mb>
  <project-vnfd:storage-gb>0</project-vnfd:storage-gb>
</project-vnfd:vm-flavor>

XML Sample

<project-vnfd:vm-flavor xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:vcpu-count>0</project-vnfd:vcpu-count>
  <project-vnfd:memory-mb>0</project-vnfd:memory-mb>
  <project-vnfd:storage-gb>0</project-vnfd:storage-gb>
</project-vnfd:vm-flavor>

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

{
  "trusted-execution": true,
  "mempage-size": "LARGE",
  "cpu-pinning-policy": "ANY",
  "cpu-thread-pinning-policy": "AVOID",
  "pcie-device": [
    {
      "device-id": "STRING",
      "count": 0
    }, {
      ...
    }
  ],
  "numa-unaware": [null],
  "numa-node-policy": {
    "node-cnt": 0,
    "mem-policy": "STRICT",
    "node": [ { ... }, { ... } ]
  }
}

JSON Sample

{
  "trusted-execution": true,
  "mempage-size": "LARGE",
  "cpu-pinning-policy": "ANY",
  "cpu-thread-pinning-policy": "AVOID",
  "pcie-device": [
    {
      "device-id": "STRING",
      "count": 0
    }, {
      ...
    }
  ],
  "numa-unaware": [null],
  "numa-node-policy": {
    "node-cnt": 0,
    "mem-policy": "STRICT",
    "node": [ { ... }, { ... } ]
  }
}

XML Config Sample

<project-vnfd:guest-epa xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:trusted-execution>true</project-vnfd:trusted-execution>
  <project-vnfd:mempage-size>LARGE</project-vnfd:mempage-size>
  <project-vnfd:cpu-pinning-policy>ANY</project-vnfd:cpu-pinning-policy>
  <project-vnfd:cpu-thread-pinning-policy>AVOID</project-vnfd:cpu-thread-pinning-policy>
  <project-vnfd:pcie-device>
    <project-vnfd:device-id>STRING</project-vnfd:device-id>
    <project-vnfd:count>0</project-vnfd:count>
  </project-vnfd:pcie-device>
  <project-vnfd:numa-unaware/>
  <project-vnfd:numa-node-policy>
    <project-vnfd:node-cnt>0</project-vnfd:node-cnt>
    <project-vnfd:mem-policy>STRICT</project-vnfd:mem-policy>
    <project-vnfd:node>...</project-vnfd:node>
  </project-vnfd:numa-node-policy>
</project-vnfd:guest-epa>

XML Sample

<project-vnfd:guest-epa xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:trusted-execution>true</project-vnfd:trusted-execution>
  <project-vnfd:mempage-size>LARGE</project-vnfd:mempage-size>
  <project-vnfd:cpu-pinning-policy>ANY</project-vnfd:cpu-pinning-policy>
  <project-vnfd:cpu-thread-pinning-policy>AVOID</project-vnfd:cpu-thread-pinning-policy>
  <project-vnfd:pcie-device>
    <project-vnfd:device-id>STRING</project-vnfd:device-id>
    <project-vnfd:count>0</project-vnfd:count>
  </project-vnfd:pcie-device>
  <project-vnfd:numa-unaware/>
  <project-vnfd:numa-node-policy>
    <project-vnfd:node-cnt>0</project-vnfd:node-cnt>
    <project-vnfd:mem-policy>STRICT</project-vnfd:mem-policy>
    <project-vnfd:node>...</project-vnfd:node>
  </project-vnfd:numa-node-policy>
</project-vnfd:guest-epa>

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

[
  {
    "device-id": "STRING",
    "count": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "device-id": "STRING",
    "count": 0
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:pcie-device xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:device-id>STRING</project-vnfd:device-id>
  <project-vnfd:count>0</project-vnfd:count>
</project-vnfd:pcie-device>

XML Sample

<project-vnfd:pcie-device xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:device-id>STRING</project-vnfd:device-id>
  <project-vnfd:count>0</project-vnfd:count>
</project-vnfd:pcie-device>

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

{
  "node-cnt": 0,
  "mem-policy": "STRICT",
  "node": [
    {
      "id": 0,
      "vcpu": [ { ... }, { ... } ],
      "memory-mb": 0,
      "num-cores": 0,
      "paired-threads": { ... },
      "num-threads": 0
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "node-cnt": 0,
  "mem-policy": "STRICT",
  "node": [
    {
      "id": 0,
      "vcpu": [ { ... }, { ... } ],
      "memory-mb": 0,
      "num-cores": 0,
      "paired-threads": { ... },
      "num-threads": 0
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:numa-node-policy xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:node-cnt>0</project-vnfd:node-cnt>
  <project-vnfd:mem-policy>STRICT</project-vnfd:mem-policy>
  <project-vnfd:node>
    <project-vnfd:id>0</project-vnfd:id>
    <project-vnfd:vcpu>...</project-vnfd:vcpu>
    <project-vnfd:memory-mb>0</project-vnfd:memory-mb>
    <project-vnfd:num-cores>0</project-vnfd:num-cores>
    <project-vnfd:paired-threads>...</project-vnfd:paired-threads>
    <project-vnfd:num-threads>0</project-vnfd:num-threads>
  </project-vnfd:node>
</project-vnfd:numa-node-policy>

XML Sample

<project-vnfd:numa-node-policy xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:node-cnt>0</project-vnfd:node-cnt>
  <project-vnfd:mem-policy>STRICT</project-vnfd:mem-policy>
  <project-vnfd:node>
    <project-vnfd:id>0</project-vnfd:id>
    <project-vnfd:vcpu>...</project-vnfd:vcpu>
    <project-vnfd:memory-mb>0</project-vnfd:memory-mb>
    <project-vnfd:num-cores>0</project-vnfd:num-cores>
    <project-vnfd:paired-threads>...</project-vnfd:paired-threads>
    <project-vnfd:num-threads>0</project-vnfd:num-threads>
  </project-vnfd:node>
</project-vnfd:numa-node-policy>

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

[
  {
    "id": 0,
    "vcpu": [
      {
        "id": 0
      }, {
        ...
      }
    ],
    "memory-mb": 0,
    "num-cores": 0,
    "paired-threads": {
      "num-paired-threads": 0,
      "paired-thread-ids": [ { ... }, { ... } ]
    },
    "num-threads": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": 0,
    "vcpu": [
      {
        "id": 0
      }, {
        ...
      }
    ],
    "memory-mb": 0,
    "num-cores": 0,
    "paired-threads": {
      "num-paired-threads": 0,
      "paired-thread-ids": [ { ... }, { ... } ]
    },
    "num-threads": 0
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:node xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>0</project-vnfd:id>
  <project-vnfd:vcpu>
    <project-vnfd:id>0</project-vnfd:id>
  </project-vnfd:vcpu>
  <project-vnfd:memory-mb>0</project-vnfd:memory-mb>
  <project-vnfd:num-cores>0</project-vnfd:num-cores>
  <project-vnfd:paired-threads>
    <project-vnfd:num-paired-threads>0</project-vnfd:num-paired-threads>
    <project-vnfd:paired-thread-ids>...</project-vnfd:paired-thread-ids>
  </project-vnfd:paired-threads>
  <project-vnfd:num-threads>0</project-vnfd:num-threads>
</project-vnfd:node>

XML Sample

<project-vnfd:node xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>0</project-vnfd:id>
  <project-vnfd:vcpu>
    <project-vnfd:id>0</project-vnfd:id>
  </project-vnfd:vcpu>
  <project-vnfd:memory-mb>0</project-vnfd:memory-mb>
  <project-vnfd:num-cores>0</project-vnfd:num-cores>
  <project-vnfd:paired-threads>
    <project-vnfd:num-paired-threads>0</project-vnfd:num-paired-threads>
    <project-vnfd:paired-thread-ids>...</project-vnfd:paired-thread-ids>
  </project-vnfd:paired-threads>
  <project-vnfd:num-threads>0</project-vnfd:num-threads>
</project-vnfd:node>

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

[
  {
    "id": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:vcpu xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>0</project-vnfd:id>
</project-vnfd:vcpu>

XML Sample

<project-vnfd:vcpu xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>0</project-vnfd:id>
</project-vnfd:vcpu>

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

{
  "num-paired-threads": 0,
  "paired-thread-ids": [
    {
      "thread-a": 0,
      "thread-b": 0
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "num-paired-threads": 0,
  "paired-thread-ids": [
    {
      "thread-a": 0,
      "thread-b": 0
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:paired-threads xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:num-paired-threads>0</project-vnfd:num-paired-threads>
  <project-vnfd:paired-thread-ids>
    <project-vnfd:thread-a>0</project-vnfd:thread-a>
    <project-vnfd:thread-b>0</project-vnfd:thread-b>
  </project-vnfd:paired-thread-ids>
</project-vnfd:paired-threads>

XML Sample

<project-vnfd:paired-threads xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:num-paired-threads>0</project-vnfd:num-paired-threads>
  <project-vnfd:paired-thread-ids>
    <project-vnfd:thread-a>0</project-vnfd:thread-a>
    <project-vnfd:thread-b>0</project-vnfd:thread-b>
  </project-vnfd:paired-thread-ids>
</project-vnfd:paired-threads>

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

[
  {
    "thread-a": 0,
    "thread-b": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "thread-a": 0,
    "thread-b": 0
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:paired-thread-ids xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:thread-a>0</project-vnfd:thread-a>
  <project-vnfd:thread-b>0</project-vnfd:thread-b>
</project-vnfd:paired-thread-ids>

XML Sample

<project-vnfd:paired-thread-ids xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:thread-a>0</project-vnfd:thread-a>
  <project-vnfd:thread-b>0</project-vnfd:thread-b>
</project-vnfd:paired-thread-ids>

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

{
  "ovs-acceleration": "MANDATORY",
  "ovs-offload": "MANDATORY"
}

JSON Sample

{
  "ovs-acceleration": "MANDATORY",
  "ovs-offload": "MANDATORY"
}

XML Config Sample

<project-vnfd:vswitch-epa xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:ovs-acceleration>MANDATORY</project-vnfd:ovs-acceleration>
  <project-vnfd:ovs-offload>MANDATORY</project-vnfd:ovs-offload>
</project-vnfd:vswitch-epa>

XML Sample

<project-vnfd:vswitch-epa xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:ovs-acceleration>MANDATORY</project-vnfd:ovs-acceleration>
  <project-vnfd:ovs-offload>MANDATORY</project-vnfd:ovs-offload>
</project-vnfd:vswitch-epa>

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

{
  "type": "PREFER_KVM",
  "version": "STRING"
}

JSON Sample

{
  "type": "PREFER_KVM",
  "version": "STRING"
}

XML Config Sample

<project-vnfd:hypervisor-epa xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:type>PREFER_KVM</project-vnfd:type>
  <project-vnfd:version>STRING</project-vnfd:version>
</project-vnfd:hypervisor-epa>

XML Sample

<project-vnfd:hypervisor-epa xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:type>PREFER_KVM</project-vnfd:type>
  <project-vnfd:version>STRING</project-vnfd:version>
</project-vnfd:hypervisor-epa>

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

{
  "cpu-model": "PREFER_WESTMERE",
  "cpu-arch": "PREFER_X86",
  "cpu-vendor": "PREFER_INTEL",
  "cpu-socket-count": 0,
  "cpu-core-count": 0,
  "cpu-core-thread-count": 0,
  "cpu-feature": [
    {
      "feature": "PREFER_AES"
    }, {
      ...
    }
  ],
  "om-cpu-model-string": "STRING",
  "om-cpu-feature": [
    {
      "feature": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "cpu-model": "PREFER_WESTMERE",
  "cpu-arch": "PREFER_X86",
  "cpu-vendor": "PREFER_INTEL",
  "cpu-socket-count": 0,
  "cpu-core-count": 0,
  "cpu-core-thread-count": 0,
  "cpu-feature": [
    {
      "feature": "PREFER_AES"
    }, {
      ...
    }
  ],
  "om-cpu-model-string": "STRING",
  "om-cpu-feature": [
    {
      "feature": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:host-epa xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:cpu-model>PREFER_WESTMERE</project-vnfd:cpu-model>
  <project-vnfd:cpu-arch>PREFER_X86</project-vnfd:cpu-arch>
  <project-vnfd:cpu-vendor>PREFER_INTEL</project-vnfd:cpu-vendor>
  <project-vnfd:cpu-socket-count>0</project-vnfd:cpu-socket-count>
  <project-vnfd:cpu-core-count>0</project-vnfd:cpu-core-count>
  <project-vnfd:cpu-core-thread-count>0</project-vnfd:cpu-core-thread-count>
  <project-vnfd:cpu-feature>
    <project-vnfd:feature>PREFER_AES</project-vnfd:feature>
  </project-vnfd:cpu-feature>
  <project-vnfd:om-cpu-model-string>STRING</project-vnfd:om-cpu-model-string>
  <project-vnfd:om-cpu-feature>
    <project-vnfd:feature>STRING</project-vnfd:feature>
  </project-vnfd:om-cpu-feature>
</project-vnfd:host-epa>

XML Sample

<project-vnfd:host-epa xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:cpu-model>PREFER_WESTMERE</project-vnfd:cpu-model>
  <project-vnfd:cpu-arch>PREFER_X86</project-vnfd:cpu-arch>
  <project-vnfd:cpu-vendor>PREFER_INTEL</project-vnfd:cpu-vendor>
  <project-vnfd:cpu-socket-count>0</project-vnfd:cpu-socket-count>
  <project-vnfd:cpu-core-count>0</project-vnfd:cpu-core-count>
  <project-vnfd:cpu-core-thread-count>0</project-vnfd:cpu-core-thread-count>
  <project-vnfd:cpu-feature>
    <project-vnfd:feature>PREFER_AES</project-vnfd:feature>
  </project-vnfd:cpu-feature>
  <project-vnfd:om-cpu-model-string>STRING</project-vnfd:om-cpu-model-string>
  <project-vnfd:om-cpu-feature>
    <project-vnfd:feature>STRING</project-vnfd:feature>
  </project-vnfd:om-cpu-feature>
</project-vnfd:host-epa>

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

[
  {
    "feature": "PREFER_AES"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "feature": "PREFER_AES"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:cpu-feature xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:feature>PREFER_AES</project-vnfd:feature>
</project-vnfd:cpu-feature>

XML Sample

<project-vnfd:cpu-feature xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:feature>PREFER_AES</project-vnfd:feature>
</project-vnfd:cpu-feature>

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

[
  {
    "feature": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "feature": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:om-cpu-feature xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:feature>STRING</project-vnfd:feature>
</project-vnfd:om-cpu-feature>

XML Sample

<project-vnfd:om-cpu-feature xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:feature>STRING</project-vnfd:feature>
</project-vnfd:om-cpu-feature>

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

[
  {
    "alarm-id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "vdur-id": "STRING",
    "actions": {
      "ok": [ { ... }, { ... } ],
      "insufficient-data": [ { ... }, { ... } ],
      "alarm": [ { ... }, { ... } ]
    },
    "repeat": true,
    "enabled": true,
    "severity": "LOW",
    "metric": "CPU_UTILIZATION",
    "statistic": "AVERAGE",
    "operation": "GE",
    "value": 0.0,
    "period": 0,
    "evaluations": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "alarm-id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "vdur-id": "STRING",
    "actions": {
      "ok": [ { ... }, { ... } ],
      "insufficient-data": [ { ... }, { ... } ],
      "alarm": [ { ... }, { ... } ]
    },
    "repeat": true,
    "enabled": true,
    "severity": "LOW",
    "metric": "CPU_UTILIZATION",
    "statistic": "AVERAGE",
    "operation": "GE",
    "value": 0.0,
    "period": 0,
    "evaluations": 0
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:alarm xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:alarm-id>STRING</project-vnfd:alarm-id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:vdur-id>STRING</project-vnfd:vdur-id>
  <project-vnfd:actions>
    <project-vnfd:ok>...</project-vnfd:ok>
    <project-vnfd:insufficient-data>...</project-vnfd:insufficient-data>
    <project-vnfd:alarm>...</project-vnfd:alarm>
  </project-vnfd:actions>
  <project-vnfd:repeat>true</project-vnfd:repeat>
  <project-vnfd:enabled>true</project-vnfd:enabled>
  <project-vnfd:severity>LOW</project-vnfd:severity>
  <project-vnfd:metric>CPU_UTILIZATION</project-vnfd:metric>
  <project-vnfd:statistic>AVERAGE</project-vnfd:statistic>
  <project-vnfd:operation>GE</project-vnfd:operation>
  <project-vnfd:value>0.0</project-vnfd:value>
  <project-vnfd:period>0</project-vnfd:period>
  <project-vnfd:evaluations>0</project-vnfd:evaluations>
</project-vnfd:alarm>

XML Sample

<project-vnfd:alarm xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:alarm-id>STRING</project-vnfd:alarm-id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:vdur-id>STRING</project-vnfd:vdur-id>
  <project-vnfd:actions>
    <project-vnfd:ok>...</project-vnfd:ok>
    <project-vnfd:insufficient-data>...</project-vnfd:insufficient-data>
    <project-vnfd:alarm>...</project-vnfd:alarm>
  </project-vnfd:actions>
  <project-vnfd:repeat>true</project-vnfd:repeat>
  <project-vnfd:enabled>true</project-vnfd:enabled>
  <project-vnfd:severity>LOW</project-vnfd:severity>
  <project-vnfd:metric>CPU_UTILIZATION</project-vnfd:metric>
  <project-vnfd:statistic>AVERAGE</project-vnfd:statistic>
  <project-vnfd:operation>GE</project-vnfd:operation>
  <project-vnfd:value>0.0</project-vnfd:value>
  <project-vnfd:period>0</project-vnfd:period>
  <project-vnfd:evaluations>0</project-vnfd:evaluations>
</project-vnfd:alarm>

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

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:actions xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:ok>
    <project-vnfd:url>STRING</project-vnfd:url>
  </project-vnfd:ok>
  <project-vnfd:insufficient-data>
    <project-vnfd:url>STRING</project-vnfd:url>
  </project-vnfd:insufficient-data>
  <project-vnfd:alarm>
    <project-vnfd:url>STRING</project-vnfd:url>
  </project-vnfd:alarm>
</project-vnfd:actions>

XML Sample

<project-vnfd:actions xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:ok>
    <project-vnfd:url>STRING</project-vnfd:url>
  </project-vnfd:ok>
  <project-vnfd:insufficient-data>
    <project-vnfd:url>STRING</project-vnfd:url>
  </project-vnfd:insufficient-data>
  <project-vnfd:alarm>
    <project-vnfd:url>STRING</project-vnfd:url>
  </project-vnfd:alarm>
</project-vnfd:actions>

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

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:ok xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:url>STRING</project-vnfd:url>
</project-vnfd:ok>

XML Sample

<project-vnfd:ok xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:url>STRING</project-vnfd:url>
</project-vnfd:ok>

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

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:insufficient-data xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:url>STRING</project-vnfd:url>
</project-vnfd:insufficient-data>

XML Sample

<project-vnfd:insufficient-data xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:url>STRING</project-vnfd:url>
</project-vnfd:insufficient-data>

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

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:alarm xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:url>STRING</project-vnfd:url>
</project-vnfd:alarm>

XML Sample

<project-vnfd:alarm xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:url>STRING</project-vnfd:url>
</project-vnfd:alarm>

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

[
  {
    "vim-type": "STRING",
    "image": "STRING",
    "image-checksum": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vim-type": "STRING",
    "image": "STRING",
    "image-checksum": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:alternative-images xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:vim-type>STRING</project-vnfd:vim-type>
  <project-vnfd:image>STRING</project-vnfd:image>
  <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
</project-vnfd:alternative-images>

XML Sample

<project-vnfd:alternative-images xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:vim-type>STRING</project-vnfd:vim-type>
  <project-vnfd:image>STRING</project-vnfd:image>
  <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
</project-vnfd:alternative-images>

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

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING",
    "proxy": true,
    "vca-relationships": { ... }
  },
  "config-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING",
    "proxy": true,
    "vca-relationships": { ... }
  },
  "config-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:vdu-configuration xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:script>
    <project-vnfd:script-type>rift</project-vnfd:script-type>
  </project-vnfd:script>
  <project-vnfd:juju>
    <project-vnfd:charm>STRING</project-vnfd:charm>
    <project-vnfd:proxy>true</project-vnfd:proxy>
    <project-vnfd:vca-relationships>...</project-vnfd:vca-relationships>
  </project-vnfd:juju>
  <project-vnfd:config-primitive>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:parameter>...</project-vnfd:parameter>
    <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
  </project-vnfd:config-primitive>
  <project-vnfd:initial-config-primitive>
    <project-vnfd:seq>0</project-vnfd:seq>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:parameter>...</project-vnfd:parameter>
    <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
  </project-vnfd:initial-config-primitive>
</project-vnfd:vdu-configuration>

XML Sample

<project-vnfd:vdu-configuration xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:script>
    <project-vnfd:script-type>rift</project-vnfd:script-type>
  </project-vnfd:script>
  <project-vnfd:juju>
    <project-vnfd:charm>STRING</project-vnfd:charm>
    <project-vnfd:proxy>true</project-vnfd:proxy>
    <project-vnfd:vca-relationships>...</project-vnfd:vca-relationships>
  </project-vnfd:juju>
  <project-vnfd:config-primitive>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:parameter>...</project-vnfd:parameter>
    <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
  </project-vnfd:config-primitive>
  <project-vnfd:initial-config-primitive>
    <project-vnfd:seq>0</project-vnfd:seq>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:parameter>...</project-vnfd:parameter>
    <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
  </project-vnfd:initial-config-primitive>
</project-vnfd:vdu-configuration>

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

{
  "script-type": "rift"
}

JSON Sample

{
  "script-type": "rift"
}

XML Config Sample

<project-vnfd:script xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:script-type>rift</project-vnfd:script-type>
</project-vnfd:script>

XML Sample

<project-vnfd:script xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:script-type>rift</project-vnfd:script-type>
</project-vnfd:script>

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

{
  "charm": "STRING",
  "proxy": true,
  "vca-relationships": {
    "relation": [ { ... }, { ... } ]
  }
}

JSON Sample

{
  "charm": "STRING",
  "proxy": true,
  "vca-relationships": {
    "relation": [ { ... }, { ... } ]
  }
}

XML Config Sample

<project-vnfd:juju xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:charm>STRING</project-vnfd:charm>
  <project-vnfd:proxy>true</project-vnfd:proxy>
  <project-vnfd:vca-relationships>
    <project-vnfd:relation>...</project-vnfd:relation>
  </project-vnfd:vca-relationships>
</project-vnfd:juju>

XML Sample

<project-vnfd:juju xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:charm>STRING</project-vnfd:charm>
  <project-vnfd:proxy>true</project-vnfd:proxy>
  <project-vnfd:vca-relationships>
    <project-vnfd:relation>...</project-vnfd:relation>
  </project-vnfd:vca-relationships>
</project-vnfd:juju>

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

{
  "relation": [
    {
      "requires": "STRING",
      "provides": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "relation": [
    {
      "requires": "STRING",
      "provides": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<project-vnfd:vca-relationships xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:relation>
    <project-vnfd:requires>STRING</project-vnfd:requires>
    <project-vnfd:provides>STRING</project-vnfd:provides>
  </project-vnfd:relation>
</project-vnfd:vca-relationships>

XML Sample

<project-vnfd:vca-relationships xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:relation>
    <project-vnfd:requires>STRING</project-vnfd:requires>
    <project-vnfd:provides>STRING</project-vnfd:provides>
  </project-vnfd:relation>
</project-vnfd:vca-relationships>

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

[
  {
    "requires": "STRING",
    "provides": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "requires": "STRING",
    "provides": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:relation xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:requires>STRING</project-vnfd:requires>
  <project-vnfd:provides>STRING</project-vnfd:provides>
</project-vnfd:relation>

XML Sample

<project-vnfd:relation xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:requires>STRING</project-vnfd:requires>
  <project-vnfd:provides>STRING</project-vnfd:provides>
</project-vnfd:relation>

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

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:config-primitive xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:parameter>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:data-type>STRING</project-vnfd:data-type>
    <project-vnfd:mandatory>false</project-vnfd:mandatory>
    <project-vnfd:default-value>STRING</project-vnfd:default-value>
    <project-vnfd:parameter-pool>STRING</project-vnfd:parameter-pool>
    <project-vnfd:read-only>false</project-vnfd:read-only>
    <project-vnfd:hidden>false</project-vnfd:hidden>
  </project-vnfd:parameter>
  <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
</project-vnfd:config-primitive>

XML Sample

<project-vnfd:config-primitive xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:parameter>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:data-type>STRING</project-vnfd:data-type>
    <project-vnfd:mandatory>false</project-vnfd:mandatory>
    <project-vnfd:default-value>STRING</project-vnfd:default-value>
    <project-vnfd:parameter-pool>STRING</project-vnfd:parameter-pool>
    <project-vnfd:read-only>false</project-vnfd:read-only>
    <project-vnfd:hidden>false</project-vnfd:hidden>
  </project-vnfd:parameter>
  <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
</project-vnfd:config-primitive>

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

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:parameter xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:data-type>STRING</project-vnfd:data-type>
  <project-vnfd:mandatory>false</project-vnfd:mandatory>
  <project-vnfd:default-value>STRING</project-vnfd:default-value>
  <project-vnfd:parameter-pool>STRING</project-vnfd:parameter-pool>
  <project-vnfd:read-only>false</project-vnfd:read-only>
  <project-vnfd:hidden>false</project-vnfd:hidden>
</project-vnfd:parameter>

XML Sample

<project-vnfd:parameter xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:data-type>STRING</project-vnfd:data-type>
  <project-vnfd:mandatory>false</project-vnfd:mandatory>
  <project-vnfd:default-value>STRING</project-vnfd:default-value>
  <project-vnfd:parameter-pool>STRING</project-vnfd:parameter-pool>
  <project-vnfd:read-only>false</project-vnfd:read-only>
  <project-vnfd:hidden>false</project-vnfd:hidden>
</project-vnfd:parameter>

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

[
  {
    "seq": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:initial-config-primitive xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:seq>0</project-vnfd:seq>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:parameter>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:value>STRING</project-vnfd:value>
  </project-vnfd:parameter>
  <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
</project-vnfd:initial-config-primitive>

XML Sample

<project-vnfd:initial-config-primitive xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:seq>0</project-vnfd:seq>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:parameter>
    <project-vnfd:name>STRING</project-vnfd:name>
    <project-vnfd:value>STRING</project-vnfd:value>
  </project-vnfd:parameter>
  <project-vnfd:user-defined-script>STRING</project-vnfd:user-defined-script>
</project-vnfd:initial-config-primitive>

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

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:parameter xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:value>STRING</project-vnfd:value>
</project-vnfd:parameter>

XML Sample

<project-vnfd:parameter xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:value>STRING</project-vnfd:value>
</project-vnfd:parameter>

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

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false
}

JSON Sample

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false
}

XML Config Sample

<project-vnfd:supplemental-boot-data xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:config-file>
    <project-vnfd:source>STRING</project-vnfd:source>
    <project-vnfd:dest>STRING</project-vnfd:dest>
  </project-vnfd:config-file>
  <project-vnfd:boot-data-drive>false</project-vnfd:boot-data-drive>
</project-vnfd:supplemental-boot-data>

XML Sample

<project-vnfd:supplemental-boot-data xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:config-file>
    <project-vnfd:source>STRING</project-vnfd:source>
    <project-vnfd:dest>STRING</project-vnfd:dest>
  </project-vnfd:config-file>
  <project-vnfd:boot-data-drive>false</project-vnfd:boot-data-drive>
</project-vnfd:supplemental-boot-data>

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

[
  {
    "source": "STRING",
    "dest": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "source": "STRING",
    "dest": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:config-file xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:source>STRING</project-vnfd:source>
  <project-vnfd:dest>STRING</project-vnfd:dest>
</project-vnfd:config-file>

XML Sample

<project-vnfd:config-file xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:source>STRING</project-vnfd:source>
  <project-vnfd:dest>STRING</project-vnfd:dest>
</project-vnfd:config-file>

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

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "internal-vld-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "internal-vld-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:internal-connection-point xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:short-name>STRING</project-vnfd:short-name>
  <project-vnfd:type>VPORT</project-vnfd:type>
  <project-vnfd:port-security-enabled>true</project-vnfd:port-security-enabled>
  <project-vnfd:internal-vld-ref>STRING</project-vnfd:internal-vld-ref>
</project-vnfd:internal-connection-point>

XML Sample

<project-vnfd:internal-connection-point xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:short-name>STRING</project-vnfd:short-name>
  <project-vnfd:type>VPORT</project-vnfd:type>
  <project-vnfd:port-security-enabled>true</project-vnfd:port-security-enabled>
  <project-vnfd:internal-vld-ref>STRING</project-vnfd:internal-vld-ref>
</project-vnfd:internal-connection-point>

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

[
  {
    "name": "STRING",
    "position": 0,
    "type": "EXTERNAL",
    "mac-address": "STRING",
    "internal-connection-point-ref": "STRING",
    "external-connection-point-ref": "STRING",
    "virtual-interface": {
      "type": "VIRTIO",
      "vpci": "STRING",
      "bandwidth": 0
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "position": 0,
    "type": "EXTERNAL",
    "mac-address": "STRING",
    "internal-connection-point-ref": "STRING",
    "external-connection-point-ref": "STRING",
    "virtual-interface": {
      "type": "VIRTIO",
      "vpci": "STRING",
      "bandwidth": 0
    }
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:interface xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:position>0</project-vnfd:position>
  <project-vnfd:type>EXTERNAL</project-vnfd:type>
  <project-vnfd:mac-address>STRING</project-vnfd:mac-address>
  <project-vnfd:internal-connection-point-ref>STRING</project-vnfd:internal-connection-point-ref>
  <project-vnfd:external-connection-point-ref>STRING</project-vnfd:external-connection-point-ref>
  <project-vnfd:virtual-interface>
    <project-vnfd:type>VIRTIO</project-vnfd:type>
    <project-vnfd:vpci>STRING</project-vnfd:vpci>
    <project-vnfd:bandwidth>0</project-vnfd:bandwidth>
  </project-vnfd:virtual-interface>
</project-vnfd:interface>

XML Sample

<project-vnfd:interface xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:position>0</project-vnfd:position>
  <project-vnfd:type>EXTERNAL</project-vnfd:type>
  <project-vnfd:mac-address>STRING</project-vnfd:mac-address>
  <project-vnfd:internal-connection-point-ref>STRING</project-vnfd:internal-connection-point-ref>
  <project-vnfd:external-connection-point-ref>STRING</project-vnfd:external-connection-point-ref>
  <project-vnfd:virtual-interface>
    <project-vnfd:type>VIRTIO</project-vnfd:type>
    <project-vnfd:vpci>STRING</project-vnfd:vpci>
    <project-vnfd:bandwidth>0</project-vnfd:bandwidth>
  </project-vnfd:virtual-interface>
</project-vnfd:interface>

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

{
  "type": "VIRTIO",
  "vpci": "STRING",
  "bandwidth": 0
}

JSON Sample

{
  "type": "VIRTIO",
  "vpci": "STRING",
  "bandwidth": 0
}

XML Config Sample

<project-vnfd:virtual-interface xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:type>VIRTIO</project-vnfd:type>
  <project-vnfd:vpci>STRING</project-vnfd:vpci>
  <project-vnfd:bandwidth>0</project-vnfd:bandwidth>
</project-vnfd:virtual-interface>

XML Sample

<project-vnfd:virtual-interface xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:type>VIRTIO</project-vnfd:type>
  <project-vnfd:vpci>STRING</project-vnfd:vpci>
  <project-vnfd:bandwidth>0</project-vnfd:bandwidth>
</project-vnfd:virtual-interface>

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

[
  {
    "name": "STRING",
    "description": "STRING",
    "size": 0,
    "ephemeral": [null],
    "image": "STRING",
    "image-checksum": "STRING",
    "device-bus": "ide",
    "device-type": "disk"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "size": 0,
    "ephemeral": [null],
    "image": "STRING",
    "image-checksum": "STRING",
    "device-bus": "ide",
    "device-type": "disk"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:volumes xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:size>0</project-vnfd:size>
  <project-vnfd:ephemeral/>
  <project-vnfd:image>STRING</project-vnfd:image>
  <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
  <project-vnfd:device-bus>ide</project-vnfd:device-bus>
  <project-vnfd:device-type>disk</project-vnfd:device-type>
</project-vnfd:volumes>

XML Sample

<project-vnfd:volumes xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:size>0</project-vnfd:size>
  <project-vnfd:ephemeral/>
  <project-vnfd:image>STRING</project-vnfd:image>
  <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
  <project-vnfd:device-bus>ide</project-vnfd:device-bus>
  <project-vnfd:device-type>disk</project-vnfd:device-type>
</project-vnfd:volumes>

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

[
  {
    "vdu-source-ref": "STRING",
    "vdu-depends-on-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vdu-source-ref": "STRING",
    "vdu-depends-on-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:vdu-dependency xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:vdu-source-ref>STRING</project-vnfd:vdu-source-ref>
  <project-vnfd:vdu-depends-on-ref>STRING</project-vnfd:vdu-depends-on-ref>
</project-vnfd:vdu-dependency>

XML Sample

<project-vnfd:vdu-dependency xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:vdu-source-ref>STRING</project-vnfd:vdu-source-ref>
  <project-vnfd:vdu-depends-on-ref>STRING</project-vnfd:vdu-depends-on-ref>
</project-vnfd:vdu-dependency>

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

[
  {
    "path": "STRING",
    "https": false,
    "port": 0,
    "username": "STRING",
    "password": "STRING",
    "polling-interval-secs": 2,
    "method": "GET",
    "headers": [
      {
        "key": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "path": "STRING",
    "https": false,
    "port": 0,
    "username": "STRING",
    "password": "STRING",
    "polling-interval-secs": 2,
    "method": "GET",
    "headers": [
      {
        "key": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:http-endpoint xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:path>STRING</project-vnfd:path>
  <project-vnfd:https>false</project-vnfd:https>
  <project-vnfd:port>0</project-vnfd:port>
  <project-vnfd:username>STRING</project-vnfd:username>
  <project-vnfd:password>STRING</project-vnfd:password>
  <project-vnfd:polling-interval-secs>2</project-vnfd:polling-interval-secs>
  <project-vnfd:method>GET</project-vnfd:method>
  <project-vnfd:headers>
    <project-vnfd:key>STRING</project-vnfd:key>
    <project-vnfd:value>STRING</project-vnfd:value>
  </project-vnfd:headers>
</project-vnfd:http-endpoint>

XML Sample

<project-vnfd:http-endpoint xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:path>STRING</project-vnfd:path>
  <project-vnfd:https>false</project-vnfd:https>
  <project-vnfd:port>0</project-vnfd:port>
  <project-vnfd:username>STRING</project-vnfd:username>
  <project-vnfd:password>STRING</project-vnfd:password>
  <project-vnfd:polling-interval-secs>2</project-vnfd:polling-interval-secs>
  <project-vnfd:method>GET</project-vnfd:method>
  <project-vnfd:headers>
    <project-vnfd:key>STRING</project-vnfd:key>
    <project-vnfd:value>STRING</project-vnfd:value>
  </project-vnfd:headers>
</project-vnfd:http-endpoint>

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

[
  {
    "key": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:headers xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:key>STRING</project-vnfd:key>
  <project-vnfd:value>STRING</project-vnfd:value>
</project-vnfd:headers>

XML Sample

<project-vnfd:headers xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:key>STRING</project-vnfd:key>
  <project-vnfd:value>STRING</project-vnfd:value>
</project-vnfd:headers>

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

[
  {
    "id": "STRING",
    "name": "STRING",
    "http-endpoint-ref": "STRING",
    "json-query-method": "NAMEKEY",
    "json-query-params": {
      "json-path": "STRING",
      "object-path": "STRING"
    },
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "http-endpoint-ref": "STRING",
    "json-query-method": "NAMEKEY",
    "json-query-params": {
      "json-path": "STRING",
      "object-path": "STRING"
    },
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:monitoring-param xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:http-endpoint-ref>STRING</project-vnfd:http-endpoint-ref>
  <project-vnfd:json-query-method>NAMEKEY</project-vnfd:json-query-method>
  <project-vnfd:json-query-params>
    <project-vnfd:json-path>STRING</project-vnfd:json-path>
    <project-vnfd:object-path>STRING</project-vnfd:object-path>
  </project-vnfd:json-query-params>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:group-tag>STRING</project-vnfd:group-tag>
  <project-vnfd:widget-type>COUNTER</project-vnfd:widget-type>
  <project-vnfd:units>STRING</project-vnfd:units>
  <project-vnfd:value-type>INT</project-vnfd:value-type>
  <project-vnfd:numeric-constraints>
    <project-vnfd:min-value>0</project-vnfd:min-value>
    <project-vnfd:max-value>0</project-vnfd:max-value>
  </project-vnfd:numeric-constraints>
  <project-vnfd:text-constraints>
    <project-vnfd:min-length>0</project-vnfd:min-length>
    <project-vnfd:max-length>0</project-vnfd:max-length>
  </project-vnfd:text-constraints>
  <project-vnfd:value-integer>0</project-vnfd:value-integer>
  <project-vnfd:value-decimal>0.0</project-vnfd:value-decimal>
  <project-vnfd:value-string>STRING</project-vnfd:value-string>
</project-vnfd:monitoring-param>

XML Sample

<project-vnfd:monitoring-param xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:id>STRING</project-vnfd:id>
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:http-endpoint-ref>STRING</project-vnfd:http-endpoint-ref>
  <project-vnfd:json-query-method>NAMEKEY</project-vnfd:json-query-method>
  <project-vnfd:json-query-params>
    <project-vnfd:json-path>STRING</project-vnfd:json-path>
    <project-vnfd:object-path>STRING</project-vnfd:object-path>
  </project-vnfd:json-query-params>
  <project-vnfd:description>STRING</project-vnfd:description>
  <project-vnfd:group-tag>STRING</project-vnfd:group-tag>
  <project-vnfd:widget-type>COUNTER</project-vnfd:widget-type>
  <project-vnfd:units>STRING</project-vnfd:units>
  <project-vnfd:value-type>INT</project-vnfd:value-type>
  <project-vnfd:numeric-constraints>
    <project-vnfd:min-value>0</project-vnfd:min-value>
    <project-vnfd:max-value>0</project-vnfd:max-value>
  </project-vnfd:numeric-constraints>
  <project-vnfd:text-constraints>
    <project-vnfd:min-length>0</project-vnfd:min-length>
    <project-vnfd:max-length>0</project-vnfd:max-length>
  </project-vnfd:text-constraints>
  <project-vnfd:value-integer>0</project-vnfd:value-integer>
  <project-vnfd:value-decimal>0.0</project-vnfd:value-decimal>
  <project-vnfd:value-string>STRING</project-vnfd:value-string>
</project-vnfd:monitoring-param>

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-path": "STRING",
  "object-path": "STRING"
}

JSON Sample

{
  "json-path": "STRING",
  "object-path": "STRING"
}

XML Config Sample

<project-vnfd:json-query-params xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:json-path>STRING</project-vnfd:json-path>
  <project-vnfd:object-path>STRING</project-vnfd:object-path>
</project-vnfd:json-query-params>

XML Sample

<project-vnfd:json-query-params xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:json-path>STRING</project-vnfd:json-path>
  <project-vnfd:object-path>STRING</project-vnfd:object-path>
</project-vnfd:json-query-params>

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

{
  "min-value": 0,
  "max-value": 0
}

JSON Sample

{
  "min-value": 0,
  "max-value": 0
}

XML Config Sample

<project-vnfd:numeric-constraints xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:min-value>0</project-vnfd:min-value>
  <project-vnfd:max-value>0</project-vnfd:max-value>
</project-vnfd:numeric-constraints>

XML Sample

<project-vnfd:numeric-constraints xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:min-value>0</project-vnfd:min-value>
  <project-vnfd:max-value>0</project-vnfd:max-value>
</project-vnfd:numeric-constraints>

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

{
  "min-length": 0,
  "max-length": 0
}

JSON Sample

{
  "min-length": 0,
  "max-length": 0
}

XML Config Sample

<project-vnfd:text-constraints xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:min-length>0</project-vnfd:min-length>
  <project-vnfd:max-length>0</project-vnfd:max-length>
</project-vnfd:text-constraints>

XML Sample

<project-vnfd:text-constraints xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:min-length>0</project-vnfd:min-length>
  <project-vnfd:max-length>0</project-vnfd:max-length>
</project-vnfd:text-constraints>

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

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vdus": [
      {
        "member-vdu-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vdus": [
      {
        "member-vdu-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:placement-groups xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:requirement>STRING</project-vnfd:requirement>
  <project-vnfd:strategy>COLOCATION</project-vnfd:strategy>
  <project-vnfd:member-vdus>
    <project-vnfd:member-vdu-ref>STRING</project-vnfd:member-vdu-ref>
  </project-vnfd:member-vdus>
</project-vnfd:placement-groups>

XML Sample

<project-vnfd:placement-groups xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:name>STRING</project-vnfd:name>
  <project-vnfd:requirement>STRING</project-vnfd:requirement>
  <project-vnfd:strategy>COLOCATION</project-vnfd:strategy>
  <project-vnfd:member-vdus>
    <project-vnfd:member-vdu-ref>STRING</project-vnfd:member-vdu-ref>
  </project-vnfd:member-vdus>
</project-vnfd:placement-groups>

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

[
  {
    "member-vdu-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vdu-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<project-vnfd:member-vdus xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:member-vdu-ref>STRING</project-vnfd:member-vdu-ref>
</project-vnfd:member-vdus>

XML Sample

<project-vnfd:member-vdus xmlns:project-vnfd="http://riftio.com/ns/riftware-1.0/project-vnfd">
  <project-vnfd:member-vdu-ref>STRING</project-vnfd:member-vdu-ref>
</project-vnfd:member-vdus>

nsr:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path	/rw-project:project/nsr:key-pair
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/nsr:key-pair[nsr:name='STRING']
RW.REST URI Path	/rw-project:project/STRING/nsr:key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Config Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:key-pair xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:key>STRING</nsr:key>
</nsr:key-pair>

XML Sample

<nsr:key-pair xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:key>STRING</nsr:key>
</nsr:key-pair>

nsr:ns-instance-config

Key Identifiers:

XPath Path	/rw-project:project/nsr:ns-instance-config
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config
RW.REST URI Path	/rw-project:project/STRING/nsr:ns-instance-config

Fields

Name	Type	Description
nsr	LIST

JSON Config Sample

{
  "nsr": [
    {
      "schema-version": "v3.0",
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "description": "STRING",
      "admin-status": "ENABLED",
      "nsd": { ... },
      "input-parameter": [ { ... }, { ... } ],
      "scaling-group": [ { ... }, { ... } ],
      "nsd-placement-group-maps": [ { ... }, { ... } ],
      "vnfd-placement-group-maps": [ { ... }, { ... } ],
      "ssh-authorized-key": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "nsr": [
    {
      "schema-version": "v3.0",
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "description": "STRING",
      "admin-status": "ENABLED",
      "nsd": { ... },
      "input-parameter": [ { ... }, { ... } ],
      "scaling-group": [ { ... }, { ... } ],
      "nsd-placement-group-maps": [ { ... }, { ... } ],
      "vnfd-placement-group-maps": [ { ... }, { ... } ],
      "ssh-authorized-key": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<nsr:ns-instance-config xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr>
    <nsr:id>STRING</nsr:id>
    <nsr:schema-version>v3.0</nsr:schema-version>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:description>STRING</nsr:description>
    <nsr:admin-status>ENABLED</nsr:admin-status>
    <nsr:nsd>...</nsr:nsd>
    <nsr:input-parameter>...</nsr:input-parameter>
    <nsr:scaling-group>...</nsr:scaling-group>
    <nsr:nsd-placement-group-maps>...</nsr:nsd-placement-group-maps>
    <nsr:vnfd-placement-group-maps>...</nsr:vnfd-placement-group-maps>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
    <nsr:user>...</nsr:user>
  </nsr:nsr>
</nsr:ns-instance-config>

XML Sample

<nsr:ns-instance-config xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr>
    <nsr:id>STRING</nsr:id>
    <nsr:schema-version>v3.0</nsr:schema-version>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:description>STRING</nsr:description>
    <nsr:admin-status>ENABLED</nsr:admin-status>
    <nsr:nsd>...</nsr:nsd>
    <nsr:input-parameter>...</nsr:input-parameter>
    <nsr:scaling-group>...</nsr:scaling-group>
    <nsr:nsd-placement-group-maps>...</nsr:nsd-placement-group-maps>
    <nsr:vnfd-placement-group-maps>...</nsr:vnfd-placement-group-maps>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
    <nsr:user>...</nsr:user>
  </nsr:nsr>
</nsr:ns-instance-config>

nsr:nsr

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING

Fields

Name	Type	Description
schema-version	STRING	Schema version for the NSR. If unspecified, it assumes v3.0
id	STRING	Identifier for the NSR.
name	STRING	NSR name.
short-name	STRING	NSR short name.
description	STRING	NSR description.
admin-status	ENUM	This is the administrative status of the NS instance
nsd	CONTAINER	NS descriptor used to instantiate this NS
input-parameter	LIST	List of input parameters
scaling-group	LIST	List of ns scaling group instances
nsd-placement-group-maps	LIST	Mapping from mano-placement groups construct from NSD to cloud platform placement group construct
vnfd-placement-group-maps	LIST	Mapping from mano-placement groups construct from VNFD to cloud platform placement group construct
ssh-authorized-key	LIST	List of authorized ssh keys as part of cloud-config
user	LIST	Used to configure the list of public keys to be injected as part of ns instantiation

JSON Config Sample

[
  {
    "schema-version": "v3.0",
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "description": "STRING",
    "admin-status": "ENABLED",
    "nsd": {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "connection-point": [ { ... }, { ... } ],
      "scaling-group-descriptor": [ { ... }, { ... } ],
      "vnffgd": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "initial-service-primitive": [ { ... }, { ... } ],
      "terminate-service-primitive": [ { ... }, { ... } ],
      "input-parameter-xpath": [ { ... }, { ... } ],
      "parameter-pool": [ { ... }, { ... } ],
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ],
      "vld": [ { ... }, { ... } ],
      "constituent-vnfd": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ],
      "vnf-dependency": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "service-primitive": [ { ... }, { ... } ]
    },
    "input-parameter": [
      {
        "xpath": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "scaling-group": [
      {
        "scaling-group-name-ref": "STRING",
        "instance": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "nsd-placement-group-maps": [
      {
        "placement-group-ref": "STRING",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "vnfd-placement-group-maps": [
      {
        "vnfd-id-ref": "STRING",
        "placement-group-ref": "STRING",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "ssh-authorized-key": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "schema-version": "v3.0",
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "description": "STRING",
    "admin-status": "ENABLED",
    "nsd": {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "connection-point": [ { ... }, { ... } ],
      "scaling-group-descriptor": [ { ... }, { ... } ],
      "vnffgd": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "initial-service-primitive": [ { ... }, { ... } ],
      "terminate-service-primitive": [ { ... }, { ... } ],
      "input-parameter-xpath": [ { ... }, { ... } ],
      "parameter-pool": [ { ... }, { ... } ],
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ],
      "vld": [ { ... }, { ... } ],
      "constituent-vnfd": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ],
      "vnf-dependency": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "service-primitive": [ { ... }, { ... } ]
    },
    "input-parameter": [
      {
        "xpath": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "scaling-group": [
      {
        "scaling-group-name-ref": "STRING",
        "instance": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "nsd-placement-group-maps": [
      {
        "placement-group-ref": "STRING",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "vnfd-placement-group-maps": [
      {
        "vnfd-id-ref": "STRING",
        "placement-group-ref": "STRING",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "ssh-authorized-key": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:nsr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:schema-version>v3.0</nsr:schema-version>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:description>STRING</nsr:description>
  <nsr:admin-status>ENABLED</nsr:admin-status>
  <nsr:nsd>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:vendor>STRING</nsr:vendor>
    <nsr:logo>STRING</nsr:logo>
    <nsr:description>STRING</nsr:description>
    <nsr:version>STRING</nsr:version>
    <nsr:connection-point>...</nsr:connection-point>
    <nsr:scaling-group-descriptor>...</nsr:scaling-group-descriptor>
    <nsr:vnffgd>...</nsr:vnffgd>
    <nsr:ip-profiles>...</nsr:ip-profiles>
    <nsr:initial-service-primitive>...</nsr:initial-service-primitive>
    <nsr:terminate-service-primitive>...</nsr:terminate-service-primitive>
    <nsr:input-parameter-xpath>...</nsr:input-parameter-xpath>
    <nsr:parameter-pool>...</nsr:parameter-pool>
    <nsr:key-pair>...</nsr:key-pair>
    <nsr:user>...</nsr:user>
    <nsr:vld>...</nsr:vld>
    <nsr:constituent-vnfd>...</nsr:constituent-vnfd>
    <nsr:placement-groups>...</nsr:placement-groups>
    <nsr:vnf-dependency>...</nsr:vnf-dependency>
    <nsr:monitoring-param>...</nsr:monitoring-param>
    <nsr:service-primitive>...</nsr:service-primitive>
  </nsr:nsd>
  <nsr:input-parameter>
    <nsr:xpath>STRING</nsr:xpath>
    <nsr:value>STRING</nsr:value>
  </nsr:input-parameter>
  <nsr:scaling-group>
    <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
    <nsr:instance>...</nsr:instance>
  </nsr:scaling-group>
  <nsr:nsd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:nsd-placement-group-maps>
  <nsr:vnfd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:vnfd-placement-group-maps>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
  </nsr:user>
</nsr:nsr>

XML Sample

<nsr:nsr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:schema-version>v3.0</nsr:schema-version>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:description>STRING</nsr:description>
  <nsr:admin-status>ENABLED</nsr:admin-status>
  <nsr:nsd>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:vendor>STRING</nsr:vendor>
    <nsr:logo>STRING</nsr:logo>
    <nsr:description>STRING</nsr:description>
    <nsr:version>STRING</nsr:version>
    <nsr:connection-point>...</nsr:connection-point>
    <nsr:scaling-group-descriptor>...</nsr:scaling-group-descriptor>
    <nsr:vnffgd>...</nsr:vnffgd>
    <nsr:ip-profiles>...</nsr:ip-profiles>
    <nsr:initial-service-primitive>...</nsr:initial-service-primitive>
    <nsr:terminate-service-primitive>...</nsr:terminate-service-primitive>
    <nsr:input-parameter-xpath>...</nsr:input-parameter-xpath>
    <nsr:parameter-pool>...</nsr:parameter-pool>
    <nsr:key-pair>...</nsr:key-pair>
    <nsr:user>...</nsr:user>
    <nsr:vld>...</nsr:vld>
    <nsr:constituent-vnfd>...</nsr:constituent-vnfd>
    <nsr:placement-groups>...</nsr:placement-groups>
    <nsr:vnf-dependency>...</nsr:vnf-dependency>
    <nsr:monitoring-param>...</nsr:monitoring-param>
    <nsr:service-primitive>...</nsr:service-primitive>
  </nsr:nsd>
  <nsr:input-parameter>
    <nsr:xpath>STRING</nsr:xpath>
    <nsr:value>STRING</nsr:value>
  </nsr:input-parameter>
  <nsr:scaling-group>
    <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
    <nsr:instance>...</nsr:instance>
  </nsr:scaling-group>
  <nsr:nsd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:nsd-placement-group-maps>
  <nsr:vnfd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:vnfd-placement-group-maps>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
  </nsr:user>
</nsr:nsr>

nsr:nsd

NS descriptor used to instantiate this NS

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd

Fields

Name	Type	Description
id	STRING	Identifier for the NSD.
name	STRING	NSD name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Vendor of the NSD.
logo	STRING	File path for the vendor specific logo. For example icons/mylogo.png. The logo should be part of the network service
description	STRING	Description of the NSD.
version	STRING	Version of the NSD
connection-point	LIST	List for external connection points. Each NS has one or more external connection points. As the name implies that external connection points are used for connecting the NS to other NS or to external networks. Each NS exposes these connection points to the orchestrator. The orchestrator can construct network service chains by connecting the connection points between different NS.
scaling-group-descriptor	LIST	scaling group descriptor within this network service. The scaling group defines a group of VNFs, and the ratio of VNFs in the network service that is used as target for scaling action
vnffgd	LIST	List of VNF Forwarding Graph Descriptors (VNFFGD).
ip-profiles	LIST	List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
initial-service-primitive	LIST	Initial set of service primitives for NSD.
terminate-service-primitive	LIST	Set of service primitives during termination for NSD.
input-parameter-xpath	LIST	List of xpaths to parameters inside the NSD the can be customized during the instantiation.
parameter-pool	LIST	Pool of parameter values which must be pulled from during configuration
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation
user	LIST	List of users to be added through cloud-config
vld	LIST
constituent-vnfd	LIST	List of VNFDs that are part of this network service.
placement-groups	LIST	List of placement groups at NS level
vnf-dependency	LIST	List of VNF dependencies.
monitoring-param	LIST
service-primitive	LIST	Network service level service primitives.

JSON Config Sample

{
  "id": "STRING",
  "name": "STRING",
  "short-name": "STRING",
  "vendor": "STRING",
  "logo": "STRING",
  "description": "STRING",
  "version": "STRING",
  "connection-point": [
    {
      "name": "STRING",
      "type": "VPORT"
    }, {
      ...
    }
  ],
  "scaling-group-descriptor": [
    {
      "name": "STRING",
      "scaling-policy": [ { ... }, { ... } ],
      "vnfd-member": [ { ... }, { ... } ],
      "min-instance-count": 0,
      "max-instance-count": 10,
      "scaling-config-action": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnffgd": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "rsp": [ { ... }, { ... } ],
      "classifier": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "ip-profiles": [
    {
      "name": "STRING",
      "description": "STRING",
      "ip-profile-params": { ... }
    }, {
      ...
    }
  ],
  "initial-service-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "user-defined-script": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "terminate-service-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "user-defined-script": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "input-parameter-xpath": [
    {
      "xpath": "STRING",
      "label": "STRING",
      "default-value": "STRING"
    }, {
      ...
    }
  ],
  "parameter-pool": [
    {
      "name": "STRING",
      "range": { ... }
    }, {
      ...
    }
  ],
  "key-pair": [
    {
      "name": "STRING",
      "key": "STRING"
    }, {
      ...
    }
  ],
  "user": [
    {
      "name": "STRING",
      "user-info": "STRING",
      "key-pair": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vld": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "type": "ELAN",
      "root-bandwidth": 0,
      "leaf-bandwidth": 0,
      "provider-network": { ... },
      "mgmt-network": false,
      "vim-network-name": "STRING",
      "ip-profile-ref": "STRING",
      "vnfd-connection-point-ref": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "constituent-vnfd": [
    {
      "member-vnf-index": 0,
      "vnfd-id-ref": "STRING",
      "start-by-default": true
    }, {
      ...
    }
  ],
  "placement-groups": [
    {
      "name": "STRING",
      "requirement": "STRING",
      "strategy": "COLOCATION",
      "member-vnfd": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnf-dependency": [
    {
      "vnf-source-ref": "STRING",
      "vnf-depends-on-ref": "STRING"
    }, {
      ...
    }
  ],
  "monitoring-param": [
    {
      "id": "STRING",
      "name": "STRING",
      "value-type": "INT",
      "numeric-constraints": { ... },
      "text-constraints": { ... },
      "value-integer": 0,
      "value-decimal": 0.0,
      "value-string": "STRING",
      "description": "STRING",
      "group-tag": "STRING",
      "widget-type": "COUNTER",
      "units": "STRING",
      "aggregation-type": "AVERAGE",
      "vnfd-monitoring-param": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "service-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "parameter-group": [ { ... }, { ... } ],
      "vnf-primitive-group": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "id": "STRING",
  "name": "STRING",
  "short-name": "STRING",
  "vendor": "STRING",
  "logo": "STRING",
  "description": "STRING",
  "version": "STRING",
  "connection-point": [
    {
      "name": "STRING",
      "type": "VPORT"
    }, {
      ...
    }
  ],
  "scaling-group-descriptor": [
    {
      "name": "STRING",
      "scaling-policy": [ { ... }, { ... } ],
      "vnfd-member": [ { ... }, { ... } ],
      "min-instance-count": 0,
      "max-instance-count": 10,
      "scaling-config-action": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnffgd": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "rsp": [ { ... }, { ... } ],
      "classifier": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "ip-profiles": [
    {
      "name": "STRING",
      "description": "STRING",
      "ip-profile-params": { ... }
    }, {
      ...
    }
  ],
  "initial-service-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "user-defined-script": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "terminate-service-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "user-defined-script": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "input-parameter-xpath": [
    {
      "xpath": "STRING",
      "label": "STRING",
      "default-value": "STRING"
    }, {
      ...
    }
  ],
  "parameter-pool": [
    {
      "name": "STRING",
      "range": { ... }
    }, {
      ...
    }
  ],
  "key-pair": [
    {
      "name": "STRING",
      "key": "STRING"
    }, {
      ...
    }
  ],
  "user": [
    {
      "name": "STRING",
      "user-info": "STRING",
      "key-pair": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vld": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "type": "ELAN",
      "root-bandwidth": 0,
      "leaf-bandwidth": 0,
      "provider-network": { ... },
      "mgmt-network": false,
      "vim-network-name": "STRING",
      "ip-profile-ref": "STRING",
      "vnfd-connection-point-ref": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "constituent-vnfd": [
    {
      "member-vnf-index": 0,
      "vnfd-id-ref": "STRING",
      "start-by-default": true
    }, {
      ...
    }
  ],
  "placement-groups": [
    {
      "name": "STRING",
      "requirement": "STRING",
      "strategy": "COLOCATION",
      "member-vnfd": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnf-dependency": [
    {
      "vnf-source-ref": "STRING",
      "vnf-depends-on-ref": "STRING"
    }, {
      ...
    }
  ],
  "monitoring-param": [
    {
      "id": "STRING",
      "name": "STRING",
      "value-type": "INT",
      "numeric-constraints": { ... },
      "text-constraints": { ... },
      "value-integer": 0,
      "value-decimal": 0.0,
      "value-string": "STRING",
      "description": "STRING",
      "group-tag": "STRING",
      "widget-type": "COUNTER",
      "units": "STRING",
      "aggregation-type": "AVERAGE",
      "vnfd-monitoring-param": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "service-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "parameter-group": [ { ... }, { ... } ],
      "vnf-primitive-group": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<nsr:nsd xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:vendor>STRING</nsr:vendor>
  <nsr:logo>STRING</nsr:logo>
  <nsr:description>STRING</nsr:description>
  <nsr:version>STRING</nsr:version>
  <nsr:connection-point>
    <nsr:name>STRING</nsr:name>
    <nsr:type>VPORT</nsr:type>
  </nsr:connection-point>
  <nsr:scaling-group-descriptor>
    <nsr:name>STRING</nsr:name>
    <nsr:scaling-policy>...</nsr:scaling-policy>
    <nsr:vnfd-member>...</nsr:vnfd-member>
    <nsr:min-instance-count>0</nsr:min-instance-count>
    <nsr:max-instance-count>10</nsr:max-instance-count>
    <nsr:scaling-config-action>...</nsr:scaling-config-action>
  </nsr:scaling-group-descriptor>
  <nsr:vnffgd>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:vendor>STRING</nsr:vendor>
    <nsr:description>STRING</nsr:description>
    <nsr:version>STRING</nsr:version>
    <nsr:rsp>...</nsr:rsp>
    <nsr:classifier>...</nsr:classifier>
  </nsr:vnffgd>
  <nsr:ip-profiles>
    <nsr:name>STRING</nsr:name>
    <nsr:description>STRING</nsr:description>
    <nsr:ip-profile-params>...</nsr:ip-profile-params>
  </nsr:ip-profiles>
  <nsr:initial-service-primitive>
    <nsr:seq>0</nsr:seq>
    <nsr:name>STRING</nsr:name>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
    <nsr:parameter>...</nsr:parameter>
  </nsr:initial-service-primitive>
  <nsr:terminate-service-primitive>
    <nsr:seq>0</nsr:seq>
    <nsr:name>STRING</nsr:name>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
    <nsr:parameter>...</nsr:parameter>
  </nsr:terminate-service-primitive>
  <nsr:input-parameter-xpath>
    <nsr:xpath>STRING</nsr:xpath>
    <nsr:label>STRING</nsr:label>
    <nsr:default-value>STRING</nsr:default-value>
  </nsr:input-parameter-xpath>
  <nsr:parameter-pool>
    <nsr:name>STRING</nsr:name>
    <nsr:range>...</nsr:range>
  </nsr:parameter-pool>
  <nsr:key-pair>
    <nsr:name>STRING</nsr:name>
    <nsr:key>STRING</nsr:key>
  </nsr:key-pair>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:key-pair>...</nsr:key-pair>
  </nsr:user>
  <nsr:vld>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:vendor>STRING</nsr:vendor>
    <nsr:description>STRING</nsr:description>
    <nsr:version>STRING</nsr:version>
    <nsr:type>ELAN</nsr:type>
    <nsr:root-bandwidth>0</nsr:root-bandwidth>
    <nsr:leaf-bandwidth>0</nsr:leaf-bandwidth>
    <nsr:provider-network>...</nsr:provider-network>
    <nsr:mgmt-network>false</nsr:mgmt-network>
    <nsr:vim-network-name>STRING</nsr:vim-network-name>
    <nsr:ip-profile-ref>STRING</nsr:ip-profile-ref>
    <nsr:vnfd-connection-point-ref>...</nsr:vnfd-connection-point-ref>
  </nsr:vld>
  <nsr:constituent-vnfd>
    <nsr:member-vnf-index>0</nsr:member-vnf-index>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:start-by-default>true</nsr:start-by-default>
  </nsr:constituent-vnfd>
  <nsr:placement-groups>
    <nsr:name>STRING</nsr:name>
    <nsr:requirement>STRING</nsr:requirement>
    <nsr:strategy>COLOCATION</nsr:strategy>
    <nsr:member-vnfd>...</nsr:member-vnfd>
  </nsr:placement-groups>
  <nsr:vnf-dependency>
    <nsr:vnf-source-ref>STRING</nsr:vnf-source-ref>
    <nsr:vnf-depends-on-ref>STRING</nsr:vnf-depends-on-ref>
  </nsr:vnf-dependency>
  <nsr:monitoring-param>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:value-type>INT</nsr:value-type>
    <nsr:numeric-constraints>...</nsr:numeric-constraints>
    <nsr:text-constraints>...</nsr:text-constraints>
    <nsr:value-integer>0</nsr:value-integer>
    <nsr:value-decimal>0.0</nsr:value-decimal>
    <nsr:value-string>STRING</nsr:value-string>
    <nsr:description>STRING</nsr:description>
    <nsr:group-tag>STRING</nsr:group-tag>
    <nsr:widget-type>COUNTER</nsr:widget-type>
    <nsr:units>STRING</nsr:units>
    <nsr:aggregation-type>AVERAGE</nsr:aggregation-type>
    <nsr:vnfd-monitoring-param>...</nsr:vnfd-monitoring-param>
  </nsr:monitoring-param>
  <nsr:service-primitive>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:parameter-group>...</nsr:parameter-group>
    <nsr:vnf-primitive-group>...</nsr:vnf-primitive-group>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
  </nsr:service-primitive>
</nsr:nsd>

XML Sample

<nsr:nsd xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:vendor>STRING</nsr:vendor>
  <nsr:logo>STRING</nsr:logo>
  <nsr:description>STRING</nsr:description>
  <nsr:version>STRING</nsr:version>
  <nsr:connection-point>
    <nsr:name>STRING</nsr:name>
    <nsr:type>VPORT</nsr:type>
  </nsr:connection-point>
  <nsr:scaling-group-descriptor>
    <nsr:name>STRING</nsr:name>
    <nsr:scaling-policy>...</nsr:scaling-policy>
    <nsr:vnfd-member>...</nsr:vnfd-member>
    <nsr:min-instance-count>0</nsr:min-instance-count>
    <nsr:max-instance-count>10</nsr:max-instance-count>
    <nsr:scaling-config-action>...</nsr:scaling-config-action>
  </nsr:scaling-group-descriptor>
  <nsr:vnffgd>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:vendor>STRING</nsr:vendor>
    <nsr:description>STRING</nsr:description>
    <nsr:version>STRING</nsr:version>
    <nsr:rsp>...</nsr:rsp>
    <nsr:classifier>...</nsr:classifier>
  </nsr:vnffgd>
  <nsr:ip-profiles>
    <nsr:name>STRING</nsr:name>
    <nsr:description>STRING</nsr:description>
    <nsr:ip-profile-params>...</nsr:ip-profile-params>
  </nsr:ip-profiles>
  <nsr:initial-service-primitive>
    <nsr:seq>0</nsr:seq>
    <nsr:name>STRING</nsr:name>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
    <nsr:parameter>...</nsr:parameter>
  </nsr:initial-service-primitive>
  <nsr:terminate-service-primitive>
    <nsr:seq>0</nsr:seq>
    <nsr:name>STRING</nsr:name>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
    <nsr:parameter>...</nsr:parameter>
  </nsr:terminate-service-primitive>
  <nsr:input-parameter-xpath>
    <nsr:xpath>STRING</nsr:xpath>
    <nsr:label>STRING</nsr:label>
    <nsr:default-value>STRING</nsr:default-value>
  </nsr:input-parameter-xpath>
  <nsr:parameter-pool>
    <nsr:name>STRING</nsr:name>
    <nsr:range>...</nsr:range>
  </nsr:parameter-pool>
  <nsr:key-pair>
    <nsr:name>STRING</nsr:name>
    <nsr:key>STRING</nsr:key>
  </nsr:key-pair>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:key-pair>...</nsr:key-pair>
  </nsr:user>
  <nsr:vld>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:vendor>STRING</nsr:vendor>
    <nsr:description>STRING</nsr:description>
    <nsr:version>STRING</nsr:version>
    <nsr:type>ELAN</nsr:type>
    <nsr:root-bandwidth>0</nsr:root-bandwidth>
    <nsr:leaf-bandwidth>0</nsr:leaf-bandwidth>
    <nsr:provider-network>...</nsr:provider-network>
    <nsr:mgmt-network>false</nsr:mgmt-network>
    <nsr:vim-network-name>STRING</nsr:vim-network-name>
    <nsr:ip-profile-ref>STRING</nsr:ip-profile-ref>
    <nsr:vnfd-connection-point-ref>...</nsr:vnfd-connection-point-ref>
  </nsr:vld>
  <nsr:constituent-vnfd>
    <nsr:member-vnf-index>0</nsr:member-vnf-index>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:start-by-default>true</nsr:start-by-default>
  </nsr:constituent-vnfd>
  <nsr:placement-groups>
    <nsr:name>STRING</nsr:name>
    <nsr:requirement>STRING</nsr:requirement>
    <nsr:strategy>COLOCATION</nsr:strategy>
    <nsr:member-vnfd>...</nsr:member-vnfd>
  </nsr:placement-groups>
  <nsr:vnf-dependency>
    <nsr:vnf-source-ref>STRING</nsr:vnf-source-ref>
    <nsr:vnf-depends-on-ref>STRING</nsr:vnf-depends-on-ref>
  </nsr:vnf-dependency>
  <nsr:monitoring-param>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:value-type>INT</nsr:value-type>
    <nsr:numeric-constraints>...</nsr:numeric-constraints>
    <nsr:text-constraints>...</nsr:text-constraints>
    <nsr:value-integer>0</nsr:value-integer>
    <nsr:value-decimal>0.0</nsr:value-decimal>
    <nsr:value-string>STRING</nsr:value-string>
    <nsr:description>STRING</nsr:description>
    <nsr:group-tag>STRING</nsr:group-tag>
    <nsr:widget-type>COUNTER</nsr:widget-type>
    <nsr:units>STRING</nsr:units>
    <nsr:aggregation-type>AVERAGE</nsr:aggregation-type>
    <nsr:vnfd-monitoring-param>...</nsr:vnfd-monitoring-param>
  </nsr:monitoring-param>
  <nsr:service-primitive>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:parameter-group>...</nsr:parameter-group>
    <nsr:vnf-primitive-group>...</nsr:vnf-primitive-group>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
  </nsr:service-primitive>
</nsr:nsd>

nsr:connection-point

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:connection-point

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:connection-point[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/connection-point/STRING

Fields

Name	Type	Description
name	STRING	Name of the NS connection point.
type	ENUM	Type of the connection point.

JSON Config Sample

[
  {
    "name": "STRING",
    "type": "VPORT"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "type": "VPORT"
  }, {
    ...
  }
]

XML Config Sample

<nsr:connection-point xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:type>VPORT</nsr:type>
</nsr:connection-point>

XML Sample

<nsr:connection-point xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:type>VPORT</nsr:type>
</nsr:connection-point>

nsr:scaling-group-descriptor

scaling group descriptor within this network service. The scaling group defines a group of VNFs, and the ratio of VNFs in the network service that is used as target for scaling action

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:scaling-group-descriptor[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/scaling-group-descriptor/STRING

Fields

Name	Type	Description
name	STRING	Name of this scaling group.
scaling-policy	LIST
vnfd-member	LIST	List of VNFs in this scaling group
min-instance-count	UINT32	Minimum instances of the scaling group which are allowed. These instances are created by default when the network service is instantiated.
max-instance-count	UINT32	Maximum instances of this scaling group that are allowed in a single network service. The network service scaling will fail, when the number of service group instances exceed the max-instance-count specified.
scaling-config-action	LIST	List of scaling config actions

JSON Config Sample

[
  {
    "name": "STRING",
    "scaling-policy": [
      {
        "name": "STRING",
        "scaling-type": "manual",
        "enabled": true,
        "scale-in-operation-type": "AND",
        "scale-out-operation-type": "OR",
        "threshold-time": 0,
        "cooldown-time": 0,
        "scaling-criteria": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnfd-member": [
      {
        "member-vnf-index-ref": 0,
        "count": 1
      }, {
        ...
      }
    ],
    "min-instance-count": 0,
    "max-instance-count": 10,
    "scaling-config-action": [
      {
        "trigger": "pre-scale-in",
        "ns-service-primitive-name-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scaling-policy": [
      {
        "name": "STRING",
        "scaling-type": "manual",
        "enabled": true,
        "scale-in-operation-type": "AND",
        "scale-out-operation-type": "OR",
        "threshold-time": 0,
        "cooldown-time": 0,
        "scaling-criteria": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnfd-member": [
      {
        "member-vnf-index-ref": 0,
        "count": 1
      }, {
        ...
      }
    ],
    "min-instance-count": 0,
    "max-instance-count": 10,
    "scaling-config-action": [
      {
        "trigger": "pre-scale-in",
        "ns-service-primitive-name-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:scaling-group-descriptor xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:scaling-policy>
    <nsr:name>STRING</nsr:name>
    <nsr:scaling-type>manual</nsr:scaling-type>
    <nsr:enabled>true</nsr:enabled>
    <nsr:scale-in-operation-type>AND</nsr:scale-in-operation-type>
    <nsr:scale-out-operation-type>OR</nsr:scale-out-operation-type>
    <nsr:threshold-time>0</nsr:threshold-time>
    <nsr:cooldown-time>0</nsr:cooldown-time>
    <nsr:scaling-criteria>...</nsr:scaling-criteria>
  </nsr:scaling-policy>
  <nsr:vnfd-member>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:count>1</nsr:count>
  </nsr:vnfd-member>
  <nsr:min-instance-count>0</nsr:min-instance-count>
  <nsr:max-instance-count>10</nsr:max-instance-count>
  <nsr:scaling-config-action>
    <nsr:trigger>pre-scale-in</nsr:trigger>
    <nsr:ns-service-primitive-name-ref>STRING</nsr:ns-service-primitive-name-ref>
  </nsr:scaling-config-action>
</nsr:scaling-group-descriptor>

XML Sample

<nsr:scaling-group-descriptor xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:scaling-policy>
    <nsr:name>STRING</nsr:name>
    <nsr:scaling-type>manual</nsr:scaling-type>
    <nsr:enabled>true</nsr:enabled>
    <nsr:scale-in-operation-type>AND</nsr:scale-in-operation-type>
    <nsr:scale-out-operation-type>OR</nsr:scale-out-operation-type>
    <nsr:threshold-time>0</nsr:threshold-time>
    <nsr:cooldown-time>0</nsr:cooldown-time>
    <nsr:scaling-criteria>...</nsr:scaling-criteria>
  </nsr:scaling-policy>
  <nsr:vnfd-member>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:count>1</nsr:count>
  </nsr:vnfd-member>
  <nsr:min-instance-count>0</nsr:min-instance-count>
  <nsr:max-instance-count>10</nsr:max-instance-count>
  <nsr:scaling-config-action>
    <nsr:trigger>pre-scale-in</nsr:trigger>
    <nsr:ns-service-primitive-name-ref>STRING</nsr:ns-service-primitive-name-ref>
  </nsr:scaling-config-action>
</nsr:scaling-group-descriptor>

nsr:scaling-policy

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor/nsr:scaling-policy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:scaling-group-descriptor[nsr:name='STRING']/nsr:scaling-policy[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/scaling-group-descriptor/STRING/scaling-policy/STRING

Fields

Name	Type	Description
name	STRING	Name of the scaling policy
scaling-type	ENUM	Type of scaling
enabled	BOOLEAN	Specifies if the scaling policy can be applied
scale-in-operation-type	ENUM	Operation to be applied to check between scaling criterias to check if the scale in threshold condition has been met. Defaults to AND
scale-out-operation-type	ENUM	Operation to be applied to check between scaling criterias to check if the scale out threshold condition has been met. Defauls to OR
threshold-time	UINT32	The duration for which the criteria must hold true
cooldown-time	UINT32	The duration after a scaling-in/scaling-out action has been triggered, for which there will be no further optional
scaling-criteria	LIST	list of conditions to be met for generating scaling requests

JSON Config Sample

[
  {
    "name": "STRING",
    "scaling-type": "manual",
    "enabled": true,
    "scale-in-operation-type": "AND",
    "scale-out-operation-type": "OR",
    "threshold-time": 0,
    "cooldown-time": 0,
    "scaling-criteria": [
      {
        "name": "STRING",
        "scale-in-threshold": 0,
        "scale-out-threshold": 0,
        "ns-monitoring-param-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scaling-type": "manual",
    "enabled": true,
    "scale-in-operation-type": "AND",
    "scale-out-operation-type": "OR",
    "threshold-time": 0,
    "cooldown-time": 0,
    "scaling-criteria": [
      {
        "name": "STRING",
        "scale-in-threshold": 0,
        "scale-out-threshold": 0,
        "ns-monitoring-param-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:scaling-policy xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:scaling-type>manual</nsr:scaling-type>
  <nsr:enabled>true</nsr:enabled>
  <nsr:scale-in-operation-type>AND</nsr:scale-in-operation-type>
  <nsr:scale-out-operation-type>OR</nsr:scale-out-operation-type>
  <nsr:threshold-time>0</nsr:threshold-time>
  <nsr:cooldown-time>0</nsr:cooldown-time>
  <nsr:scaling-criteria>
    <nsr:name>STRING</nsr:name>
    <nsr:scale-in-threshold>0</nsr:scale-in-threshold>
    <nsr:scale-out-threshold>0</nsr:scale-out-threshold>
    <nsr:ns-monitoring-param-ref>STRING</nsr:ns-monitoring-param-ref>
  </nsr:scaling-criteria>
</nsr:scaling-policy>

XML Sample

<nsr:scaling-policy xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:scaling-type>manual</nsr:scaling-type>
  <nsr:enabled>true</nsr:enabled>
  <nsr:scale-in-operation-type>AND</nsr:scale-in-operation-type>
  <nsr:scale-out-operation-type>OR</nsr:scale-out-operation-type>
  <nsr:threshold-time>0</nsr:threshold-time>
  <nsr:cooldown-time>0</nsr:cooldown-time>
  <nsr:scaling-criteria>
    <nsr:name>STRING</nsr:name>
    <nsr:scale-in-threshold>0</nsr:scale-in-threshold>
    <nsr:scale-out-threshold>0</nsr:scale-out-threshold>
    <nsr:ns-monitoring-param-ref>STRING</nsr:ns-monitoring-param-ref>
  </nsr:scaling-criteria>
</nsr:scaling-policy>

nsr:scaling-criteria

list of conditions to be met for generating scaling requests

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor/nsr:scaling-policy/nsr:scaling-criteria

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:scaling-group-descriptor[nsr:name='STRING']/nsr:scaling-policy[nsr:name='STRING']/nsr:scaling-criteria[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/scaling-group-descriptor/STRING/scaling-policy/STRING/scaling-criteria/STRING

Fields

Name	Type	Description
name	STRING
scale-in-threshold	UINT64	Value below which scale-in requests are generated
scale-out-threshold	UINT64	Value above which scale-out requests are generated
ns-monitoring-param-ref	LEAFREF	Reference to the NS level monitoring parameter that is aggregated

JSON Config Sample

[
  {
    "name": "STRING",
    "scale-in-threshold": 0,
    "scale-out-threshold": 0,
    "ns-monitoring-param-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scale-in-threshold": 0,
    "scale-out-threshold": 0,
    "ns-monitoring-param-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:scaling-criteria xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:scale-in-threshold>0</nsr:scale-in-threshold>
  <nsr:scale-out-threshold>0</nsr:scale-out-threshold>
  <nsr:ns-monitoring-param-ref>STRING</nsr:ns-monitoring-param-ref>
</nsr:scaling-criteria>

XML Sample

<nsr:scaling-criteria xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:scale-in-threshold>0</nsr:scale-in-threshold>
  <nsr:scale-out-threshold>0</nsr:scale-out-threshold>
  <nsr:ns-monitoring-param-ref>STRING</nsr:ns-monitoring-param-ref>
</nsr:scaling-criteria>

nsr:vnfd-member

List of VNFs in this scaling group

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor/nsr:vnfd-member

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:scaling-group-descriptor[nsr:name='STRING']/nsr:vnfd-member[nsr:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/scaling-group-descriptor/STRING/vnfd-member/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	member VNF index of this member VNF
count	UINT32	count of this member VNF within this scaling group. The count allows to define the number of instances when a scaling action targets this scaling group

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "count": 1
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "count": 1
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnfd-member xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:count>1</nsr:count>
</nsr:vnfd-member>

XML Sample

<nsr:vnfd-member xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:count>1</nsr:count>
</nsr:vnfd-member>

nsr:scaling-config-action

List of scaling config actions

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor/nsr:scaling-config-action

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:scaling-group-descriptor[nsr:name='STRING']/nsr:scaling-config-action[nsr:trigger='pre-scale-in']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/scaling-group-descriptor/STRING/scaling-config-action/pre-scale-in

Fields

Name	Type	Description
trigger	ENUM	scaling trigger
ns-service-primitive-name-ref	LEAFREF	Reference to the NS service primitive

JSON Config Sample

[
  {
    "trigger": "pre-scale-in",
    "ns-service-primitive-name-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "trigger": "pre-scale-in",
    "ns-service-primitive-name-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:scaling-config-action xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:trigger>pre-scale-in</nsr:trigger>
  <nsr:ns-service-primitive-name-ref>STRING</nsr:ns-service-primitive-name-ref>
</nsr:scaling-config-action>

XML Sample

<nsr:scaling-config-action xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:trigger>pre-scale-in</nsr:trigger>
  <nsr:ns-service-primitive-name-ref>STRING</nsr:ns-service-primitive-name-ref>
</nsr:scaling-config-action>

nsr:vnffgd

List of VNF Forwarding Graph Descriptors (VNFFGD).

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/vnffgd/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VNFFGD.
name	STRING	VNFFGD name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Provider of the VNFFGD.
description	STRING	Description of the VNFFGD.
version	STRING	Version of the VNFFGD
rsp	LIST	List of Rendered Service Paths (RSP).
classifier	LIST	List of classifier rules.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "rsp": [
      {
        "id": "STRING",
        "name": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier": [
      {
        "id": "STRING",
        "name": "STRING",
        "rsp-id-ref": "STRING",
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING",
        "match-attributes": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "rsp": [
      {
        "id": "STRING",
        "name": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier": [
      {
        "id": "STRING",
        "name": "STRING",
        "rsp-id-ref": "STRING",
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING",
        "match-attributes": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnffgd xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:vendor>STRING</nsr:vendor>
  <nsr:description>STRING</nsr:description>
  <nsr:version>STRING</nsr:version>
  <nsr:rsp>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:vnfd-connection-point-ref>...</nsr:vnfd-connection-point-ref>
  </nsr:rsp>
  <nsr:classifier>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:rsp-id-ref>STRING</nsr:rsp-id-ref>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
    <nsr:match-attributes>...</nsr:match-attributes>
  </nsr:classifier>
</nsr:vnffgd>

XML Sample

<nsr:vnffgd xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:vendor>STRING</nsr:vendor>
  <nsr:description>STRING</nsr:description>
  <nsr:version>STRING</nsr:version>
  <nsr:rsp>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:vnfd-connection-point-ref>...</nsr:vnfd-connection-point-ref>
  </nsr:rsp>
  <nsr:classifier>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:rsp-id-ref>STRING</nsr:rsp-id-ref>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
    <nsr:match-attributes>...</nsr:match-attributes>
  </nsr:classifier>
</nsr:vnffgd>

nsr:rsp

List of Rendered Service Paths (RSP).

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd/nsr:rsp

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/vnffgd/STRING/rsp/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the RSP.
name	STRING	RSP name.
vnfd-connection-point-ref	LIST	A list of references to connection points.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "order": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "order": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:rsp xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:vnfd-connection-point-ref>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:order>0</nsr:order>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
  </nsr:vnfd-connection-point-ref>
</nsr:rsp>

XML Sample

<nsr:rsp xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:vnfd-connection-point-ref>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:order>0</nsr:order>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
  </nsr:vnfd-connection-point-ref>
</nsr:rsp>

nsr:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd/nsr:rsp/nsr:vnfd-connection-point-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']/nsr:vnfd-connection-point-ref[nsr:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/vnffgd/STRING/rsp/STRING/vnfd-connection-point-ref/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
order	UINT8	A number that denotes the order of a VNF in a chain
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref
vnfd-connection-point-ref	STRING	A reference to a connection point name in a vnfd. This is a leafref to path: /vnfd:vnfd-catalog/vnfd:vnfd + [vnfd:id = current()/../nsd:vnfd-id-ref] + /vnfd:connection-point/vnfd:name NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "order": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "order": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnfd-connection-point-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:order>0</nsr:order>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
</nsr:vnfd-connection-point-ref>

XML Sample

<nsr:vnfd-connection-point-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:order>0</nsr:order>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
</nsr:vnfd-connection-point-ref>

nsr:classifier

List of classifier rules.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd/nsr:classifier

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']/nsr:classifier[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/vnffgd/STRING/classifier/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the classifier rule.
name	STRING	Name of the classifier.
rsp-id-ref	LEAFREF	A reference to the RSP.
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref to path: ../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref
vnfd-connection-point-ref	STRING	A reference to a connection point name in a vnfd. This is a leafref to path: /vnfd:vnfd-catalog/vnfd:vnfd + [vnfd:id = current()/../nsd:vnfd-id-ref] + /vnfd:connection-point/vnfd:name NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
match-attributes	LIST	List of match attributes.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "rsp-id-ref": "STRING",
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING",
    "match-attributes": [
      {
        "id": "STRING",
        "ip-proto": 0,
        "source-ip-address": "UNION_VALUE",
        "destination-ip-address": "UNION_VALUE",
        "source-port": 0,
        "destination-port": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "rsp-id-ref": "STRING",
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING",
    "match-attributes": [
      {
        "id": "STRING",
        "ip-proto": 0,
        "source-ip-address": "UNION_VALUE",
        "destination-ip-address": "UNION_VALUE",
        "source-port": 0,
        "destination-port": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:classifier xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:rsp-id-ref>STRING</nsr:rsp-id-ref>
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
  <nsr:match-attributes>
    <nsr:id>STRING</nsr:id>
    <nsr:ip-proto>0</nsr:ip-proto>
    <nsr:source-ip-address>UNION_VALUE</nsr:source-ip-address>
    <nsr:destination-ip-address>UNION_VALUE</nsr:destination-ip-address>
    <nsr:source-port>0</nsr:source-port>
    <nsr:destination-port>0</nsr:destination-port>
  </nsr:match-attributes>
</nsr:classifier>

XML Sample

<nsr:classifier xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:rsp-id-ref>STRING</nsr:rsp-id-ref>
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
  <nsr:match-attributes>
    <nsr:id>STRING</nsr:id>
    <nsr:ip-proto>0</nsr:ip-proto>
    <nsr:source-ip-address>UNION_VALUE</nsr:source-ip-address>
    <nsr:destination-ip-address>UNION_VALUE</nsr:destination-ip-address>
    <nsr:source-port>0</nsr:source-port>
    <nsr:destination-port>0</nsr:destination-port>
  </nsr:match-attributes>
</nsr:classifier>

nsr:match-attributes

List of match attributes.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd/nsr:classifier/nsr:match-attributes

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']/nsr:classifier[nsr:id='STRING']/nsr:match-attributes[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/vnffgd/STRING/classifier/STRING/match-attributes/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the classifier match attribute rule.
ip-proto	UINT8	IP Protocol.
source-ip-address	UNION	Source IP address.
destination-ip-address	UNION	Destination IP address.
source-port	UINT16	Source port number.
destination-port	UINT16	Destination port number.

JSON Config Sample

[
  {
    "id": "STRING",
    "ip-proto": 0,
    "source-ip-address": "UNION_VALUE",
    "destination-ip-address": "UNION_VALUE",
    "source-port": 0,
    "destination-port": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "ip-proto": 0,
    "source-ip-address": "UNION_VALUE",
    "destination-ip-address": "UNION_VALUE",
    "source-port": 0,
    "destination-port": 0
  }, {
    ...
  }
]

XML Config Sample

<nsr:match-attributes xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:ip-proto>0</nsr:ip-proto>
  <nsr:source-ip-address>UNION_VALUE</nsr:source-ip-address>
  <nsr:destination-ip-address>UNION_VALUE</nsr:destination-ip-address>
  <nsr:source-port>0</nsr:source-port>
  <nsr:destination-port>0</nsr:destination-port>
</nsr:match-attributes>

XML Sample

<nsr:match-attributes xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:ip-proto>0</nsr:ip-proto>
  <nsr:source-ip-address>UNION_VALUE</nsr:source-ip-address>
  <nsr:destination-ip-address>UNION_VALUE</nsr:destination-ip-address>
  <nsr:source-port>0</nsr:source-port>
  <nsr:destination-port>0</nsr:destination-port>
</nsr:match-attributes>

nsr:ip-profiles

List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:ip-profiles

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:ip-profiles[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/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

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

XML Config Sample

<nsr:ip-profiles xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:description>STRING</nsr:description>
  <nsr:ip-profile-params>
    <nsr:ip-version>ipv4</nsr:ip-version>
    <nsr:subnet-address>UNION_VALUE</nsr:subnet-address>
    <nsr:gateway-address>UNION_VALUE</nsr:gateway-address>
    <nsr:security-group>STRING</nsr:security-group>
    <nsr:dns-server>...</nsr:dns-server>
    <nsr:dhcp-params>...</nsr:dhcp-params>
    <nsr:subnet-prefix-pool>STRING</nsr:subnet-prefix-pool>
  </nsr:ip-profile-params>
</nsr:ip-profiles>

XML Sample

<nsr:ip-profiles xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:description>STRING</nsr:description>
  <nsr:ip-profile-params>
    <nsr:ip-version>ipv4</nsr:ip-version>
    <nsr:subnet-address>UNION_VALUE</nsr:subnet-address>
    <nsr:gateway-address>UNION_VALUE</nsr:gateway-address>
    <nsr:security-group>STRING</nsr:security-group>
    <nsr:dns-server>...</nsr:dns-server>
    <nsr:dhcp-params>...</nsr:dhcp-params>
    <nsr:subnet-prefix-pool>STRING</nsr:subnet-prefix-pool>
  </nsr:ip-profile-params>
</nsr:ip-profiles>

nsr:ip-profile-params

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:ip-profiles/nsr:ip-profile-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:ip-profiles[nsr:name='STRING']/nsr:ip-profile-params

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/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

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

JSON Sample

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

XML Config Sample

<nsr:ip-profile-params xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:ip-version>ipv4</nsr:ip-version>
  <nsr:subnet-address>UNION_VALUE</nsr:subnet-address>
  <nsr:gateway-address>UNION_VALUE</nsr:gateway-address>
  <nsr:security-group>STRING</nsr:security-group>
  <nsr:dns-server>
    <nsr:address>UNION_VALUE</nsr:address>
  </nsr:dns-server>
  <nsr:dhcp-params>
    <nsr:enabled>true</nsr:enabled>
    <nsr:start-address>UNION_VALUE</nsr:start-address>
    <nsr:count>0</nsr:count>
  </nsr:dhcp-params>
  <nsr:subnet-prefix-pool>STRING</nsr:subnet-prefix-pool>
</nsr:ip-profile-params>

XML Sample

<nsr:ip-profile-params xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:ip-version>ipv4</nsr:ip-version>
  <nsr:subnet-address>UNION_VALUE</nsr:subnet-address>
  <nsr:gateway-address>UNION_VALUE</nsr:gateway-address>
  <nsr:security-group>STRING</nsr:security-group>
  <nsr:dns-server>
    <nsr:address>UNION_VALUE</nsr:address>
  </nsr:dns-server>
  <nsr:dhcp-params>
    <nsr:enabled>true</nsr:enabled>
    <nsr:start-address>UNION_VALUE</nsr:start-address>
    <nsr:count>0</nsr:count>
  </nsr:dhcp-params>
  <nsr:subnet-prefix-pool>STRING</nsr:subnet-prefix-pool>
</nsr:ip-profile-params>

nsr:dns-server

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:ip-profiles/nsr:ip-profile-params/nsr:dns-server

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:ip-profiles[nsr:name='STRING']/nsr:ip-profile-params/nsr:dns-server[nsr:address='UNION_VALUE']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/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

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Config Sample

<nsr:dns-server xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:address>UNION_VALUE</nsr:address>
</nsr:dns-server>

XML Sample

<nsr:dns-server xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:address>UNION_VALUE</nsr:address>
</nsr:dns-server>

nsr:dhcp-params

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:ip-profiles/nsr:ip-profile-params/nsr:dhcp-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:ip-profiles[nsr:name='STRING']/nsr:ip-profile-params/nsr:dhcp-params

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/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

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

JSON Sample

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

XML Config Sample

<nsr:dhcp-params xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:enabled>true</nsr:enabled>
  <nsr:start-address>UNION_VALUE</nsr:start-address>
  <nsr:count>0</nsr:count>
</nsr:dhcp-params>

XML Sample

<nsr:dhcp-params xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:enabled>true</nsr:enabled>
  <nsr:start-address>UNION_VALUE</nsr:start-address>
  <nsr:count>0</nsr:count>
</nsr:dhcp-params>

nsr:initial-service-primitive

Initial set of service primitives for NSD.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:initial-service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:initial-service-primitive[nsr:seq='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/initial-service-primitive/0

Fields

Name	Type	Description
seq	UINT64	Sequence number for the configuration primitive.
name	STRING	Name of the configuration primitive.
user-defined-script	STRING	A user defined script.
parameter	LIST

JSON Config Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:initial-service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:seq>0</nsr:seq>
  <nsr:name>STRING</nsr:name>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:initial-service-primitive>

XML Sample

<nsr:initial-service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:seq>0</nsr:seq>
  <nsr:name>STRING</nsr:name>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:initial-service-primitive>

nsr:parameter

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:initial-service-primitive/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:initial-service-primitive[nsr:seq='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/initial-service-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING
value	STRING	Value of the configuration primitive.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:terminate-service-primitive

Set of service primitives during termination for NSD.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:terminate-service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:terminate-service-primitive[nsr:seq='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/terminate-service-primitive/0

Fields

Name	Type	Description
seq	UINT64	Sequence number for the configuration primitive.
name	STRING	Name of the configuration primitive.
user-defined-script	STRING	A user defined script.
parameter	LIST

JSON Config Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:terminate-service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:seq>0</nsr:seq>
  <nsr:name>STRING</nsr:name>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:terminate-service-primitive>

XML Sample

<nsr:terminate-service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:seq>0</nsr:seq>
  <nsr:name>STRING</nsr:name>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:terminate-service-primitive>

nsr:parameter

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:terminate-service-primitive/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:terminate-service-primitive[nsr:seq='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/terminate-service-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING
value	STRING	Value of the configuration primitive.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:input-parameter-xpath

List of xpaths to parameters inside the NSD the can be customized during the instantiation.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:input-parameter-xpath

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:input-parameter-xpath[nsr:xpath='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/input-parameter-xpath/STRING

Fields

Name	Type	Description
xpath	STRING	An xpath that specifies the element in a descriptor.
label	STRING	A descriptive string
default-value	STRING	Default Value for the Input Parameter

JSON Config Sample

[
  {
    "xpath": "STRING",
    "label": "STRING",
    "default-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "xpath": "STRING",
    "label": "STRING",
    "default-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:input-parameter-xpath xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:xpath>STRING</nsr:xpath>
  <nsr:label>STRING</nsr:label>
  <nsr:default-value>STRING</nsr:default-value>
</nsr:input-parameter-xpath>

XML Sample

<nsr:input-parameter-xpath xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:xpath>STRING</nsr:xpath>
  <nsr:label>STRING</nsr:label>
  <nsr:default-value>STRING</nsr:default-value>
</nsr:input-parameter-xpath>

nsr:parameter-pool

Pool of parameter values which must be pulled from during configuration

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:parameter-pool

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:parameter-pool[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/parameter-pool/STRING

Fields

Name	Type	Description
name	STRING	Name of the configuration value pool
range	CONTAINER	Create a range of values to populate the pool with

JSON Config Sample

[
  {
    "name": "STRING",
    "range": {
      "start-value": 0,
      "end-value": 0
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "range": {
      "start-value": 0,
      "end-value": 0
    }
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter-pool xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:range>
    <nsr:start-value>0</nsr:start-value>
    <nsr:end-value>0</nsr:end-value>
  </nsr:range>
</nsr:parameter-pool>

XML Sample

<nsr:parameter-pool xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:range>
    <nsr:start-value>0</nsr:start-value>
    <nsr:end-value>0</nsr:end-value>
  </nsr:range>
</nsr:parameter-pool>

nsr:range

Create a range of values to populate the pool with

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:parameter-pool/nsr:range

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:parameter-pool[nsr:name='STRING']/nsr:range

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/parameter-pool/STRING/range

Fields

Name	Type	Description
start-value	UINT32	Generated pool values start at this value
end-value	UINT32	Generated pool values stop at this value

JSON Config Sample

{
  "start-value": 0,
  "end-value": 0
}

JSON Sample

{
  "start-value": 0,
  "end-value": 0
}

XML Config Sample

<nsr:range xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:start-value>0</nsr:start-value>
  <nsr:end-value>0</nsr:end-value>
</nsr:range>

XML Sample

<nsr:range xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:start-value>0</nsr:start-value>
  <nsr:end-value>0</nsr:end-value>
</nsr:range>

nsr:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:key-pair

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:key-pair[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Config Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:key-pair xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:key>STRING</nsr:key>
</nsr:key-pair>

XML Sample

<nsr:key-pair xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:key>STRING</nsr:key>
</nsr:key-pair>

nsr:user

List of users to be added through cloud-config

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:user

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:user[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/user/STRING

Fields

Name	Type	Description
name	STRING	Name of the user
user-info	STRING	The user name's real name
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation

JSON Config Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:user xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:user-info>STRING</nsr:user-info>
  <nsr:key-pair>
    <nsr:name>STRING</nsr:name>
    <nsr:key>STRING</nsr:key>
  </nsr:key-pair>
</nsr:user>

XML Sample

<nsr:user xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:user-info>STRING</nsr:user-info>
  <nsr:key-pair>
    <nsr:name>STRING</nsr:name>
    <nsr:key>STRING</nsr:key>
  </nsr:key-pair>
</nsr:user>

nsr:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:user/nsr:key-pair

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:user[nsr:name='STRING']/nsr:key-pair[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/user/STRING/key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Config Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:key-pair xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:key>STRING</nsr:key>
</nsr:key-pair>

XML Sample

<nsr:key-pair xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:key>STRING</nsr:key>
</nsr:key-pair>

nsr:vld

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vld

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vld[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/vld/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VLD.
name	STRING	Virtual Link Descriptor (VLD) name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Provider of the VLD.
description	STRING	Description of the VLD.
version	STRING	Version of the VLD
type	ENUM
root-bandwidth	UINT64	For ELAN this is the aggregate bandwidth.
leaf-bandwidth	UINT64	For ELAN this is the bandwidth of branches.
provider-network	CONTAINER	Container for the provider network.
mgmt-network	BOOLEAN	Flag indicating whether this network is a VIM management 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	LEAFREF	Named reference to IP-profile object
vnfd-connection-point-ref	LIST	A list of references to connection points.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "provider-network": {
      "physical-network": "STRING",
      "segmentation_id": 0
    },
    "mgmt-network": false,
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "provider-network": {
      "physical-network": "STRING",
      "segmentation_id": 0
    },
    "mgmt-network": false,
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vld xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:vendor>STRING</nsr:vendor>
  <nsr:description>STRING</nsr:description>
  <nsr:version>STRING</nsr:version>
  <nsr:type>ELAN</nsr:type>
  <nsr:root-bandwidth>0</nsr:root-bandwidth>
  <nsr:leaf-bandwidth>0</nsr:leaf-bandwidth>
  <nsr:provider-network>
    <nsr:physical-network>STRING</nsr:physical-network>
    <nsr:segmentation_id>0</nsr:segmentation_id>
  </nsr:provider-network>
  <nsr:mgmt-network>false</nsr:mgmt-network>
  <nsr:vim-network-name>STRING</nsr:vim-network-name>
  <nsr:ip-profile-ref>STRING</nsr:ip-profile-ref>
  <nsr:vnfd-connection-point-ref>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  </nsr:vnfd-connection-point-ref>
</nsr:vld>

XML Sample

<nsr:vld xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:vendor>STRING</nsr:vendor>
  <nsr:description>STRING</nsr:description>
  <nsr:version>STRING</nsr:version>
  <nsr:type>ELAN</nsr:type>
  <nsr:root-bandwidth>0</nsr:root-bandwidth>
  <nsr:leaf-bandwidth>0</nsr:leaf-bandwidth>
  <nsr:provider-network>
    <nsr:physical-network>STRING</nsr:physical-network>
    <nsr:segmentation_id>0</nsr:segmentation_id>
  </nsr:provider-network>
  <nsr:mgmt-network>false</nsr:mgmt-network>
  <nsr:vim-network-name>STRING</nsr:vim-network-name>
  <nsr:ip-profile-ref>STRING</nsr:ip-profile-ref>
  <nsr:vnfd-connection-point-ref>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  </nsr:vnfd-connection-point-ref>
</nsr:vld>

nsr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vld/nsr:provider-network

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vld[nsr:id='STRING']/nsr:provider-network

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/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

{
  "physical-network": "STRING",
  "segmentation_id": 0
}

JSON Sample

{
  "physical-network": "STRING",
  "segmentation_id": 0
}

XML Config Sample

<nsr:provider-network xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:physical-network>STRING</nsr:physical-network>
  <nsr:segmentation_id>0</nsr:segmentation_id>
</nsr:provider-network>

XML Sample

<nsr:provider-network xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:physical-network>STRING</nsr:physical-network>
  <nsr:segmentation_id>0</nsr:segmentation_id>
</nsr:provider-network>

nsr:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vld/nsr:vnfd-connection-point-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vld[nsr:id='STRING']/nsr:vnfd-connection-point-ref[nsr:member-vnf-index-ref='0'][nsr:vnfd-connection-point-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/vld/STRING/vnfd-connection-point-ref/0,STRING

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
vnfd-connection-point-ref	LEAFREF	A reference to a connection point name

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnfd-connection-point-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
</nsr:vnfd-connection-point-ref>

XML Sample

<nsr:vnfd-connection-point-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-connection-point-ref>STRING</nsr:vnfd-connection-point-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
</nsr:vnfd-connection-point-ref>

nsr:constituent-vnfd

List of VNFDs that are part of this network service.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:constituent-vnfd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:constituent-vnfd[nsr:member-vnf-index='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/constituent-vnfd/0

Fields

Name	Type	Description
member-vnf-index	UINT64	Identifier/index for the VNFD. This separate id is required to ensure that multiple VNFs can be part of single NS
vnfd-id-ref	LEAFREF	Identifier for the VNFD.
start-by-default	BOOLEAN	VNFD is started as part of the NS instantiation

JSON Config Sample

[
  {
    "member-vnf-index": 0,
    "vnfd-id-ref": "STRING",
    "start-by-default": true
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index": 0,
    "vnfd-id-ref": "STRING",
    "start-by-default": true
  }, {
    ...
  }
]

XML Config Sample

<nsr:constituent-vnfd xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index>0</nsr:member-vnf-index>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:start-by-default>true</nsr:start-by-default>
</nsr:constituent-vnfd>

XML Sample

<nsr:constituent-vnfd xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index>0</nsr:member-vnf-index>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:start-by-default>true</nsr:start-by-default>
</nsr:constituent-vnfd>

nsr:placement-groups

List of placement groups at NS level

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:placement-groups

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:placement-groups[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/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-vnfd	LIST	List of VNFDs that are part of this placement group

JSON Config Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vnfd": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vnfd": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:placement-groups xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:requirement>STRING</nsr:requirement>
  <nsr:strategy>COLOCATION</nsr:strategy>
  <nsr:member-vnfd>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  </nsr:member-vnfd>
</nsr:placement-groups>

XML Sample

<nsr:placement-groups xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:requirement>STRING</nsr:requirement>
  <nsr:strategy>COLOCATION</nsr:strategy>
  <nsr:member-vnfd>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  </nsr:member-vnfd>
</nsr:placement-groups>

nsr:member-vnfd

List of VNFDs that are part of this placement group

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:placement-groups/nsr:member-vnfd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:placement-groups[nsr:name='STRING']/nsr:member-vnfd[nsr:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/placement-groups/STRING/member-vnfd/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	member VNF index of this member VNF
vnfd-id-ref	LEAFREF	Identifier for the VNFD.

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:member-vnfd xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
</nsr:member-vnfd>

XML Sample

<nsr:member-vnfd xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
</nsr:member-vnfd>

nsr:vnf-dependency

List of VNF dependencies.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnf-dependency

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnf-dependency[nsr:vnf-source-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/vnf-dependency/STRING

Fields

Name	Type	Description
vnf-source-ref	LEAFREF
vnf-depends-on-ref	LEAFREF	Reference to VNF that sorce VNF depends.

JSON Config Sample

[
  {
    "vnf-source-ref": "STRING",
    "vnf-depends-on-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnf-source-ref": "STRING",
    "vnf-depends-on-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnf-dependency xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnf-source-ref>STRING</nsr:vnf-source-ref>
  <nsr:vnf-depends-on-ref>STRING</nsr:vnf-depends-on-ref>
</nsr:vnf-dependency>

XML Sample

<nsr:vnf-dependency xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnf-source-ref>STRING</nsr:vnf-source-ref>
  <nsr:vnf-depends-on-ref>STRING</nsr:vnf-depends-on-ref>
</nsr:vnf-dependency>

nsr:monitoring-param

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:monitoring-param

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:monitoring-param[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/monitoring-param/STRING

Fields

Name	Type	Description
id	STRING
name	STRING
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
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.)
aggregation-type	ENUM
vnfd-monitoring-param	LIST	A list of VNFD monitoring params

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "aggregation-type": "AVERAGE",
    "vnfd-monitoring-param": [
      {
        "vnfd-id-ref": "STRING",
        "vnfd-monitoring-param-ref": "STRING",
        "member-vnf-index-ref": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "aggregation-type": "AVERAGE",
    "vnfd-monitoring-param": [
      {
        "vnfd-id-ref": "STRING",
        "vnfd-monitoring-param-ref": "STRING",
        "member-vnf-index-ref": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:monitoring-param xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:value-type>INT</nsr:value-type>
  <nsr:numeric-constraints>
    <nsr:min-value>0</nsr:min-value>
    <nsr:max-value>0</nsr:max-value>
  </nsr:numeric-constraints>
  <nsr:text-constraints>
    <nsr:min-length>0</nsr:min-length>
    <nsr:max-length>0</nsr:max-length>
  </nsr:text-constraints>
  <nsr:value-integer>0</nsr:value-integer>
  <nsr:value-decimal>0.0</nsr:value-decimal>
  <nsr:value-string>STRING</nsr:value-string>
  <nsr:description>STRING</nsr:description>
  <nsr:group-tag>STRING</nsr:group-tag>
  <nsr:widget-type>COUNTER</nsr:widget-type>
  <nsr:units>STRING</nsr:units>
  <nsr:aggregation-type>AVERAGE</nsr:aggregation-type>
  <nsr:vnfd-monitoring-param>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-monitoring-param-ref>STRING</nsr:vnfd-monitoring-param-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  </nsr:vnfd-monitoring-param>
</nsr:monitoring-param>

XML Sample

<nsr:monitoring-param xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:value-type>INT</nsr:value-type>
  <nsr:numeric-constraints>
    <nsr:min-value>0</nsr:min-value>
    <nsr:max-value>0</nsr:max-value>
  </nsr:numeric-constraints>
  <nsr:text-constraints>
    <nsr:min-length>0</nsr:min-length>
    <nsr:max-length>0</nsr:max-length>
  </nsr:text-constraints>
  <nsr:value-integer>0</nsr:value-integer>
  <nsr:value-decimal>0.0</nsr:value-decimal>
  <nsr:value-string>STRING</nsr:value-string>
  <nsr:description>STRING</nsr:description>
  <nsr:group-tag>STRING</nsr:group-tag>
  <nsr:widget-type>COUNTER</nsr:widget-type>
  <nsr:units>STRING</nsr:units>
  <nsr:aggregation-type>AVERAGE</nsr:aggregation-type>
  <nsr:vnfd-monitoring-param>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-monitoring-param-ref>STRING</nsr:vnfd-monitoring-param-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  </nsr:vnfd-monitoring-param>
</nsr:monitoring-param>

nsr:numeric-constraints

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:monitoring-param/nsr:numeric-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:monitoring-param[nsr:id='STRING']/nsr:numeric-constraints

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/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

{
  "min-value": 0,
  "max-value": 0
}

JSON Sample

{
  "min-value": 0,
  "max-value": 0
}

XML Config Sample

<nsr:numeric-constraints xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:min-value>0</nsr:min-value>
  <nsr:max-value>0</nsr:max-value>
</nsr:numeric-constraints>

XML Sample

<nsr:numeric-constraints xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:min-value>0</nsr:min-value>
  <nsr:max-value>0</nsr:max-value>
</nsr:numeric-constraints>

nsr:text-constraints

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:monitoring-param/nsr:text-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:monitoring-param[nsr:id='STRING']/nsr:text-constraints

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/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

{
  "min-length": 0,
  "max-length": 0
}

JSON Sample

{
  "min-length": 0,
  "max-length": 0
}

XML Config Sample

<nsr:text-constraints xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:min-length>0</nsr:min-length>
  <nsr:max-length>0</nsr:max-length>
</nsr:text-constraints>

XML Sample

<nsr:text-constraints xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:min-length>0</nsr:min-length>
  <nsr:max-length>0</nsr:max-length>
</nsr:text-constraints>

nsr:vnfd-monitoring-param

A list of VNFD monitoring params

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:monitoring-param/nsr:vnfd-monitoring-param

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:monitoring-param[nsr:id='STRING']/nsr:vnfd-monitoring-param[nsr:member-vnf-index-ref='0'][nsr:vnfd-monitoring-param-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/monitoring-param/STRING/vnfd-monitoring-param/0,STRING

Fields

Name	Type	Description
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
vnfd-monitoring-param-ref	LEAFREF	A reference to the VNFD monitoring param
member-vnf-index-ref	LEAFREF	Optional reference to member-vnf within constituent-vnfds

JSON Config Sample

[
  {
    "vnfd-id-ref": "STRING",
    "vnfd-monitoring-param-ref": "STRING",
    "member-vnf-index-ref": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfd-id-ref": "STRING",
    "vnfd-monitoring-param-ref": "STRING",
    "member-vnf-index-ref": 0
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnfd-monitoring-param xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-monitoring-param-ref>STRING</nsr:vnfd-monitoring-param-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
</nsr:vnfd-monitoring-param>

XML Sample

<nsr:vnfd-monitoring-param xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-monitoring-param-ref>STRING</nsr:vnfd-monitoring-param-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
</nsr:vnfd-monitoring-param>

nsr:service-primitive

Network service level service primitives.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/service-primitive/STRING

Fields

Name	Type	Description
name	STRING	Name of the service primitive.
parameter	LIST	List of parameters for the service primitive.
parameter-group	LIST	Grouping of parameters which are logically grouped in UI
vnf-primitive-group	LIST	List of service primitives grouped by VNF.
user-defined-script	STRING	A user defined script.

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "mandatory": true
      }, {
        ...
      }
    ],
    "vnf-primitive-group": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-name": "STRING",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "mandatory": true
      }, {
        ...
      }
    ],
    "vnf-primitive-group": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-name": "STRING",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:data-type>STRING</nsr:data-type>
    <nsr:mandatory>false</nsr:mandatory>
    <nsr:default-value>STRING</nsr:default-value>
    <nsr:parameter-pool>STRING</nsr:parameter-pool>
    <nsr:read-only>false</nsr:read-only>
    <nsr:hidden>false</nsr:hidden>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:mandatory>true</nsr:mandatory>
  </nsr:parameter-group>
  <nsr:vnf-primitive-group>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfd-name>STRING</nsr:vnfd-name>
    <nsr:primitive>...</nsr:primitive>
  </nsr:vnf-primitive-group>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
</nsr:service-primitive>

XML Sample

<nsr:service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:data-type>STRING</nsr:data-type>
    <nsr:mandatory>false</nsr:mandatory>
    <nsr:default-value>STRING</nsr:default-value>
    <nsr:parameter-pool>STRING</nsr:parameter-pool>
    <nsr:read-only>false</nsr:read-only>
    <nsr:hidden>false</nsr:hidden>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:mandatory>true</nsr:mandatory>
  </nsr:parameter-group>
  <nsr:vnf-primitive-group>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfd-name>STRING</nsr:vnfd-name>
    <nsr:primitive>...</nsr:primitive>
  </nsr:vnf-primitive-group>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
</nsr:service-primitive>

nsr:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/service-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

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:data-type>STRING</nsr:data-type>
  <nsr:mandatory>false</nsr:mandatory>
  <nsr:default-value>STRING</nsr:default-value>
  <nsr:parameter-pool>STRING</nsr:parameter-pool>
  <nsr:read-only>false</nsr:read-only>
  <nsr:hidden>false</nsr:hidden>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:data-type>STRING</nsr:data-type>
  <nsr:mandatory>false</nsr:mandatory>
  <nsr:default-value>STRING</nsr:default-value>
  <nsr:parameter-pool>STRING</nsr:parameter-pool>
  <nsr:read-only>false</nsr:read-only>
  <nsr:hidden>false</nsr:hidden>
</nsr:parameter>

nsr:parameter-group

Grouping of parameters which are logically grouped in UI

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:parameter-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:parameter-group[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/service-primitive/STRING/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter group
parameter	LIST	List of parameters for the service primitive.
mandatory	BOOLEAN	Is this parameter group mandatory

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "mandatory": true
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "mandatory": true
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:data-type>STRING</nsr:data-type>
    <nsr:mandatory>false</nsr:mandatory>
    <nsr:default-value>STRING</nsr:default-value>
    <nsr:parameter-pool>STRING</nsr:parameter-pool>
    <nsr:read-only>false</nsr:read-only>
    <nsr:hidden>false</nsr:hidden>
  </nsr:parameter>
  <nsr:mandatory>true</nsr:mandatory>
</nsr:parameter-group>

XML Sample

<nsr:parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:data-type>STRING</nsr:data-type>
    <nsr:mandatory>false</nsr:mandatory>
    <nsr:default-value>STRING</nsr:default-value>
    <nsr:parameter-pool>STRING</nsr:parameter-pool>
    <nsr:read-only>false</nsr:read-only>
    <nsr:hidden>false</nsr:hidden>
  </nsr:parameter>
  <nsr:mandatory>true</nsr:mandatory>
</nsr:parameter-group>

nsr:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/service-primitive/STRING/parameter-group/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

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:data-type>STRING</nsr:data-type>
  <nsr:mandatory>false</nsr:mandatory>
  <nsr:default-value>STRING</nsr:default-value>
  <nsr:parameter-pool>STRING</nsr:parameter-pool>
  <nsr:read-only>false</nsr:read-only>
  <nsr:hidden>false</nsr:hidden>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:data-type>STRING</nsr:data-type>
  <nsr:mandatory>false</nsr:mandatory>
  <nsr:default-value>STRING</nsr:default-value>
  <nsr:parameter-pool>STRING</nsr:parameter-pool>
  <nsr:read-only>false</nsr:read-only>
  <nsr:hidden>false</nsr:hidden>
</nsr:parameter>

nsr:vnf-primitive-group

List of service primitives grouped by VNF.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:vnf-primitive-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/service-primitive/STRING/vnf-primitive-group/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref
vnfd-name	LEAFREF	Name of the VNFD
primitive	LIST

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-name": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-name": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnf-primitive-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfd-name>STRING</nsr:vnfd-name>
  <nsr:primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
  </nsr:primitive>
</nsr:vnf-primitive-group>

XML Sample

<nsr:vnf-primitive-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfd-name>STRING</nsr:vnfd-name>
  <nsr:primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
  </nsr:primitive>
</nsr:vnf-primitive-group>

nsr:primitive

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:vnf-primitive-group/nsr:primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']/nsr:primitive[nsr:index='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd/service-primitive/STRING/vnf-primitive-group/0/primitive/0

Fields

Name	Type	Description
index	UINT32	Index of this primitive
name	STRING	Name of the primitive in the VNF primitive

JSON Config Sample

[
  {
    "index": 0,
    "name": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "index": 0,
    "name": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
</nsr:primitive>

XML Sample

<nsr:primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
</nsr:primitive>

nsr:input-parameter

List of input parameters

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:input-parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:input-parameter[nsr:xpath='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/input-parameter/STRING

Fields

Name	Type	Description
xpath	STRING	An xpath that specfies which element in a descriptor is to be modified.
value	STRING	The value that the element specified by the xpath should take when a record is created.

JSON Config Sample

[
  {
    "xpath": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "xpath": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:input-parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:xpath>STRING</nsr:xpath>
  <nsr:value>STRING</nsr:value>
</nsr:input-parameter>

XML Sample

<nsr:input-parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:xpath>STRING</nsr:xpath>
  <nsr:value>STRING</nsr:value>
</nsr:input-parameter>

nsr:scaling-group

List of ns scaling group instances

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:scaling-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:scaling-group[nsr:scaling-group-name-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/scaling-group/STRING

Fields

Name	Type	Description
scaling-group-name-ref	STRING	name of the scaling group leafref path ../nsd/scaling-group-descriptor/name
instance	LIST	The instance of the scaling group

JSON Config Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "id": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "id": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:scaling-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:id>0</nsr:id>
  </nsr:instance>
</nsr:scaling-group>

XML Sample

<nsr:scaling-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:id>0</nsr:id>
  </nsr:instance>
</nsr:scaling-group>

nsr:instance

The instance of the scaling group

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:scaling-group/nsr:instance

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:scaling-group[nsr:scaling-group-name-ref='STRING']/nsr:instance[nsr:id='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/scaling-group/STRING/instance/0

Fields

Name	Type	Description
id	UINT16	Scaling group instance uuid

JSON Config Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

XML Config Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>0</nsr:id>
</nsr:instance>

XML Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>0</nsr:id>
</nsr:instance>

nsr:nsd-placement-group-maps

Mapping from mano-placement groups construct from NSD to cloud platform placement group construct

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd-placement-group-maps

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd-placement-group-maps/STRING

Fields

Name	Type	Description
placement-group-ref	STRING	Reference for NSD placement group
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Config Sample

[
  {
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Config Sample

<nsr:nsd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:nsd-placement-group-maps>

XML Sample

<nsr:nsd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:nsd-placement-group-maps>

nsr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd-placement-group-maps/nsr:availability-zone

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:availability-zone

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd-placement-group-maps/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

XML Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

nsr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd-placement-group-maps/nsr:server-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:server-group

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd-placement-group-maps/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

XML Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

nsr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:nsd-placement-group-maps/nsr:host-aggregate

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:host-aggregate[nsr:metadata-key='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/nsd-placement-group-maps/STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Config Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

XML Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

nsr:vnfd-placement-group-maps

Mapping from mano-placement groups construct from VNFD to cloud platform placement group construct

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:vnfd-placement-group-maps

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/vnfd-placement-group-maps/STRING,STRING

Fields

Name	Type	Description
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../project-nsd:constituent-vnfd + [id = current()/../id-ref] + /project-nsd:vnfd-id-ref NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
placement-group-ref	LEAFREF	A reference to VNFD placement group
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Config Sample

[
  {
    "vnfd-id-ref": "STRING",
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfd-id-ref": "STRING",
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnfd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:vnfd-placement-group-maps>

XML Sample

<nsr:vnfd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:vnfd-placement-group-maps>

nsr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:vnfd-placement-group-maps/nsr:availability-zone

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:availability-zone

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/vnfd-placement-group-maps/STRING,STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

XML Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

nsr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:vnfd-placement-group-maps/nsr:server-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:server-group

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/vnfd-placement-group-maps/STRING,STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

XML Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

nsr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:vnfd-placement-group-maps/nsr:host-aggregate

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:host-aggregate[nsr:metadata-key='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/vnfd-placement-group-maps/STRING,STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Config Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

XML Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

nsr:ssh-authorized-key

List of authorized ssh keys as part of cloud-config

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:ssh-authorized-key

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:ssh-authorized-key[nsr:key-pair-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/ssh-authorized-key/STRING

Fields

Name	Type	Description
key-pair-ref	LEAFREF	A reference to the key pair entry in the global key pair table

JSON Config Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

XML Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

nsr:user

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:user

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:user[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/user/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
user-info	STRING	The user name's real name
ssh-authorized-key	LIST	Used to configure the list of public keys to be injected as part of ns instantiation

JSON Config Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:user xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:user-info>STRING</nsr:user-info>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
</nsr:user>

XML Sample

<nsr:user xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:user-info>STRING</nsr:user-info>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
</nsr:user>

nsr:ssh-authorized-key

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:user/nsr:ssh-authorized-key

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:user[nsr:name='STRING']/nsr:ssh-authorized-key[nsr:key-pair-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-config/nsr/STRING/user/STRING/ssh-authorized-key/STRING

Fields

Name	Type	Description
key-pair-ref	LEAFREF	A reference to the key pair entry in the global key pair table

JSON Config Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

XML Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

vlr:vlr-catalog

Key Identifiers:

XPath Path	/rw-project:project/vlr:vlr-catalog
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog
RW.REST URI Path	/rw-project:project/STRING/vlr:vlr-catalog

Fields

Name	Type	Description
schema-version	STRING	Schema version for the VLR. If unspecified, it assumes v3.0
vlr	LIST

JSON Sample

{
  "schema-version": "v3.0",
  "vlr": [
    {
      "id": "STRING",
      "name": "STRING",
      "nsr-id-ref": "STRING",
      "vld-ref": "STRING",
      "res-id": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "type": "ELAN",
      "root-bandwidth": 0,
      "leaf-bandwidth": 0,
      "create-time": 0,
      "uptime": 0,
      "network-id": "STRING",
      "vim-network-name": "STRING",
      "provider-network": { ... },
      "ip-profile-params": { ... },
      "status": "LINK_UP",
      "operational-status": "init"
    }, {
      ...
    }
  ]
}

XML Sample

<vlr:vlr-catalog xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <vlr:schema-version>v3.0</vlr:schema-version>
  <vlr:vlr>
    <vlr:id>STRING</vlr:id>
    <vlr:name>STRING</vlr:name>
    <vlr:nsr-id-ref>STRING</vlr:nsr-id-ref>
    <vlr:vld-ref>STRING</vlr:vld-ref>
    <vlr:res-id>STRING</vlr:res-id>
    <vlr:short-name>STRING</vlr:short-name>
    <vlr:vendor>STRING</vlr:vendor>
    <vlr:description>STRING</vlr:description>
    <vlr:version>STRING</vlr:version>
    <vlr:type>ELAN</vlr:type>
    <vlr:root-bandwidth>0</vlr:root-bandwidth>
    <vlr:leaf-bandwidth>0</vlr:leaf-bandwidth>
    <vlr:create-time>0</vlr:create-time>
    <vlr:uptime>0</vlr:uptime>
    <vlr:network-id>STRING</vlr:network-id>
    <vlr:vim-network-name>STRING</vlr:vim-network-name>
    <vlr:provider-network>...</vlr:provider-network>
    <vlr:ip-profile-params>...</vlr:ip-profile-params>
    <vlr:status>LINK_UP</vlr:status>
    <vlr:operational-status>init</vlr:operational-status>
  </vlr:vlr>
</vlr:vlr-catalog>

vlr:vlr

Key Identifiers:

XPath Path	/rw-project:project/vlr:vlr-catalog/vlr:vlr
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']
RW.REST URI Path	/rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VLR.
name	STRING	VLR name.
nsr-id-ref	STRING	NS instance identifier. This is a leafref /rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:id
vld-ref	STRING	Reference to VLD /rw-project:project/nsr:ns-instance-config/nsr:nsr[nsr:id=../nsr-id-ref] /nsd/vld:vld/vld:id
res-id	STRING	Identifier for resmgr id mapping
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Provider of the VLR.
description	STRING	Description of the VLR.
version	STRING	Version of the VLR
type	ENUM
root-bandwidth	UINT64	For ELAN this is the aggregate bandwidth.
leaf-bandwidth	UINT64	For ELAN this is the bandwidth of branches.
create-time	UINT32	Creation timestamp of this Virtual Link. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
uptime	UINT32	Active period of this Virtual Link. Uptime is expressed in seconds
network-id	STRING	Identifier for the allocated network resource.
vim-network-name	STRING	Name of network in VIM account. This is used to indicate pre-provisioned network name in cloud account.
provider-network	CONTAINER	Container for the provider network.
ip-profile-params	CONTAINER
status	ENUM	Status of the virtual link record.
operational-status	ENUM	The operational status of the Virtual Link init : The VL is in init stat. vl-alloc-pending : The VL alloc is pending in VIM running : The VL is up and running in VM vl-terminate-pending : The VL is being terminated in VIM. terminated : The VL is terminated in the VM. failed : The VL instantiation failed in VIM.

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "nsr-id-ref": "STRING",
    "vld-ref": "STRING",
    "res-id": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "create-time": 0,
    "uptime": 0,
    "network-id": "STRING",
    "vim-network-name": "STRING",
    "provider-network": {
      "physical-network": "STRING",
      "segmentation_id": 0
    },
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    },
    "status": "LINK_UP",
    "operational-status": "init"
  }, {
    ...
  }
]

XML Sample

<vlr:vlr xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <vlr:id>STRING</vlr:id>
  <vlr:name>STRING</vlr:name>
  <vlr:nsr-id-ref>STRING</vlr:nsr-id-ref>
  <vlr:vld-ref>STRING</vlr:vld-ref>
  <vlr:res-id>STRING</vlr:res-id>
  <vlr:short-name>STRING</vlr:short-name>
  <vlr:vendor>STRING</vlr:vendor>
  <vlr:description>STRING</vlr:description>
  <vlr:version>STRING</vlr:version>
  <vlr:type>ELAN</vlr:type>
  <vlr:root-bandwidth>0</vlr:root-bandwidth>
  <vlr:leaf-bandwidth>0</vlr:leaf-bandwidth>
  <vlr:create-time>0</vlr:create-time>
  <vlr:uptime>0</vlr:uptime>
  <vlr:network-id>STRING</vlr:network-id>
  <vlr:vim-network-name>STRING</vlr:vim-network-name>
  <vlr:provider-network>
    <vlr:physical-network>STRING</vlr:physical-network>
    <vlr:segmentation_id>0</vlr:segmentation_id>
  </vlr:provider-network>
  <vlr:ip-profile-params>
    <vlr:ip-version>ipv4</vlr:ip-version>
    <vlr:subnet-address>UNION_VALUE</vlr:subnet-address>
    <vlr:gateway-address>UNION_VALUE</vlr:gateway-address>
    <vlr:security-group>STRING</vlr:security-group>
    <vlr:dns-server>...</vlr:dns-server>
    <vlr:dhcp-params>...</vlr:dhcp-params>
    <vlr:subnet-prefix-pool>STRING</vlr:subnet-prefix-pool>
  </vlr:ip-profile-params>
  <vlr:status>LINK_UP</vlr:status>
  <vlr:operational-status>init</vlr:operational-status>
</vlr:vlr>

vlr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:provider-network

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:provider-network

RW.REST URI Path

/rw-project:project/STRING/vlr:vlr-catalog/vlr/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 Sample

{
  "physical-network": "STRING",
  "segmentation_id": 0
}

XML Sample

<vlr:provider-network xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <vlr:physical-network>STRING</vlr:physical-network>
  <vlr:segmentation_id>0</vlr:segmentation_id>
</vlr:provider-network>

vlr:ip-profile-params

Key Identifiers:

XPath Path

/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params

RW.REST URI Path

/rw-project:project/STRING/vlr:vlr-catalog/vlr/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 Sample

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

XML Sample

<vlr:ip-profile-params xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <vlr:ip-version>ipv4</vlr:ip-version>
  <vlr:subnet-address>UNION_VALUE</vlr:subnet-address>
  <vlr:gateway-address>UNION_VALUE</vlr:gateway-address>
  <vlr:security-group>STRING</vlr:security-group>
  <vlr:dns-server>
    <vlr:address>UNION_VALUE</vlr:address>
  </vlr:dns-server>
  <vlr:dhcp-params>
    <vlr:enabled>true</vlr:enabled>
    <vlr:start-address>UNION_VALUE</vlr:start-address>
    <vlr:count>0</vlr:count>
  </vlr:dhcp-params>
  <vlr:subnet-prefix-pool>STRING</vlr:subnet-prefix-pool>
</vlr:ip-profile-params>

vlr:dns-server

Key Identifiers:

XPath Path

/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dns-server

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dns-server[vlr:address='UNION_VALUE']

RW.REST URI Path

/rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/ip-profile-params/dns-server/UNION_VALUE

Fields

Name	Type	Description
address	UNION	List of DNS Servers associated with IP Profile

JSON Sample

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Sample

<vlr:dns-server xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <vlr:address>UNION_VALUE</vlr:address>
</vlr:dns-server>

vlr:dhcp-params

Key Identifiers:

XPath Path

/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dhcp-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dhcp-params

RW.REST URI Path

/rw-project:project/STRING/vlr:vlr-catalog/vlr/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 Sample

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

XML Sample

<vlr:dhcp-params xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <vlr:enabled>true</vlr:enabled>
  <vlr:start-address>UNION_VALUE</vlr:start-address>
  <vlr:count>0</vlr:count>
</vlr:dhcp-params>

vnfr:vnfr-catalog

Key Identifiers:

XPath Path	/rw-project:project/vnfr:vnfr-catalog
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog
RW.REST URI Path	/rw-project:project/STRING/vnfr:vnfr-catalog

Fields

Name	Type	Description
schema-version	STRING	Schema version for the VNFR. If unspecified, it assumes v3.0
vnfr	LIST	Virtual Network Function Record (VNFR).

JSON Sample

{
  "schema-version": "v3.0",
  "vnfr": [
    {
      "id": "STRING",
      "nsr-id-ref": "STRING",
      "member-vnf-index-ref": 0,
      "dashboard-url": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "create-time": 0,
      "uptime": 0,
      "vnfd": { ... },
      "vnfd-ref": "STRING",
      "vnf-configuration": { ... },
      "mgmt-interface": { ... },
      "internal-vlr": [ { ... }, { ... } ],
      "connection-point": [ { ... }, { ... } ],
      "vdur": [ { ... }, { ... } ],
      "http-endpoint": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "operational-status": "pre-init",
      "config-status": "configuring",
      "placement-groups-info": [ { ... }, { ... } ],
      "cloud-config": { ... }
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vnfr-catalog xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:schema-version>v3.0</vnfr:schema-version>
  <vnfr:vnfr>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:nsr-id-ref>STRING</vnfr:nsr-id-ref>
    <vnfr:member-vnf-index-ref>0</vnfr:member-vnf-index-ref>
    <vnfr:dashboard-url>STRING</vnfr:dashboard-url>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:vendor>STRING</vnfr:vendor>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:version>STRING</vnfr:version>
    <vnfr:create-time>0</vnfr:create-time>
    <vnfr:uptime>0</vnfr:uptime>
    <vnfr:vnfd>...</vnfr:vnfd>
    <vnfr:vnfd-ref>STRING</vnfr:vnfd-ref>
    <vnfr:vnf-configuration>...</vnfr:vnf-configuration>
    <vnfr:mgmt-interface>...</vnfr:mgmt-interface>
    <vnfr:internal-vlr>...</vnfr:internal-vlr>
    <vnfr:connection-point>...</vnfr:connection-point>
    <vnfr:vdur>...</vnfr:vdur>
    <vnfr:http-endpoint>...</vnfr:http-endpoint>
    <vnfr:monitoring-param>...</vnfr:monitoring-param>
    <vnfr:operational-status>pre-init</vnfr:operational-status>
    <vnfr:config-status>configuring</vnfr:config-status>
    <vnfr:placement-groups-info>...</vnfr:placement-groups-info>
    <vnfr:cloud-config>...</vnfr:cloud-config>
  </vnfr:vnfr>
</vnfr:vnfr-catalog>

vnfr:vnfr

Virtual Network Function Record (VNFR).

Key Identifiers:

XPath Path	/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']
RW.REST URI Path	/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VNFR.
nsr-id-ref	STRING	NS instance identifier. This is a leafref /nsr:ns-instance-config/nsr:nsr/nsr:id
member-vnf-index-ref	LEAFREF	Reference to member VNF index in Network service.
dashboard-url	STRING	Dashboard URL
name	STRING	VNFR name.
short-name	STRING	VNFR short name.
vendor	STRING	Vendor of the VNFR.
description	STRING	Description of the VNFR.
version	STRING	Version of the VNFR
create-time	UINT32	Creation timestamp of this Virtual Network Function. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
uptime	UINT32	Active period of this Virtual Network Function. Uptime is expressed in seconds
vnfd	CONTAINER	VNF descriptor used to instantiate this VNF
vnfd-ref	LEAFREF	Reference to VNFD
vnf-configuration	CONTAINER
mgmt-interface	CONTAINER
internal-vlr	LIST
connection-point	LIST	List for external connection points. Each VNF has one or more external connection points. As the name implies that external connection points are used for connecting the VNF to other VNFs or to external networks. Each VNF exposes these connection points to the orchestrator. The orchestrator 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.
vdur	LIST	List of Virtual Deployment Units
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
operational-status	ENUM	The operational status of the VNFR instance pre-init : The VNF before Input Param Substitution. init : The VNF has just started. vl-init-phase : The internal VLs in the VNF are being instantiated. vm-init-phase : The VMs for VDUs in the VNF are being instantiated. running : The VNF is in running state. terminate : The VNF is being terminated. vm-terminate-phase : The VMs in the VNF are being terminated. vl-terminate-phase : The internal VLs in the VNF are being terminated. terminated : The VNF is in the terminated state. failed : The VNF instantiation failed
config-status	ENUM	The configuration status of the NS instance configuring: At least one of the VNFs in this instance is in configuring state configured: All the VNFs in this NS instance are configured or config-not-needed state
placement-groups-info	LIST	Placement groups to which this VDU belongs and its cloud construct
cloud-config	CONTAINER

JSON Sample

[
  {
    "id": "STRING",
    "nsr-id-ref": "STRING",
    "member-vnf-index-ref": 0,
    "dashboard-url": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "create-time": 0,
    "uptime": 0,
    "vnfd": {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "vnf-configuration": { ... },
      "operational-status": "init",
      "mgmt-interface": { ... },
      "internal-vld": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "connection-point": [ { ... }, { ... } ],
      "vdu": [ { ... }, { ... } ],
      "vdu-dependency": [ { ... }, { ... } ],
      "service-function-chain": "UNAWARE",
      "service-function-type": "STRING",
      "http-endpoint": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ]
    },
    "vnfd-ref": "STRING",
    "vnf-configuration": {
      "script": { ... },
      "juju": { ... },
      "config-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ]
    },
    "mgmt-interface": {
      "ip-address": "UNION_VALUE",
      "port": 0,
      "ssh-key": { ... }
    },
    "internal-vlr": [
      {
        "vlr-ref": "STRING",
        "internal-connection-point-ref": [ "STRING", ... ]
      }, {
        ...
      }
    ],
    "connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "vlr-ref": "STRING",
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING",
        "connection-point-id": "STRING",
        "virtual-cps": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vdur": [
      {
        "id": "STRING",
        "name": "STRING",
        "unique-short-name": "STRING",
        "vdu-id-ref": "STRING",
        "vim-id": "STRING",
        "flavor-id": "STRING",
        "image-id": "STRING",
        "management-ip": "UNION_VALUE",
        "vm-management-ip": "UNION_VALUE",
        "console-url": "STRING",
        "vm-flavor": { ... },
        "guest-epa": { ... },
        "vswitch-epa": { ... },
        "hypervisor-epa": { ... },
        "host-epa": { ... },
        "supplemental-boot-data": { ... },
        "vdu-configuration": { ... },
        "volumes": [ { ... }, { ... } ],
        "internal-connection-point": [ { ... }, { ... } ],
        "interface": [ { ... }, { ... } ],
        "operational-status": "init",
        "placement-groups-info": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "http-endpoint": [
      {
        "path": "STRING",
        "https": false,
        "port": 0,
        "username": "STRING",
        "password": "STRING",
        "polling-interval-secs": 2,
        "method": "GET",
        "headers": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "http-endpoint-ref": "STRING",
        "json-query-method": "NAMEKEY",
        "json-query-params": { ... },
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "COUNTER",
        "units": "STRING",
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING"
      }, {
        ...
      }
    ],
    "operational-status": "pre-init",
    "config-status": "configuring",
    "placement-groups-info": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "cloud-config": {
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ]
    }
  }, {
    ...
  }
]

XML Sample

<vnfr:vnfr xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:nsr-id-ref>STRING</vnfr:nsr-id-ref>
  <vnfr:member-vnf-index-ref>0</vnfr:member-vnf-index-ref>
  <vnfr:dashboard-url>STRING</vnfr:dashboard-url>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:vendor>STRING</vnfr:vendor>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:version>STRING</vnfr:version>
  <vnfr:create-time>0</vnfr:create-time>
  <vnfr:uptime>0</vnfr:uptime>
  <vnfr:vnfd>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:vendor>STRING</vnfr:vendor>
    <vnfr:logo>STRING</vnfr:logo>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:version>STRING</vnfr:version>
    <vnfr:vnf-configuration>...</vnfr:vnf-configuration>
    <vnfr:operational-status>init</vnfr:operational-status>
    <vnfr:mgmt-interface>...</vnfr:mgmt-interface>
    <vnfr:internal-vld>...</vnfr:internal-vld>
    <vnfr:ip-profiles>...</vnfr:ip-profiles>
    <vnfr:connection-point>...</vnfr:connection-point>
    <vnfr:vdu>...</vnfr:vdu>
    <vnfr:vdu-dependency>...</vnfr:vdu-dependency>
    <vnfr:service-function-chain>UNAWARE</vnfr:service-function-chain>
    <vnfr:service-function-type>STRING</vnfr:service-function-type>
    <vnfr:http-endpoint>...</vnfr:http-endpoint>
    <vnfr:monitoring-param>...</vnfr:monitoring-param>
    <vnfr:placement-groups>...</vnfr:placement-groups>
  </vnfr:vnfd>
  <vnfr:vnfd-ref>STRING</vnfr:vnfd-ref>
  <vnfr:vnf-configuration>
    <vnfr:script>...</vnfr:script>
    <vnfr:juju>...</vnfr:juju>
    <vnfr:config-primitive>...</vnfr:config-primitive>
    <vnfr:initial-config-primitive>...</vnfr:initial-config-primitive>
  </vnfr:vnf-configuration>
  <vnfr:mgmt-interface>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:port>0</vnfr:port>
    <vnfr:ssh-key>...</vnfr:ssh-key>
  </vnfr:mgmt-interface>
  <vnfr:internal-vlr>
    <vnfr:vlr-ref>STRING</vnfr:vlr-ref>
    <vnfr:internal-connection-point-ref>STRING</vnfr:internal-connection-point-ref>
    <vnfr:internal-connection-point-ref>...</vnfr:internal-connection-point-ref>
  </vnfr:internal-vlr>
  <vnfr:connection-point>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
    <vnfr:vlr-ref>STRING</vnfr:vlr-ref>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:mac-address>STRING</vnfr:mac-address>
    <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
    <vnfr:virtual-cps>...</vnfr:virtual-cps>
  </vnfr:connection-point>
  <vnfr:vdur>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:unique-short-name>STRING</vnfr:unique-short-name>
    <vnfr:vdu-id-ref>STRING</vnfr:vdu-id-ref>
    <vnfr:vim-id>STRING</vnfr:vim-id>
    <vnfr:flavor-id>STRING</vnfr:flavor-id>
    <vnfr:image-id>STRING</vnfr:image-id>
    <vnfr:management-ip>UNION_VALUE</vnfr:management-ip>
    <vnfr:vm-management-ip>UNION_VALUE</vnfr:vm-management-ip>
    <vnfr:console-url>STRING</vnfr:console-url>
    <vnfr:vm-flavor>...</vnfr:vm-flavor>
    <vnfr:guest-epa>...</vnfr:guest-epa>
    <vnfr:vswitch-epa>...</vnfr:vswitch-epa>
    <vnfr:hypervisor-epa>...</vnfr:hypervisor-epa>
    <vnfr:host-epa>...</vnfr:host-epa>
    <vnfr:supplemental-boot-data>...</vnfr:supplemental-boot-data>
    <vnfr:vdu-configuration>...</vnfr:vdu-configuration>
    <vnfr:volumes>...</vnfr:volumes>
    <vnfr:internal-connection-point>...</vnfr:internal-connection-point>
    <vnfr:interface>...</vnfr:interface>
    <vnfr:operational-status>init</vnfr:operational-status>
    <vnfr:placement-groups-info>...</vnfr:placement-groups-info>
  </vnfr:vdur>
  <vnfr:http-endpoint>
    <vnfr:path>STRING</vnfr:path>
    <vnfr:https>false</vnfr:https>
    <vnfr:port>0</vnfr:port>
    <vnfr:username>STRING</vnfr:username>
    <vnfr:password>STRING</vnfr:password>
    <vnfr:polling-interval-secs>2</vnfr:polling-interval-secs>
    <vnfr:method>GET</vnfr:method>
    <vnfr:headers>...</vnfr:headers>
  </vnfr:http-endpoint>
  <vnfr:monitoring-param>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:http-endpoint-ref>STRING</vnfr:http-endpoint-ref>
    <vnfr:json-query-method>NAMEKEY</vnfr:json-query-method>
    <vnfr:json-query-params>...</vnfr:json-query-params>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:group-tag>STRING</vnfr:group-tag>
    <vnfr:widget-type>COUNTER</vnfr:widget-type>
    <vnfr:units>STRING</vnfr:units>
    <vnfr:value-type>INT</vnfr:value-type>
    <vnfr:numeric-constraints>...</vnfr:numeric-constraints>
    <vnfr:text-constraints>...</vnfr:text-constraints>
    <vnfr:value-integer>0</vnfr:value-integer>
    <vnfr:value-decimal>0.0</vnfr:value-decimal>
    <vnfr:value-string>STRING</vnfr:value-string>
  </vnfr:monitoring-param>
  <vnfr:operational-status>pre-init</vnfr:operational-status>
  <vnfr:config-status>configuring</vnfr:config-status>
  <vnfr:placement-groups-info>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:requirement>STRING</vnfr:requirement>
    <vnfr:strategy>COLOCATION</vnfr:strategy>
    <vnfr:cloud-type>aws</vnfr:cloud-type>
    <vnfr:availability-zone>...</vnfr:availability-zone>
    <vnfr:server-group>...</vnfr:server-group>
    <vnfr:host-aggregate>...</vnfr:host-aggregate>
    <vnfr:aws-construct/>
    <vnfr:openmano-construct/>
    <vnfr:vsphere-construct/>
    <vnfr:mock-construct/>
    <vnfr:cloudsim-construct/>
  </vnfr:placement-groups-info>
  <vnfr:cloud-config>
    <vnfr:key-pair>...</vnfr:key-pair>
    <vnfr:user>...</vnfr:user>
  </vnfr:cloud-config>
</vnfr:vnfr>

vnfr:vnfd

VNF descriptor used to instantiate this VNF

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd

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 Sample

{
  "id": "STRING",
  "name": "STRING",
  "short-name": "STRING",
  "vendor": "STRING",
  "logo": "STRING",
  "description": "STRING",
  "version": "STRING",
  "vnf-configuration": {
    "script": { ... },
    "juju": { ... },
    "config-primitive": [ { ... }, { ... } ],
    "initial-config-primitive": [ { ... }, { ... } ]
  },
  "operational-status": "init",
  "mgmt-interface": {
    "ip-address": "UNION_VALUE",
    "vdu-id": "STRING",
    "cp": "STRING",
    "port": 0,
    "dashboard-params": { ... }
  },
  "internal-vld": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "description": "STRING",
      "type": "ELAN",
      "root-bandwidth": 0,
      "leaf-bandwidth": 0,
      "internal-connection-point": [ { ... }, { ... } ],
      "provider-network": { ... },
      "vim-network-name": "STRING",
      "ip-profile-ref": "STRING"
    }, {
      ...
    }
  ],
  "ip-profiles": [
    {
      "name": "STRING",
      "description": "STRING",
      "ip-profile-params": { ... }
    }, {
      ...
    }
  ],
  "connection-point": [
    {
      "name": "STRING",
      "id": "STRING",
      "short-name": "STRING",
      "type": "VPORT",
      "port-security-enabled": true
    }, {
      ...
    }
  ],
  "vdu": [
    {
      "id": "STRING",
      "name": "STRING",
      "description": "STRING",
      "count": 0,
      "mgmt-vpci": "STRING",
      "vm-flavor": { ... },
      "guest-epa": { ... },
      "vswitch-epa": { ... },
      "hypervisor-epa": { ... },
      "host-epa": { ... },
      "alarm": [ { ... }, { ... } ],
      "image": "STRING",
      "image-checksum": "STRING",
      "alternative-images": [ { ... }, { ... } ],
      "vdu-configuration": { ... },
      "cloud-init": "STRING",
      "cloud-init-file": "STRING",
      "supplemental-boot-data": { ... },
      "internal-connection-point": [ { ... }, { ... } ],
      "interface": [ { ... }, { ... } ],
      "volumes": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vdu-dependency": [
    {
      "vdu-source-ref": "STRING",
      "vdu-depends-on-ref": "STRING"
    }, {
      ...
    }
  ],
  "service-function-chain": "UNAWARE",
  "service-function-type": "STRING",
  "http-endpoint": [
    {
      "path": "STRING",
      "https": false,
      "port": 0,
      "username": "STRING",
      "password": "STRING",
      "polling-interval-secs": 2,
      "method": "GET",
      "headers": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "monitoring-param": [
    {
      "id": "STRING",
      "name": "STRING",
      "http-endpoint-ref": "STRING",
      "json-query-method": "NAMEKEY",
      "json-query-params": { ... },
      "description": "STRING",
      "group-tag": "STRING",
      "widget-type": "COUNTER",
      "units": "STRING",
      "value-type": "INT",
      "numeric-constraints": { ... },
      "text-constraints": { ... },
      "value-integer": 0,
      "value-decimal": 0.0,
      "value-string": "STRING"
    }, {
      ...
    }
  ],
  "placement-groups": [
    {
      "name": "STRING",
      "requirement": "STRING",
      "strategy": "COLOCATION",
      "member-vdus": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vnfd xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:vendor>STRING</vnfr:vendor>
  <vnfr:logo>STRING</vnfr:logo>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:version>STRING</vnfr:version>
  <vnfr:vnf-configuration>
    <vnfr:script>...</vnfr:script>
    <vnfr:juju>...</vnfr:juju>
    <vnfr:config-primitive>...</vnfr:config-primitive>
    <vnfr:initial-config-primitive>...</vnfr:initial-config-primitive>
  </vnfr:vnf-configuration>
  <vnfr:operational-status>init</vnfr:operational-status>
  <vnfr:mgmt-interface>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:vdu-id>STRING</vnfr:vdu-id>
    <vnfr:cp>STRING</vnfr:cp>
    <vnfr:port>0</vnfr:port>
    <vnfr:dashboard-params>...</vnfr:dashboard-params>
  </vnfr:mgmt-interface>
  <vnfr:internal-vld>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:type>ELAN</vnfr:type>
    <vnfr:root-bandwidth>0</vnfr:root-bandwidth>
    <vnfr:leaf-bandwidth>0</vnfr:leaf-bandwidth>
    <vnfr:internal-connection-point>...</vnfr:internal-connection-point>
    <vnfr:provider-network>...</vnfr:provider-network>
    <vnfr:vim-network-name>STRING</vnfr:vim-network-name>
    <vnfr:ip-profile-ref>STRING</vnfr:ip-profile-ref>
  </vnfr:internal-vld>
  <vnfr:ip-profiles>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:ip-profile-params>...</vnfr:ip-profile-params>
  </vnfr:ip-profiles>
  <vnfr:connection-point>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  </vnfr:connection-point>
  <vnfr:vdu>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:count>0</vnfr:count>
    <vnfr:mgmt-vpci>STRING</vnfr:mgmt-vpci>
    <vnfr:vm-flavor>...</vnfr:vm-flavor>
    <vnfr:guest-epa>...</vnfr:guest-epa>
    <vnfr:vswitch-epa>...</vnfr:vswitch-epa>
    <vnfr:hypervisor-epa>...</vnfr:hypervisor-epa>
    <vnfr:host-epa>...</vnfr:host-epa>
    <vnfr:alarm>...</vnfr:alarm>
    <vnfr:image>STRING</vnfr:image>
    <vnfr:image-checksum>STRING</vnfr:image-checksum>
    <vnfr:alternative-images>...</vnfr:alternative-images>
    <vnfr:vdu-configuration>...</vnfr:vdu-configuration>
    <vnfr:cloud-init>STRING</vnfr:cloud-init>
    <vnfr:cloud-init-file>STRING</vnfr:cloud-init-file>
    <vnfr:supplemental-boot-data>...</vnfr:supplemental-boot-data>
    <vnfr:internal-connection-point>...</vnfr:internal-connection-point>
    <vnfr:interface>...</vnfr:interface>
    <vnfr:volumes>...</vnfr:volumes>
  </vnfr:vdu>
  <vnfr:vdu-dependency>
    <vnfr:vdu-source-ref>STRING</vnfr:vdu-source-ref>
    <vnfr:vdu-depends-on-ref>STRING</vnfr:vdu-depends-on-ref>
  </vnfr:vdu-dependency>
  <vnfr:service-function-chain>UNAWARE</vnfr:service-function-chain>
  <vnfr:service-function-type>STRING</vnfr:service-function-type>
  <vnfr:http-endpoint>
    <vnfr:path>STRING</vnfr:path>
    <vnfr:https>false</vnfr:https>
    <vnfr:port>0</vnfr:port>
    <vnfr:username>STRING</vnfr:username>
    <vnfr:password>STRING</vnfr:password>
    <vnfr:polling-interval-secs>2</vnfr:polling-interval-secs>
    <vnfr:method>GET</vnfr:method>
    <vnfr:headers>...</vnfr:headers>
  </vnfr:http-endpoint>
  <vnfr:monitoring-param>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:http-endpoint-ref>STRING</vnfr:http-endpoint-ref>
    <vnfr:json-query-method>NAMEKEY</vnfr:json-query-method>
    <vnfr:json-query-params>...</vnfr:json-query-params>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:group-tag>STRING</vnfr:group-tag>
    <vnfr:widget-type>COUNTER</vnfr:widget-type>
    <vnfr:units>STRING</vnfr:units>
    <vnfr:value-type>INT</vnfr:value-type>
    <vnfr:numeric-constraints>...</vnfr:numeric-constraints>
    <vnfr:text-constraints>...</vnfr:text-constraints>
    <vnfr:value-integer>0</vnfr:value-integer>
    <vnfr:value-decimal>0.0</vnfr:value-decimal>
    <vnfr:value-string>STRING</vnfr:value-string>
  </vnfr:monitoring-param>
  <vnfr:placement-groups>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:requirement>STRING</vnfr:requirement>
    <vnfr:strategy>COLOCATION</vnfr:strategy>
    <vnfr:member-vdus>...</vnfr:member-vdus>
  </vnfr:placement-groups>
</vnfr:vnfd>

vnfr:vnf-configuration

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING",
    "proxy": true,
    "vca-relationships": { ... }
  },
  "config-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vnf-configuration xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script>
    <vnfr:script-type>rift</vnfr:script-type>
  </vnfr:script>
  <vnfr:juju>
    <vnfr:charm>STRING</vnfr:charm>
    <vnfr:proxy>true</vnfr:proxy>
    <vnfr:vca-relationships>...</vnfr:vca-relationships>
  </vnfr:juju>
  <vnfr:config-primitive>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
  </vnfr:config-primitive>
  <vnfr:initial-config-primitive>
    <vnfr:seq>0</vnfr:seq>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
  </vnfr:initial-config-primitive>
</vnfr:vnf-configuration>

vnfr:script

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:script

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:script

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/script

Fields

Name	Type	Description
script-type	ENUM	Script type - currently supported - Scripts confirming to Rift CA plugin

JSON Sample

{
  "script-type": "rift"
}

XML Sample

<vnfr:script xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script-type>rift</vnfr:script-type>
</vnfr:script>

vnfr:juju

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "charm": "STRING",
  "proxy": true,
  "vca-relationships": {
    "relation": [ { ... }, { ... } ]
  }
}

XML Sample

<vnfr:juju xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:charm>STRING</vnfr:charm>
  <vnfr:proxy>true</vnfr:proxy>
  <vnfr:vca-relationships>
    <vnfr:relation>...</vnfr:relation>
  </vnfr:vca-relationships>
</vnfr:juju>

vnfr:vca-relationships

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju/vnfr:vca-relationships

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju/vnfr:vca-relationships

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/juju/vca-relationships

Fields

Name	Type	Description
relation	LIST	List of relations between VCA componets.

JSON Sample

{
  "relation": [
    {
      "requires": "STRING",
      "provides": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vca-relationships xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:relation>
    <vnfr:requires>STRING</vnfr:requires>
    <vnfr:provides>STRING</vnfr:provides>
  </vnfr:relation>
</vnfr:vca-relationships>

vnfr:relation

List of relations between VCA componets.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju/vnfr:vca-relationships/vnfr:relation

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju/vnfr:vca-relationships/vnfr:relation[vnfr:requires='STRING'][vnfr:provides='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "requires": "STRING",
    "provides": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:relation xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:requires>STRING</vnfr:requires>
  <vnfr:provides>STRING</vnfr:provides>
</vnfr:relation>

vnfr:config-primitive

List of config primitives supported by the configuration agent for this VNF or VDU.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-primitive[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:config-primitive xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:parameter>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:data-type>STRING</vnfr:data-type>
    <vnfr:mandatory>false</vnfr:mandatory>
    <vnfr:default-value>STRING</vnfr:default-value>
    <vnfr:parameter-pool>STRING</vnfr:parameter-pool>
    <vnfr:read-only>false</vnfr:read-only>
    <vnfr:hidden>false</vnfr:hidden>
  </vnfr:parameter>
  <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
</vnfr:config-primitive>

vnfr:parameter

List of parameters to the config primitive.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-primitive/vnfr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Sample

<vnfr:parameter xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:data-type>STRING</vnfr:data-type>
  <vnfr:mandatory>false</vnfr:mandatory>
  <vnfr:default-value>STRING</vnfr:default-value>
  <vnfr:parameter-pool>STRING</vnfr:parameter-pool>
  <vnfr:read-only>false</vnfr:read-only>
  <vnfr:hidden>false</vnfr:hidden>
</vnfr:parameter>

vnfr:initial-config-primitive

Initial set of configuration primitives.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:initial-config-primitive xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:seq>0</vnfr:seq>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:parameter>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:value>STRING</vnfr:value>
  </vnfr:parameter>
  <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
</vnfr:initial-config-primitive>

vnfr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive/vnfr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:parameter xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:value>STRING</vnfr:value>
</vnfr:parameter>

vnfr:mgmt-interface

Interface over which the VNF is managed.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:mgmt-interface

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:mgmt-interface

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "ip-address": "UNION_VALUE",
  "vdu-id": "STRING",
  "cp": "STRING",
  "port": 0,
  "dashboard-params": {
    "path": "STRING",
    "https": true,
    "port": 0
  }
}

XML Sample

<vnfr:mgmt-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:vdu-id>STRING</vnfr:vdu-id>
  <vnfr:cp>STRING</vnfr:cp>
  <vnfr:port>0</vnfr:port>
  <vnfr:dashboard-params>
    <vnfr:path>STRING</vnfr:path>
    <vnfr:https>true</vnfr:https>
    <vnfr:port>0</vnfr:port>
  </vnfr:dashboard-params>
</vnfr:mgmt-interface>

vnfr:dashboard-params

Parameters for the VNF dashboard

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:mgmt-interface/vnfr:dashboard-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:mgmt-interface/vnfr:dashboard-params

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "path": "STRING",
  "https": true,
  "port": 0
}

XML Sample

<vnfr:dashboard-params xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:path>STRING</vnfr:path>
  <vnfr:https>true</vnfr:https>
  <vnfr:port>0</vnfr:port>
</vnfr:dashboard-params>

vnfr: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/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "description": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "internal-connection-point": [
      {
        "id-ref": "STRING",
        "ip-address": "UNION_VALUE"
      }, {
        ...
      }
    ],
    "provider-network": {
      "physical-network": "STRING",
      "segmentation_id": 0
    },
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-vld xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:type>ELAN</vnfr:type>
  <vnfr:root-bandwidth>0</vnfr:root-bandwidth>
  <vnfr:leaf-bandwidth>0</vnfr:leaf-bandwidth>
  <vnfr:internal-connection-point>
    <vnfr:id-ref>STRING</vnfr:id-ref>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  </vnfr:internal-connection-point>
  <vnfr:provider-network>
    <vnfr:physical-network>STRING</vnfr:physical-network>
    <vnfr:segmentation_id>0</vnfr:segmentation_id>
  </vnfr:provider-network>
  <vnfr:vim-network-name>STRING</vnfr:vim-network-name>
  <vnfr:ip-profile-ref>STRING</vnfr:ip-profile-ref>
</vnfr:internal-vld>

vnfr:internal-connection-point

List of internal connection points in this VLD

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld/vnfr:internal-connection-point

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "id-ref": "STRING",
    "ip-address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id-ref>STRING</vnfr:id-ref>
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
</vnfr:internal-connection-point>

vnfr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld/vnfr:provider-network

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']/vnfr:provider-network

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "physical-network": "STRING",
  "segmentation_id": 0
}

XML Sample

<vnfr:provider-network xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:physical-network>STRING</vnfr:physical-network>
  <vnfr:segmentation_id>0</vnfr:segmentation_id>
</vnfr:provider-network>

vnfr:ip-profiles

List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

XML Sample

<vnfr:ip-profiles xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:ip-profile-params>
    <vnfr:ip-version>ipv4</vnfr:ip-version>
    <vnfr:subnet-address>UNION_VALUE</vnfr:subnet-address>
    <vnfr:gateway-address>UNION_VALUE</vnfr:gateway-address>
    <vnfr:security-group>STRING</vnfr:security-group>
    <vnfr:dns-server>...</vnfr:dns-server>
    <vnfr:dhcp-params>...</vnfr:dhcp-params>
    <vnfr:subnet-prefix-pool>STRING</vnfr:subnet-prefix-pool>
  </vnfr:ip-profile-params>
</vnfr:ip-profiles>

vnfr:ip-profile-params

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

XML Sample

<vnfr:ip-profile-params xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ip-version>ipv4</vnfr:ip-version>
  <vnfr:subnet-address>UNION_VALUE</vnfr:subnet-address>
  <vnfr:gateway-address>UNION_VALUE</vnfr:gateway-address>
  <vnfr:security-group>STRING</vnfr:security-group>
  <vnfr:dns-server>
    <vnfr:address>UNION_VALUE</vnfr:address>
  </vnfr:dns-server>
  <vnfr:dhcp-params>
    <vnfr:enabled>true</vnfr:enabled>
    <vnfr:start-address>UNION_VALUE</vnfr:start-address>
    <vnfr:count>0</vnfr:count>
  </vnfr:dhcp-params>
  <vnfr:subnet-prefix-pool>STRING</vnfr:subnet-prefix-pool>
</vnfr:ip-profile-params>

vnfr:dns-server

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params/vnfr:dns-server

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params/vnfr:dns-server[vnfr:address='UNION_VALUE']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Sample

<vnfr:dns-server xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:address>UNION_VALUE</vnfr:address>
</vnfr:dns-server>

vnfr:dhcp-params

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params/vnfr:dhcp-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']/vnfr:ip-profile-params/vnfr:dhcp-params

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

XML Sample

<vnfr:dhcp-params xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:enabled>true</vnfr:enabled>
  <vnfr:start-address>UNION_VALUE</vnfr:start-address>
  <vnfr:count>0</vnfr:count>
</vnfr:dhcp-params>

vnfr:connection-point

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:connection-point

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:connection-point[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true
  }, {
    ...
  }
]

XML Sample

<vnfr:connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:id>STRING</vnfr:id>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
</vnfr:connection-point>

vnfr:vdu

List of Virtual Deployment Units

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "count": 0,
    "mgmt-vpci": "STRING",
    "vm-flavor": {
      "vcpu-count": 0,
      "memory-mb": 0,
      "storage-gb": 0
    },
    "guest-epa": {
      "trusted-execution": true,
      "mempage-size": "LARGE",
      "cpu-pinning-policy": "ANY",
      "cpu-thread-pinning-policy": "AVOID",
      "pcie-device": [ { ... }, { ... } ],
      "numa-unaware": [null],
      "numa-node-policy": { ... }
    },
    "vswitch-epa": {
      "ovs-acceleration": "MANDATORY",
      "ovs-offload": "MANDATORY"
    },
    "hypervisor-epa": {
      "type": "PREFER_KVM",
      "version": "STRING"
    },
    "host-epa": {
      "cpu-model": "PREFER_WESTMERE",
      "cpu-arch": "PREFER_X86",
      "cpu-vendor": "PREFER_INTEL",
      "cpu-socket-count": 0,
      "cpu-core-count": 0,
      "cpu-core-thread-count": 0,
      "cpu-feature": [ { ... }, { ... } ],
      "om-cpu-model-string": "STRING",
      "om-cpu-feature": [ { ... }, { ... } ]
    },
    "alarm": [
      {
        "alarm-id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "vdur-id": "STRING",
        "actions": { ... },
        "repeat": true,
        "enabled": true,
        "severity": "LOW",
        "metric": "CPU_UTILIZATION",
        "statistic": "AVERAGE",
        "operation": "GE",
        "value": 0.0,
        "period": 0,
        "evaluations": 0
      }, {
        ...
      }
    ],
    "image": "STRING",
    "image-checksum": "STRING",
    "alternative-images": [
      {
        "vim-type": "STRING",
        "image": "STRING",
        "image-checksum": "STRING"
      }, {
        ...
      }
    ],
    "vdu-configuration": {
      "script": { ... },
      "juju": { ... },
      "config-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ]
    },
    "cloud-init": "STRING",
    "cloud-init-file": "STRING",
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false
    },
    "internal-connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "internal-vld-ref": "STRING"
      }, {
        ...
      }
    ],
    "interface": [
      {
        "name": "STRING",
        "position": 0,
        "type": "EXTERNAL",
        "mac-address": "STRING",
        "internal-connection-point-ref": "STRING",
        "external-connection-point-ref": "STRING",
        "virtual-interface": { ... }
      }, {
        ...
      }
    ],
    "volumes": [
      {
        "name": "STRING",
        "description": "STRING",
        "size": 0,
        "ephemeral": [null],
        "image": "STRING",
        "image-checksum": "STRING",
        "device-bus": "ide",
        "device-type": "disk"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:vdu xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:count>0</vnfr:count>
  <vnfr:mgmt-vpci>STRING</vnfr:mgmt-vpci>
  <vnfr:vm-flavor>
    <vnfr:vcpu-count>0</vnfr:vcpu-count>
    <vnfr:memory-mb>0</vnfr:memory-mb>
    <vnfr:storage-gb>0</vnfr:storage-gb>
  </vnfr:vm-flavor>
  <vnfr:guest-epa>
    <vnfr:trusted-execution>true</vnfr:trusted-execution>
    <vnfr:mempage-size>LARGE</vnfr:mempage-size>
    <vnfr:cpu-pinning-policy>ANY</vnfr:cpu-pinning-policy>
    <vnfr:cpu-thread-pinning-policy>AVOID</vnfr:cpu-thread-pinning-policy>
    <vnfr:pcie-device>...</vnfr:pcie-device>
    <vnfr:numa-unaware/>
    <vnfr:numa-node-policy>...</vnfr:numa-node-policy>
  </vnfr:guest-epa>
  <vnfr:vswitch-epa>
    <vnfr:ovs-acceleration>MANDATORY</vnfr:ovs-acceleration>
    <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
  </vnfr:vswitch-epa>
  <vnfr:hypervisor-epa>
    <vnfr:type>PREFER_KVM</vnfr:type>
    <vnfr:version>STRING</vnfr:version>
  </vnfr:hypervisor-epa>
  <vnfr:host-epa>
    <vnfr:cpu-model>PREFER_WESTMERE</vnfr:cpu-model>
    <vnfr:cpu-arch>PREFER_X86</vnfr:cpu-arch>
    <vnfr:cpu-vendor>PREFER_INTEL</vnfr:cpu-vendor>
    <vnfr:cpu-socket-count>0</vnfr:cpu-socket-count>
    <vnfr:cpu-core-count>0</vnfr:cpu-core-count>
    <vnfr:cpu-core-thread-count>0</vnfr:cpu-core-thread-count>
    <vnfr:cpu-feature>...</vnfr:cpu-feature>
    <vnfr:om-cpu-model-string>STRING</vnfr:om-cpu-model-string>
    <vnfr:om-cpu-feature>...</vnfr:om-cpu-feature>
  </vnfr:host-epa>
  <vnfr:alarm>
    <vnfr:alarm-id>STRING</vnfr:alarm-id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:vdur-id>STRING</vnfr:vdur-id>
    <vnfr:actions>...</vnfr:actions>
    <vnfr:repeat>true</vnfr:repeat>
    <vnfr:enabled>true</vnfr:enabled>
    <vnfr:severity>LOW</vnfr:severity>
    <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
    <vnfr:statistic>AVERAGE</vnfr:statistic>
    <vnfr:operation>GE</vnfr:operation>
    <vnfr:value>0.0</vnfr:value>
    <vnfr:period>0</vnfr:period>
    <vnfr:evaluations>0</vnfr:evaluations>
  </vnfr:alarm>
  <vnfr:image>STRING</vnfr:image>
  <vnfr:image-checksum>STRING</vnfr:image-checksum>
  <vnfr:alternative-images>
    <vnfr:vim-type>STRING</vnfr:vim-type>
    <vnfr:image>STRING</vnfr:image>
    <vnfr:image-checksum>STRING</vnfr:image-checksum>
  </vnfr:alternative-images>
  <vnfr:vdu-configuration>
    <vnfr:script>...</vnfr:script>
    <vnfr:juju>...</vnfr:juju>
    <vnfr:config-primitive>...</vnfr:config-primitive>
    <vnfr:initial-config-primitive>...</vnfr:initial-config-primitive>
  </vnfr:vdu-configuration>
  <vnfr:cloud-init>STRING</vnfr:cloud-init>
  <vnfr:cloud-init-file>STRING</vnfr:cloud-init-file>
  <vnfr:supplemental-boot-data>
    <vnfr:config-file>...</vnfr:config-file>
    <vnfr:boot-data-drive>false</vnfr:boot-data-drive>
  </vnfr:supplemental-boot-data>
  <vnfr:internal-connection-point>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
    <vnfr:internal-vld-ref>STRING</vnfr:internal-vld-ref>
  </vnfr:internal-connection-point>
  <vnfr:interface>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:position>0</vnfr:position>
    <vnfr:type>EXTERNAL</vnfr:type>
    <vnfr:mac-address>STRING</vnfr:mac-address>
    <vnfr:internal-connection-point-ref>STRING</vnfr:internal-connection-point-ref>
    <vnfr:external-connection-point-ref>STRING</vnfr:external-connection-point-ref>
    <vnfr:virtual-interface>...</vnfr:virtual-interface>
  </vnfr:interface>
  <vnfr:volumes>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:size>0</vnfr:size>
    <vnfr:ephemeral/>
    <vnfr:image>STRING</vnfr:image>
    <vnfr:image-checksum>STRING</vnfr:image-checksum>
    <vnfr:device-bus>ide</vnfr:device-bus>
    <vnfr:device-type>disk</vnfr:device-type>
  </vnfr:volumes>
</vnfr:vdu>

vnfr:vm-flavor

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vm-flavor

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vm-flavor

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "vcpu-count": 0,
  "memory-mb": 0,
  "storage-gb": 0
}

XML Sample

<vnfr:vm-flavor xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:vcpu-count>0</vnfr:vcpu-count>
  <vnfr:memory-mb>0</vnfr:memory-mb>
  <vnfr:storage-gb>0</vnfr:storage-gb>
</vnfr:vm-flavor>

vnfr:guest-epa

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "trusted-execution": true,
  "mempage-size": "LARGE",
  "cpu-pinning-policy": "ANY",
  "cpu-thread-pinning-policy": "AVOID",
  "pcie-device": [
    {
      "device-id": "STRING",
      "count": 0
    }, {
      ...
    }
  ],
  "numa-unaware": [null],
  "numa-node-policy": {
    "node-cnt": 0,
    "mem-policy": "STRICT",
    "node": [ { ... }, { ... } ]
  }
}

XML Sample

<vnfr:guest-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:trusted-execution>true</vnfr:trusted-execution>
  <vnfr:mempage-size>LARGE</vnfr:mempage-size>
  <vnfr:cpu-pinning-policy>ANY</vnfr:cpu-pinning-policy>
  <vnfr:cpu-thread-pinning-policy>AVOID</vnfr:cpu-thread-pinning-policy>
  <vnfr:pcie-device>
    <vnfr:device-id>STRING</vnfr:device-id>
    <vnfr:count>0</vnfr:count>
  </vnfr:pcie-device>
  <vnfr:numa-unaware/>
  <vnfr:numa-node-policy>
    <vnfr:node-cnt>0</vnfr:node-cnt>
    <vnfr:mem-policy>STRICT</vnfr:mem-policy>
    <vnfr:node>...</vnfr:node>
  </vnfr:numa-node-policy>
</vnfr:guest-epa>

vnfr:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:pcie-device

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:pcie-device[vnfr:device-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "device-id": "STRING",
    "count": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:pcie-device xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:device-id>STRING</vnfr:device-id>
  <vnfr:count>0</vnfr:count>
</vnfr:pcie-device>

vnfr:numa-node-policy

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "node-cnt": 0,
  "mem-policy": "STRICT",
  "node": [
    {
      "id": 0,
      "vcpu": [ { ... }, { ... } ],
      "memory-mb": 0,
      "num-cores": 0,
      "paired-threads": { ... },
      "num-threads": 0
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:numa-node-policy xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:node-cnt>0</vnfr:node-cnt>
  <vnfr:mem-policy>STRICT</vnfr:mem-policy>
  <vnfr:node>
    <vnfr:id>0</vnfr:id>
    <vnfr:vcpu>...</vnfr:vcpu>
    <vnfr:memory-mb>0</vnfr:memory-mb>
    <vnfr:num-cores>0</vnfr:num-cores>
    <vnfr:paired-threads>...</vnfr:paired-threads>
    <vnfr:num-threads>0</vnfr:num-threads>
  </vnfr:node>
</vnfr:numa-node-policy>

vnfr:node

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "id": 0,
    "vcpu": [
      {
        "id": 0
      }, {
        ...
      }
    ],
    "memory-mb": 0,
    "num-cores": 0,
    "paired-threads": {
      "num-paired-threads": 0,
      "paired-thread-ids": [ { ... }, { ... } ]
    },
    "num-threads": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:node xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>0</vnfr:id>
  <vnfr:vcpu>
    <vnfr:id>0</vnfr:id>
  </vnfr:vcpu>
  <vnfr:memory-mb>0</vnfr:memory-mb>
  <vnfr:num-cores>0</vnfr:num-cores>
  <vnfr:paired-threads>
    <vnfr:num-paired-threads>0</vnfr:num-paired-threads>
    <vnfr:paired-thread-ids>...</vnfr:paired-thread-ids>
  </vnfr:paired-threads>
  <vnfr:num-threads>0</vnfr:num-threads>
</vnfr:node>

vnfr:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:vcpu

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:vcpu[vnfr:id='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:vcpu xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>0</vnfr:id>
</vnfr:vcpu>

vnfr:paired-threads

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "num-paired-threads": 0,
  "paired-thread-ids": [
    {
      "thread-a": 0,
      "thread-b": 0
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:paired-threads xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:num-paired-threads>0</vnfr:num-paired-threads>
  <vnfr:paired-thread-ids>
    <vnfr:thread-a>0</vnfr:thread-a>
    <vnfr:thread-b>0</vnfr:thread-b>
  </vnfr:paired-thread-ids>
</vnfr:paired-threads>

vnfr:paired-thread-ids

List of thread pairs to use in case of paired-thread NUMA

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads/vnfr:paired-thread-ids

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads/vnfr:paired-thread-ids[vnfr:thread-a='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "thread-a": 0,
    "thread-b": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:paired-thread-ids xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:thread-a>0</vnfr:thread-a>
  <vnfr:thread-b>0</vnfr:thread-b>
</vnfr:paired-thread-ids>

vnfr:vswitch-epa

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vswitch-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vswitch-epa

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "ovs-acceleration": "MANDATORY",
  "ovs-offload": "MANDATORY"
}

XML Sample

<vnfr:vswitch-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ovs-acceleration>MANDATORY</vnfr:ovs-acceleration>
  <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
</vnfr:vswitch-epa>

vnfr:hypervisor-epa

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:hypervisor-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:hypervisor-epa

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/hypervisor-epa

Fields

Name	Type	Description
type	ENUM	Specifies the type of hypervisor. KVM: KVM XEN: XEN
version	STRING

JSON Sample

{
  "type": "PREFER_KVM",
  "version": "STRING"
}

XML Sample

<vnfr:hypervisor-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>PREFER_KVM</vnfr:type>
  <vnfr:version>STRING</vnfr:version>
</vnfr:hypervisor-epa>

vnfr:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "cpu-model": "PREFER_WESTMERE",
  "cpu-arch": "PREFER_X86",
  "cpu-vendor": "PREFER_INTEL",
  "cpu-socket-count": 0,
  "cpu-core-count": 0,
  "cpu-core-thread-count": 0,
  "cpu-feature": [
    {
      "feature": "PREFER_AES"
    }, {
      ...
    }
  ],
  "om-cpu-model-string": "STRING",
  "om-cpu-feature": [
    {
      "feature": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:host-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:cpu-model>PREFER_WESTMERE</vnfr:cpu-model>
  <vnfr:cpu-arch>PREFER_X86</vnfr:cpu-arch>
  <vnfr:cpu-vendor>PREFER_INTEL</vnfr:cpu-vendor>
  <vnfr:cpu-socket-count>0</vnfr:cpu-socket-count>
  <vnfr:cpu-core-count>0</vnfr:cpu-core-count>
  <vnfr:cpu-core-thread-count>0</vnfr:cpu-core-thread-count>
  <vnfr:cpu-feature>
    <vnfr:feature>PREFER_AES</vnfr:feature>
  </vnfr:cpu-feature>
  <vnfr:om-cpu-model-string>STRING</vnfr:om-cpu-model-string>
  <vnfr:om-cpu-feature>
    <vnfr:feature>STRING</vnfr:feature>
  </vnfr:om-cpu-feature>
</vnfr:host-epa>

vnfr:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa/vnfr:cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa/vnfr:cpu-feature[vnfr:feature='PREFER_AES']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

[
  {
    "feature": "PREFER_AES"
  }, {
    ...
  }
]

XML Sample

<vnfr:cpu-feature xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:feature>PREFER_AES</vnfr:feature>
</vnfr:cpu-feature>

vnfr:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa/vnfr:om-cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa/vnfr:om-cpu-feature[vnfr:feature='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

[
  {
    "feature": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:om-cpu-feature xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:feature>STRING</vnfr:feature>
</vnfr:om-cpu-feature>

vnfr:alarm

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "alarm-id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "vdur-id": "STRING",
    "actions": {
      "ok": [ { ... }, { ... } ],
      "insufficient-data": [ { ... }, { ... } ],
      "alarm": [ { ... }, { ... } ]
    },
    "repeat": true,
    "enabled": true,
    "severity": "LOW",
    "metric": "CPU_UTILIZATION",
    "statistic": "AVERAGE",
    "operation": "GE",
    "value": 0.0,
    "period": 0,
    "evaluations": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:alarm-id>STRING</vnfr:alarm-id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:vdur-id>STRING</vnfr:vdur-id>
  <vnfr:actions>
    <vnfr:ok>...</vnfr:ok>
    <vnfr:insufficient-data>...</vnfr:insufficient-data>
    <vnfr:alarm>...</vnfr:alarm>
  </vnfr:actions>
  <vnfr:repeat>true</vnfr:repeat>
  <vnfr:enabled>true</vnfr:enabled>
  <vnfr:severity>LOW</vnfr:severity>
  <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
  <vnfr:statistic>AVERAGE</vnfr:statistic>
  <vnfr:operation>GE</vnfr:operation>
  <vnfr:value>0.0</vnfr:value>
  <vnfr:period>0</vnfr:period>
  <vnfr:evaluations>0</vnfr:evaluations>
</vnfr:alarm>

vnfr:actions

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions

Fields

Name	Type	Description
ok	LIST
insufficient-data	LIST
alarm	LIST

JSON Sample

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:actions xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ok>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:ok>
  <vnfr:insufficient-data>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:insufficient-data>
  <vnfr:alarm>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:alarm>
</vnfr:actions>

vnfr:ok

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:ok

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:ok[vnfr:url='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/ok/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:ok xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:ok>

vnfr:insufficient-data

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:insufficient-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/insufficient-data/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:insufficient-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:insufficient-data>

vnfr:alarm

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:alarm

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:alarm[vnfr:url='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/alarm/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:alarm>

vnfr:alternative-images

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alternative-images

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alternative-images[vnfr:vim-type='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "vim-type": "STRING",
    "image": "STRING",
    "image-checksum": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:alternative-images xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:vim-type>STRING</vnfr:vim-type>
  <vnfr:image>STRING</vnfr:image>
  <vnfr:image-checksum>STRING</vnfr:image-checksum>
</vnfr:alternative-images>

vnfr:vdu-configuration

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING",
    "proxy": true,
    "vca-relationships": { ... }
  },
  "config-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vdu-configuration xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script>
    <vnfr:script-type>rift</vnfr:script-type>
  </vnfr:script>
  <vnfr:juju>
    <vnfr:charm>STRING</vnfr:charm>
    <vnfr:proxy>true</vnfr:proxy>
    <vnfr:vca-relationships>...</vnfr:vca-relationships>
  </vnfr:juju>
  <vnfr:config-primitive>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
  </vnfr:config-primitive>
  <vnfr:initial-config-primitive>
    <vnfr:seq>0</vnfr:seq>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
  </vnfr:initial-config-primitive>
</vnfr:vdu-configuration>

vnfr:script

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration/vnfr:script

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:script

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/vdu-configuration/script

Fields

Name	Type	Description
script-type	ENUM	Script type - currently supported - Scripts confirming to Rift CA plugin

JSON Sample

{
  "script-type": "rift"
}

XML Sample

<vnfr:script xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script-type>rift</vnfr:script-type>
</vnfr:script>

vnfr:juju

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration/vnfr:juju

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:juju

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "charm": "STRING",
  "proxy": true,
  "vca-relationships": {
    "relation": [ { ... }, { ... } ]
  }
}

XML Sample

<vnfr:juju xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:charm>STRING</vnfr:charm>
  <vnfr:proxy>true</vnfr:proxy>
  <vnfr:vca-relationships>
    <vnfr:relation>...</vnfr:relation>
  </vnfr:vca-relationships>
</vnfr:juju>

vnfr:vca-relationships

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration/vnfr:juju/vnfr:vca-relationships

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:juju/vnfr:vca-relationships

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/vdu-configuration/juju/vca-relationships

Fields

Name	Type	Description
relation	LIST	List of relations between VCA componets.

JSON Sample

{
  "relation": [
    {
      "requires": "STRING",
      "provides": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vca-relationships xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:relation>
    <vnfr:requires>STRING</vnfr:requires>
    <vnfr:provides>STRING</vnfr:provides>
  </vnfr:relation>
</vnfr:vca-relationships>

vnfr:relation

List of relations between VCA componets.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration/vnfr:juju/vnfr:vca-relationships/vnfr:relation

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:juju/vnfr:vca-relationships/vnfr:relation[vnfr:requires='STRING'][vnfr:provides='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "requires": "STRING",
    "provides": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:relation xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:requires>STRING</vnfr:requires>
  <vnfr:provides>STRING</vnfr:provides>
</vnfr:relation>

vnfr:config-primitive

List of config primitives supported by the configuration agent for this VNF or VDU.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration/vnfr:config-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:config-primitive[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:config-primitive xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:parameter>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:data-type>STRING</vnfr:data-type>
    <vnfr:mandatory>false</vnfr:mandatory>
    <vnfr:default-value>STRING</vnfr:default-value>
    <vnfr:parameter-pool>STRING</vnfr:parameter-pool>
    <vnfr:read-only>false</vnfr:read-only>
    <vnfr:hidden>false</vnfr:hidden>
  </vnfr:parameter>
  <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
</vnfr:config-primitive>

vnfr:parameter

List of parameters to the config primitive.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration/vnfr:config-primitive/vnfr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:config-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Sample

<vnfr:parameter xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:data-type>STRING</vnfr:data-type>
  <vnfr:mandatory>false</vnfr:mandatory>
  <vnfr:default-value>STRING</vnfr:default-value>
  <vnfr:parameter-pool>STRING</vnfr:parameter-pool>
  <vnfr:read-only>false</vnfr:read-only>
  <vnfr:hidden>false</vnfr:hidden>
</vnfr:parameter>

vnfr:initial-config-primitive

Initial set of configuration primitives.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration/vnfr:initial-config-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:initial-config-primitive[vnfr:seq='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:initial-config-primitive xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:seq>0</vnfr:seq>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:parameter>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:value>STRING</vnfr:value>
  </vnfr:parameter>
  <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
</vnfr:initial-config-primitive>

vnfr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vdu-configuration/vnfr:initial-config-primitive/vnfr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:parameter xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:value>STRING</vnfr:value>
</vnfr:parameter>

vnfr:supplemental-boot-data

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:supplemental-boot-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:supplemental-boot-data

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false
}

XML Sample

<vnfr:supplemental-boot-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:config-file>
    <vnfr:source>STRING</vnfr:source>
    <vnfr:dest>STRING</vnfr:dest>
  </vnfr:config-file>
  <vnfr:boot-data-drive>false</vnfr:boot-data-drive>
</vnfr:supplemental-boot-data>

vnfr:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:supplemental-boot-data/vnfr:config-file

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:supplemental-boot-data/vnfr:config-file[vnfr:source='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "source": "STRING",
    "dest": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:config-file xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:source>STRING</vnfr:source>
  <vnfr:dest>STRING</vnfr:dest>
</vnfr:config-file>

vnfr:internal-connection-point

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-connection-point

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "internal-vld-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  <vnfr:internal-vld-ref>STRING</vnfr:internal-vld-ref>
</vnfr:internal-connection-point>

vnfr:interface

List of Interfaces (external and internal) for the VNF

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:interface

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:interface[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "position": 0,
    "type": "EXTERNAL",
    "mac-address": "STRING",
    "internal-connection-point-ref": "STRING",
    "external-connection-point-ref": "STRING",
    "virtual-interface": {
      "type": "VIRTIO",
      "vpci": "STRING",
      "bandwidth": 0
    }
  }, {
    ...
  }
]

XML Sample

<vnfr:interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:position>0</vnfr:position>
  <vnfr:type>EXTERNAL</vnfr:type>
  <vnfr:mac-address>STRING</vnfr:mac-address>
  <vnfr:internal-connection-point-ref>STRING</vnfr:internal-connection-point-ref>
  <vnfr:external-connection-point-ref>STRING</vnfr:external-connection-point-ref>
  <vnfr:virtual-interface>
    <vnfr:type>VIRTIO</vnfr:type>
    <vnfr:vpci>STRING</vnfr:vpci>
    <vnfr:bandwidth>0</vnfr:bandwidth>
  </vnfr:virtual-interface>
</vnfr:interface>

vnfr:virtual-interface

Container for the virtual interface properties

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:interface/vnfr:virtual-interface

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:interface[vnfr:name='STRING']/vnfr:virtual-interface

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "type": "VIRTIO",
  "vpci": "STRING",
  "bandwidth": 0
}

XML Sample

<vnfr:virtual-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>VIRTIO</vnfr:type>
  <vnfr:vpci>STRING</vnfr:vpci>
  <vnfr:bandwidth>0</vnfr:bandwidth>
</vnfr:virtual-interface>

vnfr:volumes

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:volumes

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:volumes[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "size": 0,
    "ephemeral": [null],
    "image": "STRING",
    "image-checksum": "STRING",
    "device-bus": "ide",
    "device-type": "disk"
  }, {
    ...
  }
]

XML Sample

<vnfr:volumes xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:size>0</vnfr:size>
  <vnfr:ephemeral/>
  <vnfr:image>STRING</vnfr:image>
  <vnfr:image-checksum>STRING</vnfr:image-checksum>
  <vnfr:device-bus>ide</vnfr:device-bus>
  <vnfr:device-type>disk</vnfr:device-type>
</vnfr:volumes>

vnfr:vdu-dependency

List of VDU dependencies.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu-dependency

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu-dependency[vnfr:vdu-source-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "vdu-source-ref": "STRING",
    "vdu-depends-on-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:vdu-dependency xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:vdu-source-ref>STRING</vnfr:vdu-source-ref>
  <vnfr:vdu-depends-on-ref>STRING</vnfr:vdu-depends-on-ref>
</vnfr:vdu-dependency>

vnfr:http-endpoint

List of http endpoints to be used by monitoring params

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:http-endpoint

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:http-endpoint[vnfr:path='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "path": "STRING",
    "https": false,
    "port": 0,
    "username": "STRING",
    "password": "STRING",
    "polling-interval-secs": 2,
    "method": "GET",
    "headers": [
      {
        "key": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:http-endpoint xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:path>STRING</vnfr:path>
  <vnfr:https>false</vnfr:https>
  <vnfr:port>0</vnfr:port>
  <vnfr:username>STRING</vnfr:username>
  <vnfr:password>STRING</vnfr:password>
  <vnfr:polling-interval-secs>2</vnfr:polling-interval-secs>
  <vnfr:method>GET</vnfr:method>
  <vnfr:headers>
    <vnfr:key>STRING</vnfr:key>
    <vnfr:value>STRING</vnfr:value>
  </vnfr:headers>
</vnfr:http-endpoint>

vnfr:headers

Custom HTTP headers to put on HTTP request

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:http-endpoint/vnfr:headers

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:http-endpoint[vnfr:path='STRING']/vnfr:headers[vnfr:key='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/http-endpoint/STRING/headers/STRING

Fields

Name	Type	Description
key	STRING	HTTP header key
value	STRING	HTTP header value

JSON Sample

[
  {
    "key": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:headers xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:key>STRING</vnfr:key>
  <vnfr:value>STRING</vnfr:value>
</vnfr:headers>

vnfr:monitoring-param

List of monitoring parameters at the network service level

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "http-endpoint-ref": "STRING",
    "json-query-method": "NAMEKEY",
    "json-query-params": {
      "json-path": "STRING",
      "object-path": "STRING"
    },
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:monitoring-param xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:http-endpoint-ref>STRING</vnfr:http-endpoint-ref>
  <vnfr:json-query-method>NAMEKEY</vnfr:json-query-method>
  <vnfr:json-query-params>
    <vnfr:json-path>STRING</vnfr:json-path>
    <vnfr:object-path>STRING</vnfr:object-path>
  </vnfr:json-query-params>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:group-tag>STRING</vnfr:group-tag>
  <vnfr:widget-type>COUNTER</vnfr:widget-type>
  <vnfr:units>STRING</vnfr:units>
  <vnfr:value-type>INT</vnfr:value-type>
  <vnfr:numeric-constraints>
    <vnfr:min-value>0</vnfr:min-value>
    <vnfr:max-value>0</vnfr:max-value>
  </vnfr:numeric-constraints>
  <vnfr:text-constraints>
    <vnfr:min-length>0</vnfr:min-length>
    <vnfr:max-length>0</vnfr:max-length>
  </vnfr:text-constraints>
  <vnfr:value-integer>0</vnfr:value-integer>
  <vnfr:value-decimal>0.0</vnfr:value-decimal>
  <vnfr:value-string>STRING</vnfr:value-string>
</vnfr:monitoring-param>

vnfr:json-query-params

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:json-query-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:json-query-params

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "json-path": "STRING",
  "object-path": "STRING"
}

XML Sample

<vnfr:json-query-params xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:json-path>STRING</vnfr:json-path>
  <vnfr:object-path>STRING</vnfr:object-path>
</vnfr:json-query-params>

vnfr:numeric-constraints

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:numeric-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:numeric-constraints

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "min-value": 0,
  "max-value": 0
}

XML Sample

<vnfr:numeric-constraints xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:min-value>0</vnfr:min-value>
  <vnfr:max-value>0</vnfr:max-value>
</vnfr:numeric-constraints>

vnfr:text-constraints

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:text-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:text-constraints

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

{
  "min-length": 0,
  "max-length": 0
}

XML Sample

<vnfr:text-constraints xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:min-length>0</vnfr:min-length>
  <vnfr:max-length>0</vnfr:max-length>
</vnfr:text-constraints>

vnfr:placement-groups

List of placement groups at VNF level

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:placement-groups

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:placement-groups[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vdus": [
      {
        "member-vdu-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:placement-groups xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:requirement>STRING</vnfr:requirement>
  <vnfr:strategy>COLOCATION</vnfr:strategy>
  <vnfr:member-vdus>
    <vnfr:member-vdu-ref>STRING</vnfr:member-vdu-ref>
  </vnfr:member-vdus>
</vnfr:placement-groups>

vnfr:member-vdus

List of VDUs that are part of this placement group

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:placement-groups/vnfr:member-vdus

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:placement-groups[vnfr:name='STRING']/vnfr:member-vdus[vnfr:member-vdu-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnfd/placement-groups/STRING/member-vdus/STRING

Fields

Name	Type	Description
member-vdu-ref	LEAFREF

JSON Sample

[
  {
    "member-vdu-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:member-vdus xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:member-vdu-ref>STRING</vnfr:member-vdu-ref>
</vnfr:member-vdus>

vnfr:vnf-configuration

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING",
    "proxy": true,
    "vca-relationships": { ... }
  },
  "config-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vnf-configuration xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script>
    <vnfr:script-type>rift</vnfr:script-type>
  </vnfr:script>
  <vnfr:juju>
    <vnfr:charm>STRING</vnfr:charm>
    <vnfr:proxy>true</vnfr:proxy>
    <vnfr:vca-relationships>...</vnfr:vca-relationships>
  </vnfr:juju>
  <vnfr:config-primitive>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
  </vnfr:config-primitive>
  <vnfr:initial-config-primitive>
    <vnfr:seq>0</vnfr:seq>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
  </vnfr:initial-config-primitive>
</vnfr:vnf-configuration>

vnfr:script

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:script

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:script

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/script

Fields

Name	Type	Description
script-type	ENUM	Script type - currently supported - Scripts confirming to Rift CA plugin

JSON Sample

{
  "script-type": "rift"
}

XML Sample

<vnfr:script xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script-type>rift</vnfr:script-type>
</vnfr:script>

vnfr:juju

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:juju

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:juju

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

{
  "charm": "STRING",
  "proxy": true,
  "vca-relationships": {
    "relation": [ { ... }, { ... } ]
  }
}

XML Sample

<vnfr:juju xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:charm>STRING</vnfr:charm>
  <vnfr:proxy>true</vnfr:proxy>
  <vnfr:vca-relationships>
    <vnfr:relation>...</vnfr:relation>
  </vnfr:vca-relationships>
</vnfr:juju>

vnfr:vca-relationships

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:juju/vnfr:vca-relationships

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:juju/vnfr:vca-relationships

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/juju/vca-relationships

Fields

Name	Type	Description
relation	LIST	List of relations between VCA componets.

JSON Sample

{
  "relation": [
    {
      "requires": "STRING",
      "provides": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vca-relationships xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:relation>
    <vnfr:requires>STRING</vnfr:requires>
    <vnfr:provides>STRING</vnfr:provides>
  </vnfr:relation>
</vnfr:vca-relationships>

vnfr:relation

List of relations between VCA componets.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:juju/vnfr:vca-relationships/vnfr:relation

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:juju/vnfr:vca-relationships/vnfr:relation[vnfr:requires='STRING'][vnfr:provides='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

[
  {
    "requires": "STRING",
    "provides": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:relation xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:requires>STRING</vnfr:requires>
  <vnfr:provides>STRING</vnfr:provides>
</vnfr:relation>

vnfr:config-primitive

List of config primitives supported by the configuration agent for this VNF or VDU.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:config-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:config-primitive[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:config-primitive xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:parameter>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:data-type>STRING</vnfr:data-type>
    <vnfr:mandatory>false</vnfr:mandatory>
    <vnfr:default-value>STRING</vnfr:default-value>
    <vnfr:parameter-pool>STRING</vnfr:parameter-pool>
    <vnfr:read-only>false</vnfr:read-only>
    <vnfr:hidden>false</vnfr:hidden>
  </vnfr:parameter>
  <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
</vnfr:config-primitive>

vnfr:parameter

List of parameters to the config primitive.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:config-primitive/vnfr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:config-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Sample

<vnfr:parameter xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:data-type>STRING</vnfr:data-type>
  <vnfr:mandatory>false</vnfr:mandatory>
  <vnfr:default-value>STRING</vnfr:default-value>
  <vnfr:parameter-pool>STRING</vnfr:parameter-pool>
  <vnfr:read-only>false</vnfr:read-only>
  <vnfr:hidden>false</vnfr:hidden>
</vnfr:parameter>

vnfr:initial-config-primitive

Initial set of configuration primitives.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:initial-config-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:initial-config-primitive xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:seq>0</vnfr:seq>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:parameter>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:value>STRING</vnfr:value>
  </vnfr:parameter>
  <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
</vnfr:initial-config-primitive>

vnfr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:initial-config-primitive/vnfr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:parameter xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:value>STRING</vnfr:value>
</vnfr:parameter>

vnfr:mgmt-interface

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:mgmt-interface

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:mgmt-interface

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/mgmt-interface

Fields

Name	Type	Description
ip-address	UNION
port	UINT16
ssh-key	CONTAINER	SSH key pair used for this VNF

JSON Sample

{
  "ip-address": "UNION_VALUE",
  "port": 0,
  "ssh-key": {
    "public-key": "STRING",
    "private-key-file": "STRING"
  }
}

XML Sample

<vnfr:mgmt-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:port>0</vnfr:port>
  <vnfr:ssh-key>
    <vnfr:public-key>STRING</vnfr:public-key>
    <vnfr:private-key-file>STRING</vnfr:private-key-file>
  </vnfr:ssh-key>
</vnfr:mgmt-interface>

vnfr:ssh-key

SSH key pair used for this VNF

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:mgmt-interface/vnfr:ssh-key

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:mgmt-interface/vnfr:ssh-key

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/mgmt-interface/ssh-key

Fields

Name	Type	Description
public-key	STRING	Public key configured on this VNF
private-key-file	STRING	Path to the private key file

JSON Sample

{
  "public-key": "STRING",
  "private-key-file": "STRING"
}

XML Sample

<vnfr:ssh-key xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:public-key>STRING</vnfr:public-key>
  <vnfr:private-key-file>STRING</vnfr:private-key-file>
</vnfr:ssh-key>

vnfr:internal-vlr

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:internal-vlr

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:internal-vlr[vnfr:vlr-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/internal-vlr/STRING

Fields

Name	Type	Description
vlr-ref	LEAFREF	Reference to a VLR record in the VLR catalog
internal-connection-point-ref	LEAF_LIST

JSON Sample

[
  {
    "vlr-ref": "STRING",
    "internal-connection-point-ref": [ "STRING", ... ]
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-vlr xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:vlr-ref>STRING</vnfr:vlr-ref>
  <vnfr:internal-connection-point-ref>STRING</vnfr:internal-connection-point-ref>
  <vnfr:internal-connection-point-ref>...</vnfr:internal-connection-point-ref>
</vnfr:internal-vlr>

vnfr:internal-connection-point-ref

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:internal-vlr/vnfr:internal-connection-point-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:internal-vlr[vnfr:vlr-ref='STRING']/vnfr:internal-connection-point-ref

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/internal-vlr/STRING/internal-connection-point-ref

JSON Sample

[ "STRING", ... ]

XML Sample

<vnfr:internal-connection-point-ref xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">STRING</vnfr:internal-connection-point-ref>
<vnfr:internal-connection-point-ref xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">...</vnfr:internal-connection-point-ref>

vnfr:connection-point

List for external connection points. Each VNF has one or more external connection points. As the name implies that external connection points are used for connecting the VNF to other VNFs or to external networks. Each VNF exposes these connection points to the orchestrator. The orchestrator 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/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:connection-point

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:connection-point[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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
vlr-ref	LEAFREF	Reference to the VLR associated with this connection point
ip-address	UNION	IP address assigned to the external connection point
mac-address	STRING	MAC address assigned to the external connection point
connection-point-id	STRING
virtual-cps	LIST

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "vlr-ref": "STRING",
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING",
    "connection-point-id": "STRING",
    "virtual-cps": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING",
        "connection-point-id": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:id>STRING</vnfr:id>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  <vnfr:vlr-ref>STRING</vnfr:vlr-ref>
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:mac-address>STRING</vnfr:mac-address>
  <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
  <vnfr:virtual-cps>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:mac-address>STRING</vnfr:mac-address>
    <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
  </vnfr:virtual-cps>
</vnfr:connection-point>

vnfr:virtual-cps

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:connection-point/vnfr:virtual-cps

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:connection-point[vnfr:name='STRING']/vnfr:virtual-cps[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/connection-point/STRING/virtual-cps/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
ip-address	UNION	IP address assigned to the virtual connection point
mac-address	STRING	MAC address assigned to the virtual connection point
connection-point-id	STRING	VIM identifier for connection point

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING",
    "connection-point-id": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:virtual-cps xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:id>STRING</vnfr:id>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:mac-address>STRING</vnfr:mac-address>
  <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
</vnfr:virtual-cps>

vnfr:vdur

List of Virtual Deployment Units

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING

Fields

Name	Type	Description
id	STRING	Unique id for the VDU
name	STRING	name of the instantiated VDUR
unique-short-name	STRING	Short Unique name of the VDU This will be of the format NSR name-ShortnedString-VDUname NSR name and VDU name shall be constrained to 10 characters
vdu-id-ref	LEAFREF
vim-id	STRING	Allocated VM resource id
flavor-id	STRING	VIM assigned flavor id
image-id	STRING	VIM assigned image id
management-ip	UNION	Management IP address
vm-management-ip	UNION	VM Private Management IP address
console-url	STRING	Console URL for this VDU, if available
vm-flavor	CONTAINER
guest-epa	CONTAINER
vswitch-epa	CONTAINER
hypervisor-epa	CONTAINER
host-epa	CONTAINER	Specifies the host level EPA attributes.
supplemental-boot-data	CONTAINER
vdu-configuration	CONTAINER
volumes	LIST
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 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 (internal and external) for the VNF
operational-status	ENUM	The operational status of the VDU init : The VDU has just started. vm-init-phase : The VDUs in the VNF is being created in VIM. vm-alloc-pending : The VM alloc is pending in VIM running : The VDU is active in VM upgrading : The VDU is being upgraded (EXPERIMENTAL) terminate : The VDU is being terminated vm-terminate-phase : The VDU in the VNF is being terminated in VIM. terminated : The VDU is in the terminated state. failed : The VDU instantiation failed.
placement-groups-info	LIST	Placement groups to which this VDU belongs and its cloud construct

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "unique-short-name": "STRING",
    "vdu-id-ref": "STRING",
    "vim-id": "STRING",
    "flavor-id": "STRING",
    "image-id": "STRING",
    "management-ip": "UNION_VALUE",
    "vm-management-ip": "UNION_VALUE",
    "console-url": "STRING",
    "vm-flavor": {
      "vcpu-count": 0,
      "memory-mb": 0,
      "storage-gb": 0
    },
    "guest-epa": {
      "trusted-execution": true,
      "mempage-size": "LARGE",
      "cpu-pinning-policy": "ANY",
      "cpu-thread-pinning-policy": "AVOID",
      "pcie-device": [ { ... }, { ... } ],
      "numa-unaware": [null],
      "numa-node-policy": { ... }
    },
    "vswitch-epa": {
      "ovs-acceleration": "MANDATORY",
      "ovs-offload": "MANDATORY"
    },
    "hypervisor-epa": {
      "type": "PREFER_KVM",
      "version": "STRING"
    },
    "host-epa": {
      "cpu-model": "PREFER_WESTMERE",
      "cpu-arch": "PREFER_X86",
      "cpu-vendor": "PREFER_INTEL",
      "cpu-socket-count": 0,
      "cpu-core-count": 0,
      "cpu-core-thread-count": 0,
      "cpu-feature": [ { ... }, { ... } ],
      "om-cpu-model-string": "STRING",
      "om-cpu-feature": [ { ... }, { ... } ]
    },
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false
    },
    "vdu-configuration": {
      "script": { ... },
      "juju": { ... },
      "config-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ]
    },
    "volumes": [
      {
        "name": "STRING",
        "volume-id": "STRING",
        "description": "STRING",
        "size": 0,
        "ephemeral": [null],
        "image": "STRING",
        "image-checksum": "STRING",
        "device-bus": "ide",
        "device-type": "disk"
      }, {
        ...
      }
    ],
    "internal-connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING",
        "connection-point-id": "STRING",
        "virtual-cps": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "interface": [
      {
        "name": "STRING",
        "position": 0,
        "type": "EXTERNAL",
        "internal-connection-point-ref": "STRING",
        "external-connection-point-ref": "STRING",
        "virtual-interface": { ... }
      }, {
        ...
      }
    ],
    "operational-status": "init",
    "placement-groups-info": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:vdur xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:unique-short-name>STRING</vnfr:unique-short-name>
  <vnfr:vdu-id-ref>STRING</vnfr:vdu-id-ref>
  <vnfr:vim-id>STRING</vnfr:vim-id>
  <vnfr:flavor-id>STRING</vnfr:flavor-id>
  <vnfr:image-id>STRING</vnfr:image-id>
  <vnfr:management-ip>UNION_VALUE</vnfr:management-ip>
  <vnfr:vm-management-ip>UNION_VALUE</vnfr:vm-management-ip>
  <vnfr:console-url>STRING</vnfr:console-url>
  <vnfr:vm-flavor>
    <vnfr:vcpu-count>0</vnfr:vcpu-count>
    <vnfr:memory-mb>0</vnfr:memory-mb>
    <vnfr:storage-gb>0</vnfr:storage-gb>
  </vnfr:vm-flavor>
  <vnfr:guest-epa>
    <vnfr:trusted-execution>true</vnfr:trusted-execution>
    <vnfr:mempage-size>LARGE</vnfr:mempage-size>
    <vnfr:cpu-pinning-policy>ANY</vnfr:cpu-pinning-policy>
    <vnfr:cpu-thread-pinning-policy>AVOID</vnfr:cpu-thread-pinning-policy>
    <vnfr:pcie-device>...</vnfr:pcie-device>
    <vnfr:numa-unaware/>
    <vnfr:numa-node-policy>...</vnfr:numa-node-policy>
  </vnfr:guest-epa>
  <vnfr:vswitch-epa>
    <vnfr:ovs-acceleration>MANDATORY</vnfr:ovs-acceleration>
    <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
  </vnfr:vswitch-epa>
  <vnfr:hypervisor-epa>
    <vnfr:type>PREFER_KVM</vnfr:type>
    <vnfr:version>STRING</vnfr:version>
  </vnfr:hypervisor-epa>
  <vnfr:host-epa>
    <vnfr:cpu-model>PREFER_WESTMERE</vnfr:cpu-model>
    <vnfr:cpu-arch>PREFER_X86</vnfr:cpu-arch>
    <vnfr:cpu-vendor>PREFER_INTEL</vnfr:cpu-vendor>
    <vnfr:cpu-socket-count>0</vnfr:cpu-socket-count>
    <vnfr:cpu-core-count>0</vnfr:cpu-core-count>
    <vnfr:cpu-core-thread-count>0</vnfr:cpu-core-thread-count>
    <vnfr:cpu-feature>...</vnfr:cpu-feature>
    <vnfr:om-cpu-model-string>STRING</vnfr:om-cpu-model-string>
    <vnfr:om-cpu-feature>...</vnfr:om-cpu-feature>
  </vnfr:host-epa>
  <vnfr:supplemental-boot-data>
    <vnfr:config-file>...</vnfr:config-file>
    <vnfr:boot-data-drive>false</vnfr:boot-data-drive>
  </vnfr:supplemental-boot-data>
  <vnfr:vdu-configuration>
    <vnfr:script>...</vnfr:script>
    <vnfr:juju>...</vnfr:juju>
    <vnfr:config-primitive>...</vnfr:config-primitive>
    <vnfr:initial-config-primitive>...</vnfr:initial-config-primitive>
  </vnfr:vdu-configuration>
  <vnfr:volumes>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:volume-id>STRING</vnfr:volume-id>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:size>0</vnfr:size>
    <vnfr:ephemeral/>
    <vnfr:image>STRING</vnfr:image>
    <vnfr:image-checksum>STRING</vnfr:image-checksum>
    <vnfr:device-bus>ide</vnfr:device-bus>
    <vnfr:device-type>disk</vnfr:device-type>
  </vnfr:volumes>
  <vnfr:internal-connection-point>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:mac-address>STRING</vnfr:mac-address>
    <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
    <vnfr:virtual-cps>...</vnfr:virtual-cps>
  </vnfr:internal-connection-point>
  <vnfr:interface>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:position>0</vnfr:position>
    <vnfr:type>EXTERNAL</vnfr:type>
    <vnfr:internal-connection-point-ref>STRING</vnfr:internal-connection-point-ref>
    <vnfr:external-connection-point-ref>STRING</vnfr:external-connection-point-ref>
    <vnfr:virtual-interface>...</vnfr:virtual-interface>
  </vnfr:interface>
  <vnfr:operational-status>init</vnfr:operational-status>
  <vnfr:placement-groups-info>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:requirement>STRING</vnfr:requirement>
    <vnfr:strategy>COLOCATION</vnfr:strategy>
    <vnfr:cloud-type>aws</vnfr:cloud-type>
    <vnfr:availability-zone>...</vnfr:availability-zone>
    <vnfr:server-group>...</vnfr:server-group>
    <vnfr:host-aggregate>...</vnfr:host-aggregate>
    <vnfr:aws-construct/>
    <vnfr:openmano-construct/>
    <vnfr:vsphere-construct/>
    <vnfr:mock-construct/>
    <vnfr:cloudsim-construct/>
  </vnfr:placement-groups-info>
</vnfr:vdur>

vnfr:vm-flavor

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vm-flavor

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vm-flavor

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "vcpu-count": 0,
  "memory-mb": 0,
  "storage-gb": 0
}

XML Sample

<vnfr:vm-flavor xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:vcpu-count>0</vnfr:vcpu-count>
  <vnfr:memory-mb>0</vnfr:memory-mb>
  <vnfr:storage-gb>0</vnfr:storage-gb>
</vnfr:vm-flavor>

vnfr:guest-epa

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "trusted-execution": true,
  "mempage-size": "LARGE",
  "cpu-pinning-policy": "ANY",
  "cpu-thread-pinning-policy": "AVOID",
  "pcie-device": [
    {
      "device-id": "STRING",
      "count": 0
    }, {
      ...
    }
  ],
  "numa-unaware": [null],
  "numa-node-policy": {
    "node-cnt": 0,
    "mem-policy": "STRICT",
    "node": [ { ... }, { ... } ]
  }
}

XML Sample

<vnfr:guest-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:trusted-execution>true</vnfr:trusted-execution>
  <vnfr:mempage-size>LARGE</vnfr:mempage-size>
  <vnfr:cpu-pinning-policy>ANY</vnfr:cpu-pinning-policy>
  <vnfr:cpu-thread-pinning-policy>AVOID</vnfr:cpu-thread-pinning-policy>
  <vnfr:pcie-device>
    <vnfr:device-id>STRING</vnfr:device-id>
    <vnfr:count>0</vnfr:count>
  </vnfr:pcie-device>
  <vnfr:numa-unaware/>
  <vnfr:numa-node-policy>
    <vnfr:node-cnt>0</vnfr:node-cnt>
    <vnfr:mem-policy>STRICT</vnfr:mem-policy>
    <vnfr:node>...</vnfr:node>
  </vnfr:numa-node-policy>
</vnfr:guest-epa>

vnfr:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:pcie-device

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:pcie-device[vnfr:device-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "device-id": "STRING",
    "count": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:pcie-device xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:device-id>STRING</vnfr:device-id>
  <vnfr:count>0</vnfr:count>
</vnfr:pcie-device>

vnfr:numa-node-policy

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "node-cnt": 0,
  "mem-policy": "STRICT",
  "node": [
    {
      "id": 0,
      "vcpu": [ { ... }, { ... } ],
      "memory-mb": 0,
      "num-cores": 0,
      "paired-threads": { ... },
      "num-threads": 0
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:numa-node-policy xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:node-cnt>0</vnfr:node-cnt>
  <vnfr:mem-policy>STRICT</vnfr:mem-policy>
  <vnfr:node>
    <vnfr:id>0</vnfr:id>
    <vnfr:vcpu>...</vnfr:vcpu>
    <vnfr:memory-mb>0</vnfr:memory-mb>
    <vnfr:num-cores>0</vnfr:num-cores>
    <vnfr:paired-threads>...</vnfr:paired-threads>
    <vnfr:num-threads>0</vnfr:num-threads>
  </vnfr:node>
</vnfr:numa-node-policy>

vnfr:node

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "id": 0,
    "vcpu": [
      {
        "id": 0
      }, {
        ...
      }
    ],
    "memory-mb": 0,
    "num-cores": 0,
    "paired-threads": {
      "num-paired-threads": 0,
      "paired-thread-ids": [ { ... }, { ... } ]
    },
    "num-threads": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:node xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>0</vnfr:id>
  <vnfr:vcpu>
    <vnfr:id>0</vnfr:id>
  </vnfr:vcpu>
  <vnfr:memory-mb>0</vnfr:memory-mb>
  <vnfr:num-cores>0</vnfr:num-cores>
  <vnfr:paired-threads>
    <vnfr:num-paired-threads>0</vnfr:num-paired-threads>
    <vnfr:paired-thread-ids>...</vnfr:paired-thread-ids>
  </vnfr:paired-threads>
  <vnfr:num-threads>0</vnfr:num-threads>
</vnfr:node>

vnfr:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:vcpu

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:vcpu[vnfr:id='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:vcpu xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>0</vnfr:id>
</vnfr:vcpu>

vnfr:paired-threads

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "num-paired-threads": 0,
  "paired-thread-ids": [
    {
      "thread-a": 0,
      "thread-b": 0
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:paired-threads xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:num-paired-threads>0</vnfr:num-paired-threads>
  <vnfr:paired-thread-ids>
    <vnfr:thread-a>0</vnfr:thread-a>
    <vnfr:thread-b>0</vnfr:thread-b>
  </vnfr:paired-thread-ids>
</vnfr:paired-threads>

vnfr:paired-thread-ids

List of thread pairs to use in case of paired-thread NUMA

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads/vnfr:paired-thread-ids

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads/vnfr:paired-thread-ids[vnfr:thread-a='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "thread-a": 0,
    "thread-b": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:paired-thread-ids xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:thread-a>0</vnfr:thread-a>
  <vnfr:thread-b>0</vnfr:thread-b>
</vnfr:paired-thread-ids>

vnfr:vswitch-epa

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vswitch-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vswitch-epa

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "ovs-acceleration": "MANDATORY",
  "ovs-offload": "MANDATORY"
}

XML Sample

<vnfr:vswitch-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ovs-acceleration>MANDATORY</vnfr:ovs-acceleration>
  <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
</vnfr:vswitch-epa>

vnfr:hypervisor-epa

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:hypervisor-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:hypervisor-epa

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/hypervisor-epa

Fields

Name	Type	Description
type	ENUM	Specifies the type of hypervisor. KVM: KVM XEN: XEN
version	STRING

JSON Sample

{
  "type": "PREFER_KVM",
  "version": "STRING"
}

XML Sample

<vnfr:hypervisor-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>PREFER_KVM</vnfr:type>
  <vnfr:version>STRING</vnfr:version>
</vnfr:hypervisor-epa>

vnfr:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "cpu-model": "PREFER_WESTMERE",
  "cpu-arch": "PREFER_X86",
  "cpu-vendor": "PREFER_INTEL",
  "cpu-socket-count": 0,
  "cpu-core-count": 0,
  "cpu-core-thread-count": 0,
  "cpu-feature": [
    {
      "feature": "PREFER_AES"
    }, {
      ...
    }
  ],
  "om-cpu-model-string": "STRING",
  "om-cpu-feature": [
    {
      "feature": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:host-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:cpu-model>PREFER_WESTMERE</vnfr:cpu-model>
  <vnfr:cpu-arch>PREFER_X86</vnfr:cpu-arch>
  <vnfr:cpu-vendor>PREFER_INTEL</vnfr:cpu-vendor>
  <vnfr:cpu-socket-count>0</vnfr:cpu-socket-count>
  <vnfr:cpu-core-count>0</vnfr:cpu-core-count>
  <vnfr:cpu-core-thread-count>0</vnfr:cpu-core-thread-count>
  <vnfr:cpu-feature>
    <vnfr:feature>PREFER_AES</vnfr:feature>
  </vnfr:cpu-feature>
  <vnfr:om-cpu-model-string>STRING</vnfr:om-cpu-model-string>
  <vnfr:om-cpu-feature>
    <vnfr:feature>STRING</vnfr:feature>
  </vnfr:om-cpu-feature>
</vnfr:host-epa>

vnfr:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa/vnfr:cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa/vnfr:cpu-feature[vnfr:feature='PREFER_AES']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

[
  {
    "feature": "PREFER_AES"
  }, {
    ...
  }
]

XML Sample

<vnfr:cpu-feature xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:feature>PREFER_AES</vnfr:feature>
</vnfr:cpu-feature>

vnfr:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa/vnfr:om-cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa/vnfr:om-cpu-feature[vnfr:feature='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

[
  {
    "feature": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:om-cpu-feature xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:feature>STRING</vnfr:feature>
</vnfr:om-cpu-feature>

vnfr:supplemental-boot-data

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:supplemental-boot-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:supplemental-boot-data

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false
}

XML Sample

<vnfr:supplemental-boot-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:config-file>
    <vnfr:source>STRING</vnfr:source>
    <vnfr:dest>STRING</vnfr:dest>
  </vnfr:config-file>
  <vnfr:boot-data-drive>false</vnfr:boot-data-drive>
</vnfr:supplemental-boot-data>

vnfr:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:supplemental-boot-data/vnfr:config-file

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:supplemental-boot-data/vnfr:config-file[vnfr:source='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "source": "STRING",
    "dest": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:config-file xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:source>STRING</vnfr:source>
  <vnfr:dest>STRING</vnfr:dest>
</vnfr:config-file>

vnfr:vdu-configuration

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING",
    "proxy": true,
    "vca-relationships": { ... }
  },
  "config-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "parameter": [ { ... }, { ... } ],
      "user-defined-script": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vdu-configuration xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script>
    <vnfr:script-type>rift</vnfr:script-type>
  </vnfr:script>
  <vnfr:juju>
    <vnfr:charm>STRING</vnfr:charm>
    <vnfr:proxy>true</vnfr:proxy>
    <vnfr:vca-relationships>...</vnfr:vca-relationships>
  </vnfr:juju>
  <vnfr:config-primitive>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
  </vnfr:config-primitive>
  <vnfr:initial-config-primitive>
    <vnfr:seq>0</vnfr:seq>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
  </vnfr:initial-config-primitive>
</vnfr:vdu-configuration>

vnfr:script

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration/vnfr:script

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:script

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/vdu-configuration/script

Fields

Name	Type	Description
script-type	ENUM	Script type - currently supported - Scripts confirming to Rift CA plugin

JSON Sample

{
  "script-type": "rift"
}

XML Sample

<vnfr:script xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script-type>rift</vnfr:script-type>
</vnfr:script>

vnfr:juju

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration/vnfr:juju

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:juju

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

{
  "charm": "STRING",
  "proxy": true,
  "vca-relationships": {
    "relation": [ { ... }, { ... } ]
  }
}

XML Sample

<vnfr:juju xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:charm>STRING</vnfr:charm>
  <vnfr:proxy>true</vnfr:proxy>
  <vnfr:vca-relationships>
    <vnfr:relation>...</vnfr:relation>
  </vnfr:vca-relationships>
</vnfr:juju>

vnfr:vca-relationships

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration/vnfr:juju/vnfr:vca-relationships

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:juju/vnfr:vca-relationships

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/vdu-configuration/juju/vca-relationships

Fields

Name	Type	Description
relation	LIST	List of relations between VCA componets.

JSON Sample

{
  "relation": [
    {
      "requires": "STRING",
      "provides": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vca-relationships xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:relation>
    <vnfr:requires>STRING</vnfr:requires>
    <vnfr:provides>STRING</vnfr:provides>
  </vnfr:relation>
</vnfr:vca-relationships>

vnfr:relation

List of relations between VCA componets.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration/vnfr:juju/vnfr:vca-relationships/vnfr:relation

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:juju/vnfr:vca-relationships/vnfr:relation[vnfr:requires='STRING'][vnfr:provides='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "requires": "STRING",
    "provides": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:relation xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:requires>STRING</vnfr:requires>
  <vnfr:provides>STRING</vnfr:provides>
</vnfr:relation>

vnfr:config-primitive

List of config primitives supported by the configuration agent for this VNF or VDU.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration/vnfr:config-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:config-primitive[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:config-primitive xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:parameter>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:data-type>STRING</vnfr:data-type>
    <vnfr:mandatory>false</vnfr:mandatory>
    <vnfr:default-value>STRING</vnfr:default-value>
    <vnfr:parameter-pool>STRING</vnfr:parameter-pool>
    <vnfr:read-only>false</vnfr:read-only>
    <vnfr:hidden>false</vnfr:hidden>
  </vnfr:parameter>
  <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
</vnfr:config-primitive>

vnfr:parameter

List of parameters to the config primitive.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration/vnfr:config-primitive/vnfr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:config-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Sample

<vnfr:parameter xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:data-type>STRING</vnfr:data-type>
  <vnfr:mandatory>false</vnfr:mandatory>
  <vnfr:default-value>STRING</vnfr:default-value>
  <vnfr:parameter-pool>STRING</vnfr:parameter-pool>
  <vnfr:read-only>false</vnfr:read-only>
  <vnfr:hidden>false</vnfr:hidden>
</vnfr:parameter>

vnfr:initial-config-primitive

Initial set of configuration primitives.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration/vnfr:initial-config-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:initial-config-primitive[vnfr:seq='0']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:initial-config-primitive xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:seq>0</vnfr:seq>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:parameter>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:value>STRING</vnfr:value>
  </vnfr:parameter>
  <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
</vnfr:initial-config-primitive>

vnfr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vdu-configuration/vnfr:initial-config-primitive/vnfr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vdu-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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 Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:parameter xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:value>STRING</vnfr:value>
</vnfr:parameter>

vnfr:volumes

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:volumes

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:volumes[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/volumes/STRING

Fields

Name	Type	Description
name	STRING	Name of the disk-volumes, e.g. vda, vdb etc
volume-id	STRING	VIM assigned volume id
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 Sample

[
  {
    "name": "STRING",
    "volume-id": "STRING",
    "description": "STRING",
    "size": 0,
    "ephemeral": [null],
    "image": "STRING",
    "image-checksum": "STRING",
    "device-bus": "ide",
    "device-type": "disk"
  }, {
    ...
  }
]

XML Sample

<vnfr:volumes xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:volume-id>STRING</vnfr:volume-id>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:size>0</vnfr:size>
  <vnfr:ephemeral/>
  <vnfr:image>STRING</vnfr:image>
  <vnfr:image-checksum>STRING</vnfr:image-checksum>
  <vnfr:device-bus>ide</vnfr:device-bus>
  <vnfr:device-type>disk</vnfr:device-type>
</vnfr:volumes>

vnfr: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 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/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-connection-point

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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
ip-address	UNION	IP address assigned to the internal connection point
mac-address	STRING	MAC address assigned to the internal connection point
connection-point-id	STRING
virtual-cps	LIST

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING",
    "connection-point-id": "STRING",
    "virtual-cps": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING",
        "connection-point-id": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:mac-address>STRING</vnfr:mac-address>
  <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
  <vnfr:virtual-cps>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:mac-address>STRING</vnfr:mac-address>
    <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
  </vnfr:virtual-cps>
</vnfr:internal-connection-point>

vnfr:virtual-cps

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-connection-point/vnfr:virtual-cps

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING']/vnfr:virtual-cps[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/internal-connection-point/STRING/virtual-cps/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
ip-address	UNION	IP address assigned to the virtual connection point
mac-address	STRING	MAC address assigned to the virtual connection point
connection-point-id	STRING	VIM identifier for connection point

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING",
    "connection-point-id": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:virtual-cps xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:id>STRING</vnfr:id>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:mac-address>STRING</vnfr:mac-address>
  <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
</vnfr:virtual-cps>

vnfr:interface

List of interfaces (internal and external) for the VNF

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:interface

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:interface[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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
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 Sample

[
  {
    "name": "STRING",
    "position": 0,
    "type": "EXTERNAL",
    "internal-connection-point-ref": "STRING",
    "external-connection-point-ref": "STRING",
    "virtual-interface": {
      "type": "VIRTIO",
      "bandwidth": 0,
      "ovs-offload": "MANDATORY",
      "vendor-id": "STRING",
      "datapath-library": "STRING",
      "provider-network-name": "STRING"
    }
  }, {
    ...
  }
]

XML Sample

<vnfr:interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:position>0</vnfr:position>
  <vnfr:type>EXTERNAL</vnfr:type>
  <vnfr:internal-connection-point-ref>STRING</vnfr:internal-connection-point-ref>
  <vnfr:external-connection-point-ref>STRING</vnfr:external-connection-point-ref>
  <vnfr:virtual-interface>
    <vnfr:type>VIRTIO</vnfr:type>
    <vnfr:bandwidth>0</vnfr:bandwidth>
    <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
    <vnfr:vendor-id>STRING</vnfr:vendor-id>
    <vnfr:datapath-library>STRING</vnfr:datapath-library>
    <vnfr:provider-network-name>STRING</vnfr:provider-network-name>
  </vnfr:virtual-interface>
</vnfr:interface>

vnfr:virtual-interface

Container for the virtual interface properties

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:interface/vnfr:virtual-interface

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:interface[vnfr:name='STRING']/vnfr:virtual-interface

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/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.
bandwidth	UINT64	Aggregate bandwidth of the NIC.
ovs-offload	ENUM	Defines if the NIC supports OVS offload. MANDATORY : OVS offload support in the NIC is mandatory. PREFERRED : OVS offload support in the NIC is preferred.
vendor-id	STRING	Specifies the vendor specific id for the device. This is used when a NIC from specific HW vendor is required.
datapath-library	STRING	Specifies the name and version of the datapath library the NIC is expected to support.
provider-network-name	STRING	Name of the provider network to which this NIC is attached.

JSON Sample

{
  "type": "VIRTIO",
  "bandwidth": 0,
  "ovs-offload": "MANDATORY",
  "vendor-id": "STRING",
  "datapath-library": "STRING",
  "provider-network-name": "STRING"
}

XML Sample

<vnfr:virtual-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>VIRTIO</vnfr:type>
  <vnfr:bandwidth>0</vnfr:bandwidth>
  <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
  <vnfr:vendor-id>STRING</vnfr:vendor-id>
  <vnfr:datapath-library>STRING</vnfr:datapath-library>
  <vnfr:provider-network-name>STRING</vnfr:provider-network-name>
</vnfr:virtual-interface>

vnfr:placement-groups-info

Placement groups to which this VDU belongs and its cloud construct

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/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.
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Sample

<vnfr:placement-groups-info xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:requirement>STRING</vnfr:requirement>
  <vnfr:strategy>COLOCATION</vnfr:strategy>
  <vnfr:cloud-type>aws</vnfr:cloud-type>
  <vnfr:availability-zone>
    <vnfr:name>STRING</vnfr:name>
  </vnfr:availability-zone>
  <vnfr:server-group>
    <vnfr:name>STRING</vnfr:name>
  </vnfr:server-group>
  <vnfr:host-aggregate>
    <vnfr:metadata-key>STRING</vnfr:metadata-key>
    <vnfr:metadata-value>STRING</vnfr:metadata-value>
  </vnfr:host-aggregate>
  <vnfr:aws-construct/>
  <vnfr:openmano-construct/>
  <vnfr:vsphere-construct/>
  <vnfr:mock-construct/>
  <vnfr:cloudsim-construct/>
</vnfr:placement-groups-info>

vnfr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:availability-zone

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:availability-zone

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

<vnfr:availability-zone xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
</vnfr:availability-zone>

vnfr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:server-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:server-group

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

<vnfr:server-group xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
</vnfr:server-group>

vnfr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:host-aggregate

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:host-aggregate[vnfr:metadata-key='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:host-aggregate xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:metadata-key>STRING</vnfr:metadata-key>
  <vnfr:metadata-value>STRING</vnfr:metadata-value>
</vnfr:host-aggregate>

vnfr:http-endpoint

List of http endpoints to be used by monitoring params

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:http-endpoint

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:http-endpoint[vnfr:path='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

[
  {
    "path": "STRING",
    "https": false,
    "port": 0,
    "username": "STRING",
    "password": "STRING",
    "polling-interval-secs": 2,
    "method": "GET",
    "headers": [
      {
        "key": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:http-endpoint xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:path>STRING</vnfr:path>
  <vnfr:https>false</vnfr:https>
  <vnfr:port>0</vnfr:port>
  <vnfr:username>STRING</vnfr:username>
  <vnfr:password>STRING</vnfr:password>
  <vnfr:polling-interval-secs>2</vnfr:polling-interval-secs>
  <vnfr:method>GET</vnfr:method>
  <vnfr:headers>
    <vnfr:key>STRING</vnfr:key>
    <vnfr:value>STRING</vnfr:value>
  </vnfr:headers>
</vnfr:http-endpoint>

vnfr:headers

Custom HTTP headers to put on HTTP request

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:http-endpoint/vnfr:headers

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:http-endpoint[vnfr:path='STRING']/vnfr:headers[vnfr:key='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/http-endpoint/STRING/headers/STRING

Fields

Name	Type	Description
key	STRING	HTTP header key
value	STRING	HTTP header value

JSON Sample

[
  {
    "key": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:headers xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:key>STRING</vnfr:key>
  <vnfr:value>STRING</vnfr:value>
</vnfr:headers>

vnfr:monitoring-param

List of monitoring parameters at the network service level

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "http-endpoint-ref": "STRING",
    "json-query-method": "NAMEKEY",
    "json-query-params": {
      "json-path": "STRING",
      "object-path": "STRING"
    },
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:monitoring-param xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:http-endpoint-ref>STRING</vnfr:http-endpoint-ref>
  <vnfr:json-query-method>NAMEKEY</vnfr:json-query-method>
  <vnfr:json-query-params>
    <vnfr:json-path>STRING</vnfr:json-path>
    <vnfr:object-path>STRING</vnfr:object-path>
  </vnfr:json-query-params>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:group-tag>STRING</vnfr:group-tag>
  <vnfr:widget-type>COUNTER</vnfr:widget-type>
  <vnfr:units>STRING</vnfr:units>
  <vnfr:value-type>INT</vnfr:value-type>
  <vnfr:numeric-constraints>
    <vnfr:min-value>0</vnfr:min-value>
    <vnfr:max-value>0</vnfr:max-value>
  </vnfr:numeric-constraints>
  <vnfr:text-constraints>
    <vnfr:min-length>0</vnfr:min-length>
    <vnfr:max-length>0</vnfr:max-length>
  </vnfr:text-constraints>
  <vnfr:value-integer>0</vnfr:value-integer>
  <vnfr:value-decimal>0.0</vnfr:value-decimal>
  <vnfr:value-string>STRING</vnfr:value-string>
</vnfr:monitoring-param>

vnfr:json-query-params

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:json-query-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:json-query-params

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

{
  "json-path": "STRING",
  "object-path": "STRING"
}

XML Sample

<vnfr:json-query-params xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:json-path>STRING</vnfr:json-path>
  <vnfr:object-path>STRING</vnfr:object-path>
</vnfr:json-query-params>

vnfr:numeric-constraints

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:numeric-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:numeric-constraints

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

{
  "min-value": 0,
  "max-value": 0
}

XML Sample

<vnfr:numeric-constraints xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:min-value>0</vnfr:min-value>
  <vnfr:max-value>0</vnfr:max-value>
</vnfr:numeric-constraints>

vnfr:text-constraints

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:text-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:text-constraints

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/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 Sample

{
  "min-length": 0,
  "max-length": 0
}

XML Sample

<vnfr:text-constraints xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:min-length>0</vnfr:min-length>
  <vnfr:max-length>0</vnfr:max-length>
</vnfr:text-constraints>

vnfr:placement-groups-info

Placement groups to which this VDU belongs and its cloud construct

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/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.
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Sample

<vnfr:placement-groups-info xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:requirement>STRING</vnfr:requirement>
  <vnfr:strategy>COLOCATION</vnfr:strategy>
  <vnfr:cloud-type>aws</vnfr:cloud-type>
  <vnfr:availability-zone>
    <vnfr:name>STRING</vnfr:name>
  </vnfr:availability-zone>
  <vnfr:server-group>
    <vnfr:name>STRING</vnfr:name>
  </vnfr:server-group>
  <vnfr:host-aggregate>
    <vnfr:metadata-key>STRING</vnfr:metadata-key>
    <vnfr:metadata-value>STRING</vnfr:metadata-value>
  </vnfr:host-aggregate>
  <vnfr:aws-construct/>
  <vnfr:openmano-construct/>
  <vnfr:vsphere-construct/>
  <vnfr:mock-construct/>
  <vnfr:cloudsim-construct/>
</vnfr:placement-groups-info>

vnfr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:availability-zone

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:availability-zone

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

<vnfr:availability-zone xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
</vnfr:availability-zone>

vnfr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:server-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:server-group

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

<vnfr:server-group xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
</vnfr:server-group>

vnfr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:host-aggregate

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:host-aggregate[vnfr:metadata-key='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:host-aggregate xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:metadata-key>STRING</vnfr:metadata-key>
  <vnfr:metadata-value>STRING</vnfr:metadata-value>
</vnfr:host-aggregate>

vnfr:cloud-config

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:cloud-config

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:cloud-config

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/cloud-config

Fields

Name	Type	Description
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation
user	LIST	List of users to be added through cloud-config

JSON Sample

{
  "key-pair": [
    {
      "name": "STRING",
      "key": "STRING"
    }, {
      ...
    }
  ],
  "user": [
    {
      "name": "STRING",
      "user-info": "STRING",
      "key-pair": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:cloud-config xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:key-pair>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:key>STRING</vnfr:key>
  </vnfr:key-pair>
  <vnfr:user>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:user-info>STRING</vnfr:user-info>
    <vnfr:key-pair>...</vnfr:key-pair>
  </vnfr:user>
</vnfr:cloud-config>

vnfr:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:cloud-config/vnfr:key-pair

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:cloud-config/vnfr:key-pair[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/cloud-config/key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:key-pair xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:key>STRING</vnfr:key>
</vnfr:key-pair>

vnfr:user

List of users to be added through cloud-config

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:cloud-config/vnfr:user

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:cloud-config/vnfr:user[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/cloud-config/user/STRING

Fields

Name	Type	Description
name	STRING	Name of the user
user-info	STRING	The user name's real name
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation

JSON Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:user xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:user-info>STRING</vnfr:user-info>
  <vnfr:key-pair>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:key>STRING</vnfr:key>
  </vnfr:key-pair>
</vnfr:user>

vnfr:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/rw-project:project/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:cloud-config/vnfr:user/vnfr:key-pair

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:cloud-config/vnfr:user[vnfr:name='STRING']/vnfr:key-pair[vnfr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vnfr:vnfr-catalog/vnfr/STRING/cloud-config/user/STRING/key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:key-pair xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:key>STRING</vnfr:key>
</vnfr:key-pair>

nsr:ns-instance-opdata

Key Identifiers:

XPath Path	/rw-project:project/nsr:ns-instance-opdata
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata
RW.REST URI Path	/rw-project:project/STRING/nsr:ns-instance-opdata

Fields

Name	Type	Description
nsr	LIST

JSON Sample

{
  "nsr": [
    {
      "ns-instance-config-ref": "STRING",
      "name-ref": "STRING",
      "nsd-ref": "STRING",
      "nsd-name-ref": "STRING",
      "create-time": 0,
      "uptime": 0,
      "connection-point": [ { ... }, { ... } ],
      "vlr": [ { ... }, { ... } ],
      "constituent-vnfr-ref": [ { ... }, { ... } ],
      "scaling-group-record": [ { ... }, { ... } ],
      "vnffgr": [ { ... }, { ... } ],
      "operational-status": "init",
      "config-status": "init",
      "service-primitive": [ { ... }, { ... } ],
      "initial-service-primitive": [ { ... }, { ... } ],
      "terminate-service-primitive": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "config-agent-job": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<nsr:ns-instance-opdata xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr>
    <nsr:ns-instance-config-ref>STRING</nsr:ns-instance-config-ref>
    <nsr:name-ref>STRING</nsr:name-ref>
    <nsr:nsd-ref>STRING</nsr:nsd-ref>
    <nsr:nsd-name-ref>STRING</nsr:nsd-name-ref>
    <nsr:create-time>0</nsr:create-time>
    <nsr:uptime>0</nsr:uptime>
    <nsr:connection-point>...</nsr:connection-point>
    <nsr:vlr>...</nsr:vlr>
    <nsr:constituent-vnfr-ref>...</nsr:constituent-vnfr-ref>
    <nsr:scaling-group-record>...</nsr:scaling-group-record>
    <nsr:vnffgr>...</nsr:vnffgr>
    <nsr:operational-status>init</nsr:operational-status>
    <nsr:config-status>init</nsr:config-status>
    <nsr:service-primitive>...</nsr:service-primitive>
    <nsr:initial-service-primitive>...</nsr:initial-service-primitive>
    <nsr:terminate-service-primitive>...</nsr:terminate-service-primitive>
    <nsr:monitoring-param>...</nsr:monitoring-param>
    <nsr:config-agent-job>...</nsr:config-agent-job>
  </nsr:nsr>
</nsr:ns-instance-opdata>

nsr:nsr

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING

Fields

Name	Type	Description
ns-instance-config-ref	LEAFREF
name-ref	LEAFREF	Network service name reference
nsd-ref	LEAFREF	Network service descriptor id reference
nsd-name-ref	LEAFREF	Network service descriptor name reference
create-time	UINT32	Creation timestamp of this Network Service. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
uptime	UINT32	Active period of this Network Service. Uptime is expressed in seconds
connection-point	LIST	List for external connection points. Each NS has one or more external connection points. As the name implies that external connection points are used for connecting the NS to other NS or to external networks. Each NS exposes these connection points to the orchestrator. The orchestrator can construct network service chains by connecting the connection points between different NS.
vlr	LIST
constituent-vnfr-ref	LIST	List of VNFRs that are part of this network service.
scaling-group-record	LIST	List of scaling group records
vnffgr	LIST
operational-status	ENUM	The operational status of the NS instance init : The network service has just started. vl-init-phase : The VLs in the NS are being instantiated. vnf-init-phase : The VNFs in the NS are being instantiated. running : The NS is in running state. terminate : The NS is being terminated. vnf-terminate-phase : The NS is terminating the VNFs in the NS. vl-terminate-phase : The NS is terminating the VLs in the NS. terminated : The NS is in the terminated state. failed : The NS instantiation failed. scaling-out : The NS is scaling out scaling-in : The NS is scaling in vl-instantiate : The NS is initiating a new VL vl-terminate : The NS is terminating a VL
config-status	ENUM	The configuration status of the NS instance configuring: At least one of the VNFs in this instance is in configuring state configured: All the VNFs in this NS instance are configured or config-not-needed state
service-primitive	LIST	Network service level service primitives.
initial-service-primitive	LIST	Initial set of service primitives for NSD.
terminate-service-primitive	LIST	Set of service primitives to execute during termination of NSD.
monitoring-param	LIST	List of NS level params.
config-agent-job	LIST

JSON Sample

[
  {
    "ns-instance-config-ref": "STRING",
    "name-ref": "STRING",
    "nsd-ref": "STRING",
    "nsd-name-ref": "STRING",
    "create-time": 0,
    "uptime": 0,
    "connection-point": [
      {
        "name": "STRING",
        "type": "VPORT"
      }, {
        ...
      }
    ],
    "vlr": [
      {
        "vlr-ref": "STRING",
        "vnfr-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "constituent-vnfr-ref": [
      {
        "vnfr-id": "STRING"
      }, {
        ...
      }
    ],
    "scaling-group-record": [
      {
        "scaling-group-name-ref": "STRING",
        "instance": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnffgr": [
      {
        "id": "STRING",
        "vnffgd-id-ref": "STRING",
        "vnffgd-name-ref": "STRING",
        "sdn-account": "STRING",
        "cloud-account": "STRING",
        "operational-status": "init",
        "rsp": [ { ... }, { ... } ],
        "classifier": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "operational-status": "init",
    "config-status": "init",
    "service-primitive": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "parameter-group": [ { ... }, { ... } ],
        "vnf-primitive-group": [ { ... }, { ... } ],
        "user-defined-script": "STRING"
      }, {
        ...
      }
    ],
    "initial-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "terminate-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING",
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "COUNTER",
        "units": "STRING",
        "aggregation-type": "AVERAGE",
        "id": "STRING",
        "name": "STRING",
        "nsd-mon-param-ref": "STRING",
        "vnfr-mon-param-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "config-agent-job": [
      {
        "job-id": 0,
        "job-name": "STRING",
        "job-status": "pending",
        "triggered-by": "ns-primitive",
        "create-time": 0,
        "job-status-details": "STRING",
        "parameter": [ { ... }, { ... } ],
        "parameter-group": [ { ... }, { ... } ],
        "vnfr": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:nsr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:ns-instance-config-ref>STRING</nsr:ns-instance-config-ref>
  <nsr:name-ref>STRING</nsr:name-ref>
  <nsr:nsd-ref>STRING</nsr:nsd-ref>
  <nsr:nsd-name-ref>STRING</nsr:nsd-name-ref>
  <nsr:create-time>0</nsr:create-time>
  <nsr:uptime>0</nsr:uptime>
  <nsr:connection-point>
    <nsr:name>STRING</nsr:name>
    <nsr:type>VPORT</nsr:type>
  </nsr:connection-point>
  <nsr:vlr>
    <nsr:vlr-ref>STRING</nsr:vlr-ref>
    <nsr:vnfr-connection-point-ref>...</nsr:vnfr-connection-point-ref>
  </nsr:vlr>
  <nsr:constituent-vnfr-ref>
    <nsr:vnfr-id>STRING</nsr:vnfr-id>
  </nsr:constituent-vnfr-ref>
  <nsr:scaling-group-record>
    <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
    <nsr:instance>...</nsr:instance>
  </nsr:scaling-group-record>
  <nsr:vnffgr>
    <nsr:id>STRING</nsr:id>
    <nsr:vnffgd-id-ref>STRING</nsr:vnffgd-id-ref>
    <nsr:vnffgd-name-ref>STRING</nsr:vnffgd-name-ref>
    <nsr:sdn-account>STRING</nsr:sdn-account>
    <nsr:cloud-account>STRING</nsr:cloud-account>
    <nsr:operational-status>init</nsr:operational-status>
    <nsr:rsp>...</nsr:rsp>
    <nsr:classifier>...</nsr:classifier>
  </nsr:vnffgr>
  <nsr:operational-status>init</nsr:operational-status>
  <nsr:config-status>init</nsr:config-status>
  <nsr:service-primitive>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:parameter-group>...</nsr:parameter-group>
    <nsr:vnf-primitive-group>...</nsr:vnf-primitive-group>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
  </nsr:service-primitive>
  <nsr:initial-service-primitive>
    <nsr:seq>0</nsr:seq>
    <nsr:name>STRING</nsr:name>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
    <nsr:parameter>...</nsr:parameter>
  </nsr:initial-service-primitive>
  <nsr:terminate-service-primitive>
    <nsr:seq>0</nsr:seq>
    <nsr:name>STRING</nsr:name>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
    <nsr:parameter>...</nsr:parameter>
  </nsr:terminate-service-primitive>
  <nsr:monitoring-param>
    <nsr:id>STRING</nsr:id>
    <nsr:value-type>INT</nsr:value-type>
    <nsr:numeric-constraints>...</nsr:numeric-constraints>
    <nsr:text-constraints>...</nsr:text-constraints>
    <nsr:value-integer>0</nsr:value-integer>
    <nsr:value-decimal>0.0</nsr:value-decimal>
    <nsr:value-string>STRING</nsr:value-string>
    <nsr:description>STRING</nsr:description>
    <nsr:group-tag>STRING</nsr:group-tag>
    <nsr:widget-type>COUNTER</nsr:widget-type>
    <nsr:units>STRING</nsr:units>
    <nsr:aggregation-type>AVERAGE</nsr:aggregation-type>
    <nsr:name>STRING</nsr:name>
    <nsr:nsd-mon-param-ref>STRING</nsr:nsd-mon-param-ref>
    <nsr:vnfr-mon-param-ref>...</nsr:vnfr-mon-param-ref>
  </nsr:monitoring-param>
  <nsr:config-agent-job>
    <nsr:job-id>0</nsr:job-id>
    <nsr:job-name>STRING</nsr:job-name>
    <nsr:job-status>pending</nsr:job-status>
    <nsr:triggered-by>ns-primitive</nsr:triggered-by>
    <nsr:create-time>0</nsr:create-time>
    <nsr:job-status-details>STRING</nsr:job-status-details>
    <nsr:parameter>...</nsr:parameter>
    <nsr:parameter-group>...</nsr:parameter-group>
    <nsr:vnfr>...</nsr:vnfr>
  </nsr:config-agent-job>
</nsr:nsr>

nsr:connection-point

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:connection-point

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:connection-point[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/connection-point/STRING

Fields

Name	Type	Description
name	STRING	Name of the NS connection point.
type	ENUM	Type of the connection point.

JSON Sample

[
  {
    "name": "STRING",
    "type": "VPORT"
  }, {
    ...
  }
]

XML Sample

<nsr:connection-point xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:type>VPORT</nsr:type>
</nsr:connection-point>

nsr:vlr

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vlr

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vlr[nsr:vlr-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vlr/STRING

Fields

Name	Type	Description
vlr-ref	LEAFREF	Reference to a VLR record in the VLR catalog
vnfr-connection-point-ref	LIST	A list of references to connection points.

JSON Sample

[
  {
    "vlr-ref": "STRING",
    "vnfr-connection-point-ref": [
      {
        "vnfr-id": "STRING",
        "connection-point": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:vlr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vlr-ref>STRING</nsr:vlr-ref>
  <nsr:vnfr-connection-point-ref>
    <nsr:vnfr-id>STRING</nsr:vnfr-id>
    <nsr:connection-point>STRING</nsr:connection-point>
  </nsr:vnfr-connection-point-ref>
</nsr:vlr>

nsr:vnfr-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vlr/nsr:vnfr-connection-point-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vlr[nsr:vlr-ref='STRING']/nsr:vnfr-connection-point-ref[nsr:vnfr-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vlr/STRING/vnfr-connection-point-ref/STRING

Fields

Name	Type	Description
vnfr-id	LEAFREF	A reference to a vnfr
connection-point	LEAFREF	A reference to a connection point name in a vnfr

JSON Sample

[
  {
    "vnfr-id": "STRING",
    "connection-point": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:vnfr-connection-point-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfr-id>STRING</nsr:vnfr-id>
  <nsr:connection-point>STRING</nsr:connection-point>
</nsr:vnfr-connection-point-ref>

nsr:constituent-vnfr-ref

List of VNFRs that are part of this network service.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:constituent-vnfr-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:constituent-vnfr-ref[nsr:vnfr-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/constituent-vnfr-ref/STRING

Fields

Name	Type	Description
vnfr-id	STRING	Reference to the VNFR id This should be a leafref to /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:id But due to confd bug (RIFT-9451), changing to string.

JSON Sample

[
  {
    "vnfr-id": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:constituent-vnfr-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfr-id>STRING</nsr:vnfr-id>
</nsr:constituent-vnfr-ref>

nsr:scaling-group-record

List of scaling group records

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:scaling-group-record

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:scaling-group-record[nsr:scaling-group-name-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/scaling-group-record/STRING

Fields

Name	Type	Description
scaling-group-name-ref	LEAFREF	name of the scaling group
instance	LIST	Reference to scaling group instance record

JSON Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "instance-id": 0,
        "is-default": true,
        "op-status": "init",
        "config-status": "init",
        "error-msg": "STRING",
        "create-time": 0,
        "vnfrs": [ "STRING", ... ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:scaling-group-record xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:instance-id>0</nsr:instance-id>
    <nsr:is-default>true</nsr:is-default>
    <nsr:op-status>init</nsr:op-status>
    <nsr:config-status>init</nsr:config-status>
    <nsr:error-msg>STRING</nsr:error-msg>
    <nsr:create-time>0</nsr:create-time>
    <nsr:vnfrs>STRING</nsr:vnfrs>
    <nsr:vnfrs>...</nsr:vnfrs>
  </nsr:instance>
</nsr:scaling-group-record>

nsr:instance

Reference to scaling group instance record

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:scaling-group-record/nsr:instance

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:scaling-group-record[nsr:scaling-group-name-ref='STRING']/nsr:instance[nsr:instance-id='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/scaling-group-record/STRING/instance/0

Fields

Name	Type	Description
instance-id	UINT16	Scaling group instance id
is-default	BOOLEAN	Flag indicating whether this instance was part of default scaling group (and thus undeletable)
op-status	ENUM	The operational status of the NS instance init : The scaling group has just started. vnf-init-phase : The VNFs in the scaling group are being instantiated. running : The scaling group is in running state. terminate : The scaling group is being terminated. vnf-terminate-phase : The VNFs in the scaling group are being terminated. terminated : The scaling group is in the terminated state. failed : The scaling group instantiation failed.
config-status	ENUM	The configuration status of the scaling group instance configuring : At least one of the VNFs in this scaling group instance is in configuring state configured : All the VNFs in this scaling group instance are configured or config-not-needed state failed : Configuring this scaling group instance failed
error-msg	STRING	Reason for failure in configuration of this scaling instance
create-time	UINT32	Creation timestamp of this scaling group record. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
vnfrs	LEAF_LIST	Reference to VNFR within the scale instance

JSON Sample

[
  {
    "instance-id": 0,
    "is-default": true,
    "op-status": "init",
    "config-status": "init",
    "error-msg": "STRING",
    "create-time": 0,
    "vnfrs": [ "STRING", ... ]
  }, {
    ...
  }
]

XML Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:instance-id>0</nsr:instance-id>
  <nsr:is-default>true</nsr:is-default>
  <nsr:op-status>init</nsr:op-status>
  <nsr:config-status>init</nsr:config-status>
  <nsr:error-msg>STRING</nsr:error-msg>
  <nsr:create-time>0</nsr:create-time>
  <nsr:vnfrs>STRING</nsr:vnfrs>
  <nsr:vnfrs>...</nsr:vnfrs>
</nsr:instance>

nsr:vnfrs

Reference to VNFR within the scale instance

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:scaling-group-record/nsr:instance/nsr:vnfrs

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:scaling-group-record[nsr:scaling-group-name-ref='STRING']/nsr:instance[nsr:instance-id='0']/nsr:vnfrs

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/scaling-group-record/STRING/instance/0/vnfrs

JSON Sample

[ "STRING", ... ]

XML Sample

<nsr:vnfrs xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">STRING</nsr:vnfrs>
<nsr:vnfrs xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">...</nsr:vnfrs>

nsr:vnffgr

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VNFFGR.
vnffgd-id-ref	LEAFREF	VNFFG descriptor id reference
vnffgd-name-ref	LEAFREF	VNFFG descriptor name reference
sdn-account	STRING	The SDN account to use when requesting resources for this vnffgr
cloud-account	STRING	Cloud Account in which NSR is instantiated
operational-status	ENUM	The operational status of the VNFFGR instance init : The VNFFGR has just started. running : The VNFFGR is in running state. terminate : The VNFFGR is being terminated. terminated : The VNFFGR is in the terminated state. failed : The VNFFGR instantiation failed
rsp	LIST
classifier	LIST

JSON Sample

[
  {
    "id": "STRING",
    "vnffgd-id-ref": "STRING",
    "vnffgd-name-ref": "STRING",
    "sdn-account": "STRING",
    "cloud-account": "STRING",
    "operational-status": "init",
    "rsp": [
      {
        "id": "STRING",
        "name": "STRING",
        "rsp-id": "STRING",
        "vnffgd-rsp-id-ref": "STRING",
        "vnffgd-rsp-name-ref": "STRING",
        "classifier-name": "STRING",
        "path-id": 0,
        "vnfr-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier": [
      {
        "id": "STRING",
        "name": "STRING",
        "classifier-id": [ "STRING", ... ],
        "rsp-id-ref": "STRING",
        "rsp-name": "STRING",
        "vnfr-id-ref": "STRING",
        "vnfr-name-ref": "STRING",
        "vnfr-connection-point-ref": "STRING",
        "port-id": "STRING",
        "vm-id": "STRING",
        "ip-address": "STRING",
        "sff-name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:vnffgr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:vnffgd-id-ref>STRING</nsr:vnffgd-id-ref>
  <nsr:vnffgd-name-ref>STRING</nsr:vnffgd-name-ref>
  <nsr:sdn-account>STRING</nsr:sdn-account>
  <nsr:cloud-account>STRING</nsr:cloud-account>
  <nsr:operational-status>init</nsr:operational-status>
  <nsr:rsp>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:rsp-id>STRING</nsr:rsp-id>
    <nsr:vnffgd-rsp-id-ref>STRING</nsr:vnffgd-rsp-id-ref>
    <nsr:vnffgd-rsp-name-ref>STRING</nsr:vnffgd-rsp-name-ref>
    <nsr:classifier-name>STRING</nsr:classifier-name>
    <nsr:path-id>0</nsr:path-id>
    <nsr:vnfr-connection-point-ref>...</nsr:vnfr-connection-point-ref>
  </nsr:rsp>
  <nsr:classifier>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:classifier-id>STRING</nsr:classifier-id>
    <nsr:classifier-id>...</nsr:classifier-id>
    <nsr:rsp-id-ref>STRING</nsr:rsp-id-ref>
    <nsr:rsp-name>STRING</nsr:rsp-name>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnfr-name-ref>STRING</nsr:vnfr-name-ref>
    <nsr:vnfr-connection-point-ref>STRING</nsr:vnfr-connection-point-ref>
    <nsr:port-id>STRING</nsr:port-id>
    <nsr:vm-id>STRING</nsr:vm-id>
    <nsr:ip-address>STRING</nsr:ip-address>
    <nsr:sff-name>STRING</nsr:sff-name>
  </nsr:classifier>
</nsr:vnffgr>

nsr:rsp

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:rsp

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/rsp/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the RSP.
name	STRING	Name for the RSP
rsp-id	STRING	Returned Identifier for the RSP.
vnffgd-rsp-id-ref	LEAFREF	Identifier for the VNFFG Descriptor RSP reference
vnffgd-rsp-name-ref	LEAFREF	Name for the VNFFG Descriptor RSP reference
classifier-name	STRING
path-id	UINT32	Unique Identifier for the service path
vnfr-connection-point-ref	LIST

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "rsp-id": "STRING",
    "vnffgd-rsp-id-ref": "STRING",
    "vnffgd-rsp-name-ref": "STRING",
    "classifier-name": "STRING",
    "path-id": 0,
    "vnfr-connection-point-ref": [
      {
        "hop-number": 0,
        "service-function-type": "STRING",
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfr-id-ref": "STRING",
        "vnfr-name-ref": "STRING",
        "vnfr-connection-point-ref": "STRING",
        "service-index": 0,
        "connection-point-params": { ... },
        "service-function-forwarder": { ... }
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:rsp xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:rsp-id>STRING</nsr:rsp-id>
  <nsr:vnffgd-rsp-id-ref>STRING</nsr:vnffgd-rsp-id-ref>
  <nsr:vnffgd-rsp-name-ref>STRING</nsr:vnffgd-rsp-name-ref>
  <nsr:classifier-name>STRING</nsr:classifier-name>
  <nsr:path-id>0</nsr:path-id>
  <nsr:vnfr-connection-point-ref>
    <nsr:hop-number>0</nsr:hop-number>
    <nsr:service-function-type>STRING</nsr:service-function-type>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnfr-name-ref>STRING</nsr:vnfr-name-ref>
    <nsr:vnfr-connection-point-ref>STRING</nsr:vnfr-connection-point-ref>
    <nsr:service-index>0</nsr:service-index>
    <nsr:connection-point-params>...</nsr:connection-point-params>
    <nsr:service-function-forwarder>...</nsr:service-function-forwarder>
  </nsr:vnfr-connection-point-ref>
</nsr:rsp>

nsr:vnfr-connection-point-ref

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:rsp/nsr:vnfr-connection-point-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']/nsr:vnfr-connection-point-ref[nsr:hop-number='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/rsp/STRING/vnfr-connection-point-ref/0

Fields

Name	Type	Description
hop-number	UINT8	Monotonically increasing number to show service path hop order
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
member-vnf-index-ref	UINT64
vnfd-id-ref	STRING	Reference to VNF Descriptor Id
vnfr-id-ref	LEAFREF	A reference to a vnfr id
vnfr-name-ref	LEAFREF	A reference to a vnfr name
vnfr-connection-point-ref	LEAFREF	A reference to a vnfr connection point.
service-index	UINT8	Location within the service path
connection-point-params	CONTAINER
service-function-forwarder	CONTAINER

JSON Sample

[
  {
    "hop-number": 0,
    "service-function-type": "STRING",
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfr-id-ref": "STRING",
    "vnfr-name-ref": "STRING",
    "vnfr-connection-point-ref": "STRING",
    "service-index": 0,
    "connection-point-params": {
      "mgmt-address": "UNION_VALUE",
      "name": "STRING",
      "port-id": "STRING",
      "vm-id": "STRING",
      "address": "UNION_VALUE",
      "port": 0
    },
    "service-function-forwarder": {
      "name": "STRING",
      "ip-address": "UNION_VALUE",
      "port": 0
    }
  }, {
    ...
  }
]

XML Sample

<nsr:vnfr-connection-point-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:hop-number>0</nsr:hop-number>
  <nsr:service-function-type>STRING</nsr:service-function-type>
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnfr-name-ref>STRING</nsr:vnfr-name-ref>
  <nsr:vnfr-connection-point-ref>STRING</nsr:vnfr-connection-point-ref>
  <nsr:service-index>0</nsr:service-index>
  <nsr:connection-point-params>
    <nsr:mgmt-address>UNION_VALUE</nsr:mgmt-address>
    <nsr:name>STRING</nsr:name>
    <nsr:port-id>STRING</nsr:port-id>
    <nsr:vm-id>STRING</nsr:vm-id>
    <nsr:address>UNION_VALUE</nsr:address>
    <nsr:port>0</nsr:port>
  </nsr:connection-point-params>
  <nsr:service-function-forwarder>
    <nsr:name>STRING</nsr:name>
    <nsr:ip-address>UNION_VALUE</nsr:ip-address>
    <nsr:port>0</nsr:port>
  </nsr:service-function-forwarder>
</nsr:vnfr-connection-point-ref>

nsr:connection-point-params

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:rsp/nsr:vnfr-connection-point-ref/nsr:connection-point-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']/nsr:vnfr-connection-point-ref[nsr:hop-number='0']/nsr:connection-point-params

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/rsp/STRING/vnfr-connection-point-ref/0/connection-point-params

Fields

Name	Type	Description
mgmt-address	UNION
name	STRING
port-id	STRING
vm-id	STRING
address	UNION
port	UINT16

JSON Sample

{
  "mgmt-address": "UNION_VALUE",
  "name": "STRING",
  "port-id": "STRING",
  "vm-id": "STRING",
  "address": "UNION_VALUE",
  "port": 0
}

XML Sample

<nsr:connection-point-params xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:mgmt-address>UNION_VALUE</nsr:mgmt-address>
  <nsr:name>STRING</nsr:name>
  <nsr:port-id>STRING</nsr:port-id>
  <nsr:vm-id>STRING</nsr:vm-id>
  <nsr:address>UNION_VALUE</nsr:address>
  <nsr:port>0</nsr:port>
</nsr:connection-point-params>

nsr:service-function-forwarder

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:rsp/nsr:vnfr-connection-point-ref/nsr:service-function-forwarder

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']/nsr:vnfr-connection-point-ref[nsr:hop-number='0']/nsr:service-function-forwarder

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/rsp/STRING/vnfr-connection-point-ref/0/service-function-forwarder

Fields

Name	Type	Description
name	STRING	Service Function Forwarder name
ip-address	UNION	Data Plane IP Address of the SFF
port	UINT16	Data Plane Port of the SFF

JSON Sample

{
  "name": "STRING",
  "ip-address": "UNION_VALUE",
  "port": 0
}

XML Sample

<nsr:service-function-forwarder xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:ip-address>UNION_VALUE</nsr:ip-address>
  <nsr:port>0</nsr:port>
</nsr:service-function-forwarder>

nsr:classifier

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:classifier

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:classifier[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/classifier/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the classifier rule.
name	STRING	Name of the classifier.
classifier-id	LEAF_LIST	Returned Identifier for the classifier rule.
rsp-id-ref	LEAFREF	A reference to the RSP.
rsp-name	STRING	Name for the RSP
vnfr-id-ref	LEAFREF	A reference to a vnfr id
vnfr-name-ref	LEAFREF	A reference to a vnfr name
vnfr-connection-point-ref	LEAFREF	A reference to a vnfr connection point.
port-id	STRING
vm-id	STRING
ip-address	STRING
sff-name	STRING

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "classifier-id": [ "STRING", ... ],
    "rsp-id-ref": "STRING",
    "rsp-name": "STRING",
    "vnfr-id-ref": "STRING",
    "vnfr-name-ref": "STRING",
    "vnfr-connection-point-ref": "STRING",
    "port-id": "STRING",
    "vm-id": "STRING",
    "ip-address": "STRING",
    "sff-name": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:classifier xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:classifier-id>STRING</nsr:classifier-id>
  <nsr:classifier-id>...</nsr:classifier-id>
  <nsr:rsp-id-ref>STRING</nsr:rsp-id-ref>
  <nsr:rsp-name>STRING</nsr:rsp-name>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnfr-name-ref>STRING</nsr:vnfr-name-ref>
  <nsr:vnfr-connection-point-ref>STRING</nsr:vnfr-connection-point-ref>
  <nsr:port-id>STRING</nsr:port-id>
  <nsr:vm-id>STRING</nsr:vm-id>
  <nsr:ip-address>STRING</nsr:ip-address>
  <nsr:sff-name>STRING</nsr:sff-name>
</nsr:classifier>

nsr:classifier-id

Returned Identifier for the classifier rule.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:classifier/nsr:classifier-id

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:classifier[nsr:id='STRING']/nsr:classifier-id

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/classifier/STRING/classifier-id

JSON Sample

[ "STRING", ... ]

XML Sample

<nsr:classifier-id xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">STRING</nsr:classifier-id>
<nsr:classifier-id xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">...</nsr:classifier-id>

nsr:service-primitive

Network service level service primitives.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/service-primitive/STRING

Fields

Name	Type	Description
name	STRING	Name of the service primitive.
parameter	LIST	List of parameters for the service primitive.
parameter-group	LIST	Grouping of parameters which are logically grouped in UI
vnf-primitive-group	LIST	Reference to member-vnf within constituent-vnfds
user-defined-script	STRING	A user defined script.

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "mandatory": true
      }, {
        ...
      }
    ],
    "vnf-primitive-group": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-name": "STRING",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:data-type>STRING</nsr:data-type>
    <nsr:mandatory>false</nsr:mandatory>
    <nsr:default-value>STRING</nsr:default-value>
    <nsr:parameter-pool>STRING</nsr:parameter-pool>
    <nsr:read-only>false</nsr:read-only>
    <nsr:hidden>false</nsr:hidden>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:mandatory>true</nsr:mandatory>
  </nsr:parameter-group>
  <nsr:vnf-primitive-group>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfd-name>STRING</nsr:vnfd-name>
    <nsr:primitive>...</nsr:primitive>
  </nsr:vnf-primitive-group>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
</nsr:service-primitive>

nsr:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/service-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 Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:data-type>STRING</nsr:data-type>
  <nsr:mandatory>false</nsr:mandatory>
  <nsr:default-value>STRING</nsr:default-value>
  <nsr:parameter-pool>STRING</nsr:parameter-pool>
  <nsr:read-only>false</nsr:read-only>
  <nsr:hidden>false</nsr:hidden>
</nsr:parameter>

nsr:parameter-group

Grouping of parameters which are logically grouped in UI

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:parameter-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:parameter-group[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/service-primitive/STRING/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter group
parameter	LIST	List of parameters for the service primitive.
mandatory	BOOLEAN	Is this parameter group mandatory

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "mandatory": true
  }, {
    ...
  }
]

XML Sample

<nsr:parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:data-type>STRING</nsr:data-type>
    <nsr:mandatory>false</nsr:mandatory>
    <nsr:default-value>STRING</nsr:default-value>
    <nsr:parameter-pool>STRING</nsr:parameter-pool>
    <nsr:read-only>false</nsr:read-only>
    <nsr:hidden>false</nsr:hidden>
  </nsr:parameter>
  <nsr:mandatory>true</nsr:mandatory>
</nsr:parameter-group>

nsr:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/service-primitive/STRING/parameter-group/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 Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:data-type>STRING</nsr:data-type>
  <nsr:mandatory>false</nsr:mandatory>
  <nsr:default-value>STRING</nsr:default-value>
  <nsr:parameter-pool>STRING</nsr:parameter-pool>
  <nsr:read-only>false</nsr:read-only>
  <nsr:hidden>false</nsr:hidden>
</nsr:parameter>

nsr:vnf-primitive-group

Reference to member-vnf within constituent-vnfds

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:vnf-primitive-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/service-primitive/STRING/vnf-primitive-group/0

Fields

Name	Type	Description
member-vnf-index-ref	UINT64	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resovled this will switched to use leafref
vnfd-name	STRING	Name of the VNFD
primitive	LIST

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-name": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:vnf-primitive-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfd-name>STRING</nsr:vnfd-name>
  <nsr:primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
  </nsr:primitive>
</nsr:vnf-primitive-group>

nsr:primitive

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:vnf-primitive-group/nsr:primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']/nsr:primitive[nsr:index='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/service-primitive/STRING/vnf-primitive-group/0/primitive/0

Fields

Name	Type	Description
index	UINT32	Index of this primitive
name	STRING	Name of the primitive in the VNF primitive

JSON Sample

[
  {
    "index": 0,
    "name": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
</nsr:primitive>

nsr:initial-service-primitive

Initial set of service primitives for NSD.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:initial-service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:initial-service-primitive[nsr:seq='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/initial-service-primitive/0

Fields

Name	Type	Description
seq	UINT64	Sequence number for the service primitive.
name	STRING	Name of the service primitive.
user-defined-script	STRING	A user defined script.
parameter	LIST

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:initial-service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:seq>0</nsr:seq>
  <nsr:name>STRING</nsr:name>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:initial-service-primitive>

nsr:parameter

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:initial-service-primitive/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:initial-service-primitive[nsr:seq='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/initial-service-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING
value	STRING

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:terminate-service-primitive

Set of service primitives to execute during termination of NSD.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:terminate-service-primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:terminate-service-primitive[nsr:seq='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/terminate-service-primitive/0

Fields

Name	Type	Description
seq	UINT64	Sequence number for the service primitive.
name	STRING	Name of the service primitive.
user-defined-script	STRING	A user defined script.
parameter	LIST

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:terminate-service-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:seq>0</nsr:seq>
  <nsr:name>STRING</nsr:name>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:terminate-service-primitive>

nsr:parameter

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:terminate-service-primitive/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:terminate-service-primitive[nsr:seq='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/terminate-service-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING
value	STRING

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:monitoring-param

List of NS level params.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:monitoring-param

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:monitoring-param[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/monitoring-param/STRING

Fields

Name	Type	Description
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
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.)
aggregation-type	ENUM
id	STRING
name	STRING
nsd-mon-param-ref	LEAFREF	Reference to the NSD monitoring param descriptor that produced this result
vnfr-mon-param-ref	LIST	A list of VNFR monitoring params associated with this monp

JSON Sample

[
  {
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "aggregation-type": "AVERAGE",
    "id": "STRING",
    "name": "STRING",
    "nsd-mon-param-ref": "STRING",
    "vnfr-mon-param-ref": [
      {
        "vnfr-id-ref": "STRING",
        "vnfr-mon-param-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:monitoring-param xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:value-type>INT</nsr:value-type>
  <nsr:numeric-constraints>
    <nsr:min-value>0</nsr:min-value>
    <nsr:max-value>0</nsr:max-value>
  </nsr:numeric-constraints>
  <nsr:text-constraints>
    <nsr:min-length>0</nsr:min-length>
    <nsr:max-length>0</nsr:max-length>
  </nsr:text-constraints>
  <nsr:value-integer>0</nsr:value-integer>
  <nsr:value-decimal>0.0</nsr:value-decimal>
  <nsr:value-string>STRING</nsr:value-string>
  <nsr:description>STRING</nsr:description>
  <nsr:group-tag>STRING</nsr:group-tag>
  <nsr:widget-type>COUNTER</nsr:widget-type>
  <nsr:units>STRING</nsr:units>
  <nsr:aggregation-type>AVERAGE</nsr:aggregation-type>
  <nsr:name>STRING</nsr:name>
  <nsr:nsd-mon-param-ref>STRING</nsr:nsd-mon-param-ref>
  <nsr:vnfr-mon-param-ref>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnfr-mon-param-ref>STRING</nsr:vnfr-mon-param-ref>
  </nsr:vnfr-mon-param-ref>
</nsr:monitoring-param>

nsr:numeric-constraints

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:monitoring-param/nsr:numeric-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:monitoring-param[nsr:id='STRING']/nsr:numeric-constraints

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/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 Sample

{
  "min-value": 0,
  "max-value": 0
}

XML Sample

<nsr:numeric-constraints xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:min-value>0</nsr:min-value>
  <nsr:max-value>0</nsr:max-value>
</nsr:numeric-constraints>

nsr:text-constraints

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:monitoring-param/nsr:text-constraints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:monitoring-param[nsr:id='STRING']/nsr:text-constraints

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/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 Sample

{
  "min-length": 0,
  "max-length": 0
}

XML Sample

<nsr:text-constraints xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:min-length>0</nsr:min-length>
  <nsr:max-length>0</nsr:max-length>
</nsr:text-constraints>

nsr:vnfr-mon-param-ref

A list of VNFR monitoring params associated with this monp

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:monitoring-param/nsr:vnfr-mon-param-ref

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:monitoring-param[nsr:id='STRING']/nsr:vnfr-mon-param-ref[nsr:vnfr-id-ref='STRING'][nsr:vnfr-mon-param-ref='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/monitoring-param/STRING/vnfr-mon-param-ref/STRING,STRING

Fields

Name	Type	Description
vnfr-id-ref	STRING	A reference to a vnfr. This is a leafref to path: /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:id
vnfr-mon-param-ref	LEAFREF	A reference to the VNFR monitoring param

JSON Sample

[
  {
    "vnfr-id-ref": "STRING",
    "vnfr-mon-param-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:vnfr-mon-param-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnfr-mon-param-ref>STRING</nsr:vnfr-mon-param-ref>
</nsr:vnfr-mon-param-ref>

nsr:config-agent-job

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0

Fields

Name	Type	Description
job-id	UINT64	config agent job Identifier for the NS.
job-name	STRING	Config agent job name
job-status	ENUM	Job status to be set based on each VNF primitive execution, pending - if at least one VNF is in pending state and remaining VNFs are in success state. Success - if all VNF executions are in success state failure - if one of the VNF executions is failure
triggered-by	ENUM	The primitive is triggered from NS or VNF level
create-time	UINT32	Creation timestamp of this Config Agent Job. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
job-status-details	STRING	Config agent job status details, in case of errors
parameter	LIST	List of parameters to the configuration primitive.
parameter-group	LIST	List of NS Primitive parameter groups
vnfr	LIST

JSON Sample

[
  {
    "job-id": 0,
    "job-name": "STRING",
    "job-status": "pending",
    "triggered-by": "ns-primitive",
    "create-time": 0,
    "job-status-details": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnfr": [
      {
        "id": "STRING",
        "vnf-job-status": "pending",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:config-agent-job xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:job-id>0</nsr:job-id>
  <nsr:job-name>STRING</nsr:job-name>
  <nsr:job-status>pending</nsr:job-status>
  <nsr:triggered-by>ns-primitive</nsr:triggered-by>
  <nsr:create-time>0</nsr:create-time>
  <nsr:job-status-details>STRING</nsr:job-status-details>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:parameter-group>
  <nsr:vnfr>
    <nsr:id>STRING</nsr:id>
    <nsr:vnf-job-status>pending</nsr:vnf-job-status>
    <nsr:primitive>...</nsr:primitive>
  </nsr:vnfr>
</nsr:config-agent-job>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:parameter-group

List of NS Primitive parameter groups

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:parameter-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:parameter-group[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
parameter	LIST	List of parameters to the configuration primitive.

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:parameter-group>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:vnfr

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:vnfr

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:vnfr[nsr:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/vnfr/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VNFR.
vnf-job-status	ENUM	Job status to be set based on each VNF primitive execution, pending - if at least one primitive is in pending state and remaining primitives are in success state. Success - if all primitive executions are in success state failure - if one of the primitive executions is failure
primitive	LIST

JSON Sample

[
  {
    "id": "STRING",
    "vnf-job-status": "pending",
    "primitive": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "execution-id": "STRING",
        "execution-status": "pending",
        "execution-error-details": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:vnfr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:vnf-job-status>pending</nsr:vnf-job-status>
  <nsr:primitive>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:execution-id>STRING</nsr:execution-id>
    <nsr:execution-status>pending</nsr:execution-status>
    <nsr:execution-error-details>STRING</nsr:execution-error-details>
  </nsr:primitive>
</nsr:vnfr>

nsr:primitive

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:vnfr/nsr:primitive

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:vnfr[nsr:id='STRING']/nsr:primitive[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/vnfr/STRING/primitive/STRING

Fields

Name	Type	Description
name	STRING	the name of the primitive
parameter	LIST	List of parameters to the configuration primitive.
execution-id	STRING	Execution id of the primitive
execution-status	ENUM	status of the Execution
execution-error-details	STRING	Error details if execution-status is failure

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "execution-id": "STRING",
    "execution-status": "pending",
    "execution-error-details": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:execution-id>STRING</nsr:execution-id>
  <nsr:execution-status>pending</nsr:execution-status>
  <nsr:execution-error-details>STRING</nsr:execution-error-details>
</nsr:primitive>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/rw-project:project/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:vnfr/nsr:primitive/nsr:parameter

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:vnfr[nsr:id='STRING']/nsr:primitive[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/vnfr/STRING/primitive/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_Nsr_Nsr_t_schema
Global Schema Pointer	rw_ypbc_Nsr_Nsr_g_schema

nsr rpc input

nsr:get-ns-service-primitive-values

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values
XPath Keyed Path	/nsr:get-ns-service-primitive-values
RW.REST URI Path	/input

Fields

Name	Type	Description
name	STRING	Name of the NS service primitive group
project-name	LEAFREF	Project to which this belongs
nsr_id_ref	LEAFREF	Reference to NSR ID ref

JSON Sample

{
  "name": "STRING",
  "project-name": "STRING",
  "nsr_id_ref": "STRING"
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:project-name>default</nsr:project-name>
  <nsr:nsr_id_ref>STRING</nsr:nsr_id_ref>
</nsr:input>

nsr:exec-ns-service-primitive

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive
XPath Keyed Path	/nsr:exec-ns-service-primitive
RW.REST URI Path	/input

Fields

Name	Type	Description
name	STRING	Name of the primitive
project-name	LEAFREF	Project to which this belongs
nsr_id_ref	LEAFREF	Reference to NSR ID ref
triggered-by	ENUM	The primitive is triggered from NS or VNF level
parameter	LIST	List of parameters to the configuration primitive.
parameter-group	LIST	List of NS Primitive parameter groups
vnf-list	LIST	List of VNFs whose primitives are being set.
user-defined-script	STRING	A user defined script.

JSON Sample

{
  "name": "STRING",
  "project-name": "STRING",
  "nsr_id_ref": "STRING",
  "triggered-by": "ns-primitive",
  "parameter": [
    {
      "name": "STRING",
      "value": "STRING"
    }, {
      ...
    }
  ],
  "parameter-group": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnf-list": [
    {
      "member_vnf_index_ref": 0,
      "vnfr-id-ref": "STRING",
      "vnf-primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "user-defined-script": "STRING"
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:project-name>default</nsr:project-name>
  <nsr:nsr_id_ref>STRING</nsr:nsr_id_ref>
  <nsr:triggered-by>ns-primitive</nsr:triggered-by>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:parameter-group>
  <nsr:vnf-list>
    <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnf-primitive>...</nsr:vnf-primitive>
  </nsr:vnf-list>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
</nsr:input>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:parameter
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:parameter[nsr:name='STRING']
RW.REST URI Path	/input/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:parameter-group

List of NS Primitive parameter groups

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:parameter-group
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:parameter-group[nsr:name='STRING']
RW.REST URI Path	/input/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
parameter	LIST	List of parameters to the configuration primitive.

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:parameter-group>

XML Sample

<nsr:parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:parameter-group>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/input/parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:vnf-list

List of VNFs whose primitives are being set.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:vnf-list
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:vnf-list[nsr:member_vnf_index_ref='0']
RW.REST URI Path	/input/vnf-list/0

Fields

Name	Type	Description
member_vnf_index_ref	UINT64	Member VNF index
vnfr-id-ref	STRING	A reference to a vnfr. This is a leafref to path
vnf-primitive	LIST	List of service primitives supported by the configuration agent for this VNF.

JSON Config Sample

[
  {
    "member_vnf_index_ref": 0,
    "vnfr-id-ref": "STRING",
    "vnf-primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member_vnf_index_ref": 0,
    "vnfr-id-ref": "STRING",
    "vnf-primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnf-list xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnf-primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:vnf-primitive>
</nsr:vnf-list>

XML Sample

<nsr:vnf-list xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnf-primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:vnf-primitive>
</nsr:vnf-list>

nsr:vnf-primitive

List of service primitives supported by the configuration agent for this VNF.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:vnf-list/nsr:vnf-primitive
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:vnf-list[nsr:member_vnf_index_ref='0']/nsr:vnf-primitive[nsr:index='0']
RW.REST URI Path	/input/vnf-list/0/vnf-primitive/0

Fields

Name	Type	Description
index	UINT32	index of the service primitive.
name	STRING	Name of the service primitive.
parameter	LIST	List of parameters to the configuration primitive.

JSON Config Sample

[
  {
    "index": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "index": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnf-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:vnf-primitive>

XML Sample

<nsr:vnf-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:vnf-primitive>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:vnf-list/nsr:vnf-primitive/nsr:parameter

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:vnf-list[nsr:member_vnf_index_ref='0']/nsr:vnf-primitive[nsr:index='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/input/vnf-list/0/vnf-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:exec-scale-in

Key Identifiers:

XPath Path	/nsr:exec-scale-in
XPath Keyed Path	/nsr:exec-scale-in
RW.REST URI Path	/input

Fields

Name	Type	Description
project-name	LEAFREF	Project to which this belongs
nsr_id_ref	LEAFREF	Reference to NSR ID ref
scaling-group-name-ref	LEAFREF	name of the scaling group
instance-id	LEAFREF	id of the scaling group

JSON Sample

{
  "project-name": "STRING",
  "nsr_id_ref": "STRING",
  "scaling-group-name-ref": "STRING",
  "instance-id": 0
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:project-name>default</nsr:project-name>
  <nsr:nsr_id_ref>STRING</nsr:nsr_id_ref>
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance-id>0</nsr:instance-id>
</nsr:input>

nsr:exec-scale-out

Key Identifiers:

XPath Path	/nsr:exec-scale-out
XPath Keyed Path	/nsr:exec-scale-out
RW.REST URI Path	/input

Fields

Name	Type	Description
project-name	LEAFREF	Project to which this belongs
nsr_id_ref	LEAFREF	Reference to NSR ID ref
scaling-group-name-ref	LEAFREF	name of the scaling group
instance-id	UINT64	id of the scaling group

JSON Sample

{
  "project-name": "STRING",
  "nsr_id_ref": "STRING",
  "scaling-group-name-ref": "STRING",
  "instance-id": 0
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:project-name>default</nsr:project-name>
  <nsr:nsr_id_ref>STRING</nsr:nsr_id_ref>
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance-id>0</nsr:instance-id>
</nsr:input>

nsr:start-network-service

Key Identifiers:

XPath Path	/nsr:start-network-service
XPath Keyed Path	/nsr:start-network-service
RW.REST URI Path	/input

Fields

Name	Type	Description
name	STRING	Name of the Network Service
project-name	LEAFREF	Project to which this belongs
nsd_id_ref	LEAFREF	Reference to NSD ID ref
input-parameter	LIST	List of input parameters
scaling-group	LIST	List of ns scaling group instances
nsd-placement-group-maps	LIST	Mapping from mano-placement groups construct from NSD to cloud platform placement group construct
vnfd-placement-group-maps	LIST	Mapping from mano-placement groups construct from VNFD to cloud platform placement group construct

JSON Sample

{
  "name": "STRING",
  "project-name": "STRING",
  "nsd_id_ref": "STRING",
  "input-parameter": [
    {
      "xpath": "STRING",
      "value": "STRING"
    }, {
      ...
    }
  ],
  "scaling-group": [
    {
      "scaling-group-name-ref": "STRING",
      "instance": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "nsd-placement-group-maps": [
    {
      "placement-group-ref": "STRING",
      "cloud-type": "aws",
      "availability-zone": { ... },
      "server-group": { ... },
      "host-aggregate": [ { ... }, { ... } ],
      "aws-construct": [null],
      "openmano-construct": [null],
      "vsphere-construct": [null],
      "mock-construct": [null],
      "cloudsim-construct": [null]
    }, {
      ...
    }
  ],
  "vnfd-placement-group-maps": [
    {
      "vnfd-id-ref": "STRING",
      "placement-group-ref": "STRING",
      "cloud-type": "aws",
      "availability-zone": { ... },
      "server-group": { ... },
      "host-aggregate": [ { ... }, { ... } ],
      "aws-construct": [null],
      "openmano-construct": [null],
      "vsphere-construct": [null],
      "mock-construct": [null],
      "cloudsim-construct": [null],
      "ssh-authorized-key": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:project-name>default</nsr:project-name>
  <nsr:nsd_id_ref>STRING</nsr:nsd_id_ref>
  <nsr:input-parameter>
    <nsr:xpath>STRING</nsr:xpath>
    <nsr:value>STRING</nsr:value>
  </nsr:input-parameter>
  <nsr:scaling-group>
    <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
    <nsr:instance>...</nsr:instance>
  </nsr:scaling-group>
  <nsr:nsd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:nsd-placement-group-maps>
  <nsr:vnfd-placement-group-maps>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
    <nsr:user>...</nsr:user>
  </nsr:vnfd-placement-group-maps>
</nsr:input>

nsr:input-parameter

List of input parameters

Key Identifiers:

XPath Path	/nsr:start-network-service/nsr:input-parameter
XPath Keyed Path	/nsr:start-network-service/nsr:input-parameter[nsr:xpath='STRING']
RW.REST URI Path	/input/input-parameter/STRING

Fields

Name	Type	Description
xpath	STRING	An xpath that specfies which element in a descriptor is to be modified.
value	STRING	The value that the element specified by the xpath should take when a record is created.

JSON Config Sample

[
  {
    "xpath": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "xpath": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:input-parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:xpath>STRING</nsr:xpath>
  <nsr:value>STRING</nsr:value>
</nsr:input-parameter>

XML Sample

<nsr:input-parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:xpath>STRING</nsr:xpath>
  <nsr:value>STRING</nsr:value>
</nsr:input-parameter>

nsr:scaling-group

List of ns scaling group instances

Key Identifiers:

XPath Path	/nsr:start-network-service/nsr:scaling-group
XPath Keyed Path	/nsr:start-network-service/nsr:scaling-group[nsr:scaling-group-name-ref='STRING']
RW.REST URI Path	/input/scaling-group/STRING

Fields

Name	Type	Description
scaling-group-name-ref	STRING	name of the scaling group leafref path ../nsd/scaling-group-descriptor/name
instance	LIST	The instance of the scaling group

JSON Config Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "id": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "id": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:scaling-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:id>0</nsr:id>
  </nsr:instance>
</nsr:scaling-group>

XML Sample

<nsr:scaling-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:id>0</nsr:id>
  </nsr:instance>
</nsr:scaling-group>

nsr:instance

The instance of the scaling group

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:scaling-group/nsr:instance

XPath Keyed Path

/nsr:start-network-service/nsr:scaling-group[nsr:scaling-group-name-ref='STRING']/nsr:instance[nsr:id='0']

RW.REST URI Path

/input/scaling-group/STRING/instance/0

Fields

Name	Type	Description
id	UINT16	Scaling group instance uuid

JSON Config Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

XML Config Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>0</nsr:id>
</nsr:instance>

XML Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>0</nsr:id>
</nsr:instance>

nsr:nsd-placement-group-maps

Mapping from mano-placement groups construct from NSD to cloud platform placement group construct

Key Identifiers:

XPath Path	/nsr:start-network-service/nsr:nsd-placement-group-maps
XPath Keyed Path	/nsr:start-network-service/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']
RW.REST URI Path	/input/nsd-placement-group-maps/STRING

Fields

Name	Type	Description
placement-group-ref	STRING	Reference for NSD placement group
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Config Sample

[
  {
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Config Sample

<nsr:nsd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:nsd-placement-group-maps>

XML Sample

<nsr:nsd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:nsd-placement-group-maps>

nsr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:nsd-placement-group-maps/nsr:availability-zone

XPath Keyed Path

/nsr:start-network-service/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:availability-zone

RW.REST URI Path

/input/nsd-placement-group-maps/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

XML Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

nsr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:nsd-placement-group-maps/nsr:server-group

XPath Keyed Path

/nsr:start-network-service/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:server-group

RW.REST URI Path

/input/nsd-placement-group-maps/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

XML Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

nsr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:nsd-placement-group-maps/nsr:host-aggregate

XPath Keyed Path

/nsr:start-network-service/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:host-aggregate[nsr:metadata-key='STRING']

RW.REST URI Path

/input/nsd-placement-group-maps/STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Config Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

XML Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

nsr:vnfd-placement-group-maps

Mapping from mano-placement groups construct from VNFD to cloud platform placement group construct

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING

Fields

Name	Type	Description
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../project-nsd:constituent-vnfd + [id = current()/../project-nsd:id-ref] + /project-nsd:vnfd-id-ref NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resovled this will switched to use leafref
placement-group-ref	LEAFREF	A reference to VNFD placement group
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY
ssh-authorized-key	LIST	List of authorized ssh keys as part of cloud-config
user	LIST	List of users to be added through cloud-config

JSON Config Sample

[
  {
    "vnfd-id-ref": "STRING",
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null],
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "ssh-authorized-key": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfd-id-ref": "STRING",
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null],
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "ssh-authorized-key": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnfd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
  </nsr:user>
</nsr:vnfd-placement-group-maps>

XML Sample

<nsr:vnfd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
  </nsr:user>
</nsr:vnfd-placement-group-maps>

nsr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:availability-zone

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:availability-zone

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

XML Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

nsr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:server-group

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:server-group

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

XML Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

nsr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:host-aggregate

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:host-aggregate[nsr:metadata-key='STRING']

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Config Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

XML Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

nsr:ssh-authorized-key

List of authorized ssh keys as part of cloud-config

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:ssh-authorized-key

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:ssh-authorized-key[nsr:key-pair-ref='STRING']

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/ssh-authorized-key/STRING

Fields

Name	Type	Description
key-pair-ref	LEAFREF	A reference to the key pair entry in the global key pair table

JSON Config Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

XML Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

nsr:user

List of users to be added through cloud-config

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:user

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:user[nsr:name='STRING']

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/user/STRING

Fields

Name	Type	Description
name	STRING	Name of the user
user-info	STRING	The user name's real name
ssh-authorized-key	LIST	Used to configure the list of public keys to be injected as part of ns instantiation

JSON Config Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:user xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:user-info>STRING</nsr:user-info>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
</nsr:user>

XML Sample

<nsr:user xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:user-info>STRING</nsr:user-info>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
</nsr:user>

nsr:ssh-authorized-key

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:user/nsr:ssh-authorized-key

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:user[nsr:name='STRING']/nsr:ssh-authorized-key[nsr:key-pair-ref='STRING']

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/user/STRING/ssh-authorized-key/STRING

Fields

Name	Type	Description
key-pair-ref	LEAFREF	A reference to the key pair entry in the global key pair table

JSON Config Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

XML Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

nsr rpc output

nsr:get-ns-service-primitive-values

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values
XPath Keyed Path	/nsr:get-ns-service-primitive-values
RW.REST URI Path	/output

Fields

Name	Type	Description
ns-parameter	LIST	Automatically generated parameter
ns-parameter-group	LIST	Automatically generated parameters in parameter group
vnf-primitive-group	LIST	List of service primitives grouped by VNF.

JSON Sample

{
  "ns-parameter": [
    {
      "name": "STRING",
      "value": "STRING"
    }, {
      ...
    }
  ],
  "ns-parameter-group": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnf-primitive-group": [
    {
      "member-vnf-index-ref": 0,
      "vnfd-id-ref": "STRING",
      "primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:ns-parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:ns-parameter>
  <nsr:ns-parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:ns-parameter-group>
  <nsr:vnf-primitive-group>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:primitive>...</nsr:primitive>
  </nsr:vnf-primitive-group>
</nsr:output>

nsr:ns-parameter

Automatically generated parameter

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values/nsr:ns-parameter
XPath Keyed Path	/nsr:get-ns-service-primitive-values/nsr:ns-parameter[nsr:name='STRING']
RW.REST URI Path	/output/ns-parameter/STRING

Fields

Name	Type	Description
name	STRING	Parameter name which should be pulled from a parameter pool
value	STRING	Automatically generated value

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ns-parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:ns-parameter>

XML Sample

<nsr:ns-parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:ns-parameter>

nsr:ns-parameter-group

Automatically generated parameters in parameter group

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values/nsr:ns-parameter-group
XPath Keyed Path	/nsr:get-ns-service-primitive-values/nsr:ns-parameter-group[nsr:name='STRING']
RW.REST URI Path	/output/ns-parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Parameter group name
parameter	LIST	Automatically generated group parameter

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:ns-parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:ns-parameter-group>

XML Sample

<nsr:ns-parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:ns-parameter-group>

nsr:parameter

Automatically generated group parameter

Key Identifiers:

XPath Path

/nsr:get-ns-service-primitive-values/nsr:ns-parameter-group/nsr:parameter

XPath Keyed Path

/nsr:get-ns-service-primitive-values/nsr:ns-parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/output/ns-parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Parameter name which should be pulled from a parameter pool
value	STRING	Automatically generated value

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:vnf-primitive-group

List of service primitives grouped by VNF.

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group
XPath Keyed Path	/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']
RW.REST URI Path	/output/vnf-primitive-group/0

Fields

Name	Type	Description
member-vnf-index-ref	UINT64	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../project-nsd:constituent-vnfd + [project-nsd:id = current()/../project-nsd:id-ref] + /project-nsd:vnfd-id-ref NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
primitive	LIST

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnf-primitive-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:primitive>
</nsr:vnf-primitive-group>

XML Sample

<nsr:vnf-primitive-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:primitive>
</nsr:vnf-primitive-group>

nsr:primitive

Key Identifiers:

XPath Path

/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group/nsr:primitive

XPath Keyed Path

/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']/nsr:primitive[nsr:index='0']

RW.REST URI Path

/output/vnf-primitive-group/0/primitive/0

Fields

Name	Type	Description
index	UINT32	Index of this primitive
name	STRING	Name of the primitive associated with a value pool
parameter	LIST	Automatically generated parameter

JSON Config Sample

[
  {
    "index": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "index": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:primitive>

XML Sample

<nsr:primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:primitive>

nsr:parameter

Automatically generated parameter

Key Identifiers:

XPath Path

/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group/nsr:primitive/nsr:parameter

XPath Keyed Path

/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']/nsr:primitive[nsr:index='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/output/vnf-primitive-group/0/primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Parameter name which should be pulled from a parameter pool
value	STRING	Automatically generated value

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:exec-ns-service-primitive

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive
XPath Keyed Path	/nsr:exec-ns-service-primitive
RW.REST URI Path	/output

Fields

Name	Type	Description
job-id	UINT64	Job identifier for this RPC
name	STRING	Name of the service primitive
project-name	LEAFREF	Project to which this belongs
nsr_id_ref	LEAFREF	Reference to NSR ID ref
triggered-by	ENUM	The primitive is triggered from NS or VNF level
create-time	UINT32	Creation timestamp of this config agent JOB. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
job-status-details	STRING	Job status details, in case of any errors
parameter	LIST	List of parameters to the configuration primitive.
parameter-group	LIST	List of NS Primitive parameter groups
vnf-out-list	LIST	List of VNFs whose primitives were set.

JSON Sample

{
  "job-id": 0,
  "name": "STRING",
  "project-name": "STRING",
  "nsr_id_ref": "STRING",
  "triggered-by": "ns-primitive",
  "create-time": 0,
  "job-status-details": "STRING",
  "parameter": [
    {
      "name": "STRING",
      "value": "STRING"
    }, {
      ...
    }
  ],
  "parameter-group": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnf-out-list": [
    {
      "member_vnf_index_ref": 0,
      "vnfr-id-ref": "STRING",
      "vnf-out-primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:job-id>0</nsr:job-id>
  <nsr:name>STRING</nsr:name>
  <nsr:project-name>default</nsr:project-name>
  <nsr:nsr_id_ref>STRING</nsr:nsr_id_ref>
  <nsr:triggered-by>ns-primitive</nsr:triggered-by>
  <nsr:create-time>0</nsr:create-time>
  <nsr:job-status-details>STRING</nsr:job-status-details>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:parameter-group>
  <nsr:vnf-out-list>
    <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnf-out-primitive>...</nsr:vnf-out-primitive>
  </nsr:vnf-out-list>
</nsr:output>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:parameter
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:parameter[nsr:name='STRING']
RW.REST URI Path	/output/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:parameter-group

List of NS Primitive parameter groups

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:parameter-group
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:parameter-group[nsr:name='STRING']
RW.REST URI Path	/output/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
parameter	LIST	List of parameters to the configuration primitive.

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:parameter-group>

XML Sample

<nsr:parameter-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:parameter-group>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/output/parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:vnf-out-list

List of VNFs whose primitives were set.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:vnf-out-list
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:vnf-out-list[nsr:member_vnf_index_ref='0']
RW.REST URI Path	/output/vnf-out-list/0

Fields

Name	Type	Description
member_vnf_index_ref	UINT64	Member VNF index
vnfr-id-ref	STRING	A reference to a vnfr. This is a leafref to path
vnf-out-primitive	LIST	List of service primitives supported by the configuration agent for this VNF.

JSON Config Sample

[
  {
    "member_vnf_index_ref": 0,
    "vnfr-id-ref": "STRING",
    "vnf-out-primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "execution-id": "STRING",
        "execution-status": "STRING",
        "execution-error-details": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member_vnf_index_ref": 0,
    "vnfr-id-ref": "STRING",
    "vnf-out-primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "execution-id": "STRING",
        "execution-status": "STRING",
        "execution-error-details": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnf-out-list xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnf-out-primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:execution-id>STRING</nsr:execution-id>
    <nsr:execution-status>STRING</nsr:execution-status>
    <nsr:execution-error-details>STRING</nsr:execution-error-details>
  </nsr:vnf-out-primitive>
</nsr:vnf-out-list>

XML Sample

<nsr:vnf-out-list xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnf-out-primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:execution-id>STRING</nsr:execution-id>
    <nsr:execution-status>STRING</nsr:execution-status>
    <nsr:execution-error-details>STRING</nsr:execution-error-details>
  </nsr:vnf-out-primitive>
</nsr:vnf-out-list>

nsr:vnf-out-primitive

List of service primitives supported by the configuration agent for this VNF.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:vnf-out-list/nsr:vnf-out-primitive

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:vnf-out-list[nsr:member_vnf_index_ref='0']/nsr:vnf-out-primitive[nsr:index='0']

RW.REST URI Path

/output/vnf-out-list/0/vnf-out-primitive/0

Fields

Name	Type	Description
index	UINT32	index of the service primitive.
name	STRING	Name of the service primitive.
parameter	LIST	List of parameters to the configuration primitive.
execution-id	STRING	Execution id of this primitive
execution-status	STRING	Status of the execution of this primitive
execution-error-details	STRING	Error details if execution-status is failed

JSON Config Sample

[
  {
    "index": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "execution-id": "STRING",
    "execution-status": "STRING",
    "execution-error-details": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "index": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "execution-id": "STRING",
    "execution-status": "STRING",
    "execution-error-details": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnf-out-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:execution-id>STRING</nsr:execution-id>
  <nsr:execution-status>STRING</nsr:execution-status>
  <nsr:execution-error-details>STRING</nsr:execution-error-details>
</nsr:vnf-out-primitive>

XML Sample

<nsr:vnf-out-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:execution-id>STRING</nsr:execution-id>
  <nsr:execution-status>STRING</nsr:execution-status>
  <nsr:execution-error-details>STRING</nsr:execution-error-details>
</nsr:vnf-out-primitive>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:vnf-out-list/nsr:vnf-out-primitive/nsr:parameter

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:vnf-out-list[nsr:member_vnf_index_ref='0']/nsr:vnf-out-primitive[nsr:index='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/output/vnf-out-list/0/vnf-out-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

XML Sample

<nsr:parameter xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:value>STRING</nsr:value>
</nsr:parameter>

nsr:exec-scale-in

Key Identifiers:

XPath Path	/nsr:exec-scale-in
XPath Keyed Path	/nsr:exec-scale-in
RW.REST URI Path	/output

Fields

Name	Type	Description
instance-id	UINT64	id of the scaling group

JSON Sample

{
  "instance-id": 0
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:instance-id>0</nsr:instance-id>
</nsr:output>

nsr:exec-scale-out

Key Identifiers:

XPath Path	/nsr:exec-scale-out
XPath Keyed Path	/nsr:exec-scale-out
RW.REST URI Path	/output

Fields

Name	Type	Description
instance-id	UINT64	id of the scaling group

JSON Sample

{
  "instance-id": 0
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:instance-id>0</nsr:instance-id>
</nsr:output>

nsr:start-network-service

Key Identifiers:

XPath Path	/nsr:start-network-service
XPath Keyed Path	/nsr:start-network-service
RW.REST URI Path	/output

Fields

Name	Type	Description
nsr-id	STRING	Automatically generated parameter

JSON Sample

{
  "nsr-id": "STRING"
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr-id>STRING</nsr:nsr-id>
</nsr:output>