rw-project - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwVlr_RwProject_t_schema
Global Schema Pointer	rw_ypbc_RwVlr_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.
cloud-accounts	CONTAINER
vim-resources	CONTAINER
virtual-link-req-params	CONTAINER	This object defines the parameters required to create a virtual-link
vdu-init-params	CONTAINER	This object defines the parameters required to create a VDU
vdu-modify-params	CONTAINER	This object defines the parameters required to modify VDU
vnf-resources	CONTAINER
vlr-catalog	CONTAINER
vnfd-catalog	CONTAINER	Virtual Network Function Descriptor (VNFD).
vld-catalog	CONTAINER
sdn-accounts	CONTAINER
vnffgs	CONTAINER
vnffg-rendered-paths	CONTAINER
vnffg-classifiers	CONTAINER
sdn	CONTAINER
cloud	CONTAINER

JSON Config Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "project-config": {
      "user": [ { ... }, { ... } ]
    },
    "rwcal:cloud-accounts": {
      "cloud-account-list": [ { ... }, { ... } ]
    },
    "rwcal:virtual-link-req-params": {
      "name": "STRING",
      "subnet": "STRING",
      "associate-public-ip": false,
      "vim-network-name": "STRING",
      "virtual-cps": [ { ... }, { ... } ],
      "provider-network": { ... },
      "ip-profile-params": { ... }
    },
    "rwcal:vdu-init-params": {
      "name": "STRING",
      "mgmt-vpci": "STRING",
      "vm-flavor": { ... },
      "guest-epa": { ... },
      "vswitch-epa": { ... },
      "hypervisor-epa": { ... },
      "host-epa": { ... },
      "node-id": "STRING",
      "flavor-id": "STRING",
      "image-id": "STRING",
      "image-name": "STRING",
      "image-checksum": "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],
      "connection-points": [ { ... }, { ... } ],
      "mgmt-network": "STRING",
      "allocate-public-address": false,
      "vdu-init": { ... },
      "supplemental-boot-data": { ... },
      "volumes": [ { ... }, { ... } ]
    },
    "rwcal:vdu-modify-params": {
      "vdu-id": "STRING",
      "static-ip-address": "UNION_VALUE",
      "type": "VIRTIO",
      "image-id": "STRING",
      "connection-points-add": [ { ... }, { ... } ],
      "connection-points-remove": [ { ... }, { ... } ]
    },
    "project-vnfd:vnfd-catalog": {
      "vnfd": [ { ... }, { ... } ]
    },
    "vld:vld-catalog": {
      "vld": [ { ... }, { ... } ]
    },
    "rwsdnal:sdn-accounts": {
      "sdn-account-list": [ { ... }, { ... } ]
    },
    "rwsdnal:vnffgs": {
      "vnffg-chain": [ { ... }, { ... } ]
    },
    "rwsdnal:vnffg-rendered-paths": {
    },
    "rwsdnal:vnffg-classifiers": {
      "vnffg-classifier": [ { ... }, { ... } ]
    },
    "rw-sdn:sdn": {
      "account": [ { ... }, { ... } ]
    },
    "rw-cloud:cloud": {
      "account": [ { ... }, { ... } ]
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "project-config": {
      "user": [ { ... }, { ... } ]
    },
    "project-state": {
      "user": [ { ... }, { ... } ],
      "role": [ { ... }, { ... } ]
    },
    "rwcal:cloud-accounts": {
      "cloud-account-list": [ { ... }, { ... } ]
    },
    "rwcal:vim-resources": {
      "vminfo-list": [ { ... }, { ... } ],
      "imageinfo-list": [ { ... }, { ... } ],
      "tenantinfo-list": [ { ... }, { ... } ],
      "userinfo-list": [ { ... }, { ... } ],
      "roleinfo-list": [ { ... }, { ... } ],
      "hostinfo-list": [ { ... }, { ... } ],
      "networkinfo-list": [ { ... }, { ... } ],
      "portinfo-list": [ { ... }, { ... } ],
      "flavorinfo-list": [ { ... }, { ... } ]
    },
    "rwcal:virtual-link-req-params": {
      "name": "STRING",
      "subnet": "STRING",
      "associate-public-ip": false,
      "vim-network-name": "STRING",
      "virtual-cps": [ { ... }, { ... } ],
      "provider-network": { ... },
      "ip-profile-params": { ... }
    },
    "rwcal:vdu-init-params": {
      "name": "STRING",
      "mgmt-vpci": "STRING",
      "vm-flavor": { ... },
      "guest-epa": { ... },
      "vswitch-epa": { ... },
      "hypervisor-epa": { ... },
      "host-epa": { ... },
      "node-id": "STRING",
      "flavor-id": "STRING",
      "image-id": "STRING",
      "image-name": "STRING",
      "image-checksum": "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],
      "connection-points": [ { ... }, { ... } ],
      "mgmt-network": "STRING",
      "allocate-public-address": false,
      "vdu-init": { ... },
      "supplemental-boot-data": { ... },
      "volumes": [ { ... }, { ... } ]
    },
    "rwcal:vdu-modify-params": {
      "vdu-id": "STRING",
      "static-ip-address": "UNION_VALUE",
      "type": "VIRTIO",
      "image-id": "STRING",
      "connection-points-add": [ { ... }, { ... } ],
      "connection-points-remove": [ { ... }, { ... } ]
    },
    "rwcal:vnf-resources": {
      "virtual-link-info-list": [ { ... }, { ... } ],
      "vdu-info-list": [ { ... }, { ... } ]
    },
    "vlr:vlr-catalog": {
      "vlr": [ { ... }, { ... } ]
    },
    "project-vnfd:vnfd-catalog": {
      "vnfd": [ { ... }, { ... } ]
    },
    "vld:vld-catalog": {
      "vld": [ { ... }, { ... } ]
    },
    "rwsdnal:sdn-accounts": {
      "sdn-account-list": [ { ... }, { ... } ]
    },
    "rwsdnal:vnffgs": {
      "vnffg-chain": [ { ... }, { ... } ]
    },
    "rwsdnal:vnffg-rendered-paths": {
      "vnffg-rendered-path": [ { ... }, { ... } ]
    },
    "rwsdnal:vnffg-classifiers": {
      "vnffg-classifier": [ { ... }, { ... } ]
    },
    "rw-sdn:sdn": {
      "account": [ { ... }, { ... } ]
    },
    "rw-cloud:cloud": {
      "account": [ { ... }, { ... } ]
    }
  }, {
    ...
  }
]

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>
  <rwcal:cloud-accounts xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:cloud-account-list>...</rwcal:cloud-account-list>
  </rwcal:cloud-accounts>
  <rwcal:virtual-link-req-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:name>STRING</rwcal:name>
    <rwcal:subnet>STRING</rwcal:subnet>
    <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
    <rwcal:vim-network-name>STRING</rwcal:vim-network-name>
    <rwcal:virtual-cps>...</rwcal:virtual-cps>
    <rwcal:provider-network>...</rwcal:provider-network>
    <rwcal:ip-profile-params>...</rwcal:ip-profile-params>
  </rwcal:virtual-link-req-params>
  <rwcal:vdu-init-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:name>STRING</rwcal:name>
    <rwcal:mgmt-vpci>STRING</rwcal:mgmt-vpci>
    <rwcal:vm-flavor>...</rwcal:vm-flavor>
    <rwcal:guest-epa>...</rwcal:guest-epa>
    <rwcal:vswitch-epa>...</rwcal:vswitch-epa>
    <rwcal:hypervisor-epa>...</rwcal:hypervisor-epa>
    <rwcal:host-epa>...</rwcal:host-epa>
    <rwcal:node-id>STRING</rwcal:node-id>
    <rwcal:flavor-id>STRING</rwcal:flavor-id>
    <rwcal:image-id>STRING</rwcal:image-id>
    <rwcal:image-name>STRING</rwcal:image-name>
    <rwcal:image-checksum>STRING</rwcal:image-checksum>
    <rwcal:cloud-type>aws</rwcal:cloud-type>
    <rwcal:availability-zone>...</rwcal:availability-zone>
    <rwcal:server-group>...</rwcal:server-group>
    <rwcal:host-aggregate>...</rwcal:host-aggregate>
    <rwcal:aws-construct/>
    <rwcal:openmano-construct/>
    <rwcal:vsphere-construct/>
    <rwcal:mock-construct/>
    <rwcal:cloudsim-construct/>
    <rwcal:connection-points>...</rwcal:connection-points>
    <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
    <rwcal:allocate-public-address>false</rwcal:allocate-public-address>
    <rwcal:vdu-init>...</rwcal:vdu-init>
    <rwcal:supplemental-boot-data>...</rwcal:supplemental-boot-data>
    <rwcal:volumes>...</rwcal:volumes>
  </rwcal:vdu-init-params>
  <rwcal:vdu-modify-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:vdu-id>STRING</rwcal:vdu-id>
    <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
    <rwcal:type>VIRTIO</rwcal:type>
    <rwcal:image-id>STRING</rwcal:image-id>
    <rwcal:connection-points-add>...</rwcal:connection-points-add>
    <rwcal:connection-points-remove>...</rwcal:connection-points-remove>
  </rwcal:vdu-modify-params>
  <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>
  <vld:vld-catalog xmlns:vld="urn:ietf:params:xml:ns:yang:nfvo:vld">
    <vld:vld>...</vld:vld>
  </vld:vld-catalog>
  <rwsdnal:sdn-accounts xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
    <rwsdnal:sdn-account-list>...</rwsdnal:sdn-account-list>
  </rwsdnal:sdn-accounts>
  <rwsdnal:vnffgs xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
    <rwsdnal:vnffg-chain>...</rwsdnal:vnffg-chain>
  </rwsdnal:vnffgs>
  <rwsdnal:vnffg-rendered-paths xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal"/>
  <rwsdnal:vnffg-classifiers xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
    <rwsdnal:vnffg-classifier>...</rwsdnal:vnffg-classifier>
  </rwsdnal:vnffg-classifiers>
  <rw-sdn:sdn xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
    <rw-sdn:account>...</rw-sdn:account>
  </rw-sdn:sdn>
  <rw-cloud:cloud xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
    <rw-cloud:account>...</rw-cloud:account>
  </rw-cloud:cloud>
</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>
  <rwcal:cloud-accounts xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:cloud-account-list>...</rwcal:cloud-account-list>
  </rwcal:cloud-accounts>
  <rwcal:vim-resources xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:vminfo-list>...</rwcal:vminfo-list>
    <rwcal:imageinfo-list>...</rwcal:imageinfo-list>
    <rwcal:tenantinfo-list>...</rwcal:tenantinfo-list>
    <rwcal:userinfo-list>...</rwcal:userinfo-list>
    <rwcal:roleinfo-list>...</rwcal:roleinfo-list>
    <rwcal:hostinfo-list>...</rwcal:hostinfo-list>
    <rwcal:networkinfo-list>...</rwcal:networkinfo-list>
    <rwcal:portinfo-list>...</rwcal:portinfo-list>
    <rwcal:flavorinfo-list>...</rwcal:flavorinfo-list>
  </rwcal:vim-resources>
  <rwcal:virtual-link-req-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:name>STRING</rwcal:name>
    <rwcal:subnet>STRING</rwcal:subnet>
    <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
    <rwcal:vim-network-name>STRING</rwcal:vim-network-name>
    <rwcal:virtual-cps>...</rwcal:virtual-cps>
    <rwcal:provider-network>...</rwcal:provider-network>
    <rwcal:ip-profile-params>...</rwcal:ip-profile-params>
  </rwcal:virtual-link-req-params>
  <rwcal:vdu-init-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:name>STRING</rwcal:name>
    <rwcal:mgmt-vpci>STRING</rwcal:mgmt-vpci>
    <rwcal:vm-flavor>...</rwcal:vm-flavor>
    <rwcal:guest-epa>...</rwcal:guest-epa>
    <rwcal:vswitch-epa>...</rwcal:vswitch-epa>
    <rwcal:hypervisor-epa>...</rwcal:hypervisor-epa>
    <rwcal:host-epa>...</rwcal:host-epa>
    <rwcal:node-id>STRING</rwcal:node-id>
    <rwcal:flavor-id>STRING</rwcal:flavor-id>
    <rwcal:image-id>STRING</rwcal:image-id>
    <rwcal:image-name>STRING</rwcal:image-name>
    <rwcal:image-checksum>STRING</rwcal:image-checksum>
    <rwcal:cloud-type>aws</rwcal:cloud-type>
    <rwcal:availability-zone>...</rwcal:availability-zone>
    <rwcal:server-group>...</rwcal:server-group>
    <rwcal:host-aggregate>...</rwcal:host-aggregate>
    <rwcal:aws-construct/>
    <rwcal:openmano-construct/>
    <rwcal:vsphere-construct/>
    <rwcal:mock-construct/>
    <rwcal:cloudsim-construct/>
    <rwcal:connection-points>...</rwcal:connection-points>
    <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
    <rwcal:allocate-public-address>false</rwcal:allocate-public-address>
    <rwcal:vdu-init>...</rwcal:vdu-init>
    <rwcal:supplemental-boot-data>...</rwcal:supplemental-boot-data>
    <rwcal:volumes>...</rwcal:volumes>
  </rwcal:vdu-init-params>
  <rwcal:vdu-modify-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:vdu-id>STRING</rwcal:vdu-id>
    <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
    <rwcal:type>VIRTIO</rwcal:type>
    <rwcal:image-id>STRING</rwcal:image-id>
    <rwcal:connection-points-add>...</rwcal:connection-points-add>
    <rwcal:connection-points-remove>...</rwcal:connection-points-remove>
  </rwcal:vdu-modify-params>
  <rwcal:vnf-resources xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
    <rwcal:virtual-link-info-list>...</rwcal:virtual-link-info-list>
    <rwcal:vdu-info-list>...</rwcal:vdu-info-list>
  </rwcal:vnf-resources>
  <vlr:vlr-catalog xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
    <vlr:vlr>...</vlr:vlr>
  </vlr:vlr-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>
  <vld:vld-catalog xmlns:vld="urn:ietf:params:xml:ns:yang:nfvo:vld">
    <vld:vld>...</vld:vld>
  </vld:vld-catalog>
  <rwsdnal:sdn-accounts xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
    <rwsdnal:sdn-account-list>...</rwsdnal:sdn-account-list>
  </rwsdnal:sdn-accounts>
  <rwsdnal:vnffgs xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
    <rwsdnal:vnffg-chain>...</rwsdnal:vnffg-chain>
  </rwsdnal:vnffgs>
  <rwsdnal:vnffg-rendered-paths xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
    <rwsdnal:vnffg-rendered-path>...</rwsdnal:vnffg-rendered-path>
  </rwsdnal:vnffg-rendered-paths>
  <rwsdnal:vnffg-classifiers xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
    <rwsdnal:vnffg-classifier>...</rwsdnal:vnffg-classifier>
  </rwsdnal:vnffg-classifiers>
  <rw-sdn:sdn xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
    <rw-sdn:account>...</rw-sdn:account>
  </rw-sdn:sdn>
  <rw-cloud:cloud xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
    <rw-cloud:account>...</rw-cloud:account>
  </rw-cloud:cloud>
</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>

rwcal:cloud-accounts

Key Identifiers:

XPath Path	/rw-project:project/rwcal:cloud-accounts
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts
RW.REST URI Path	/rw-project:project/STRING/rwcal:cloud-accounts

Fields

Name	Type	Description
cloud-account-list	LIST

JSON Config Sample

{
  "cloud-account-list": [
    {
      "name": "STRING",
      "account-type": "aws",
      "mock": { ... },
      "aws": { ... },
      "openstack": { ... },
      "openmano": { ... },
      "vsphere": { ... },
      "cloudsim": { ... },
      "cloudsim_proxy": { ... },
      "openvim": { ... },
      "prop_cloud1": { ... },
      "vdu-instance-timeout": 300
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "cloud-account-list": [
    {
      "name": "STRING",
      "account-type": "aws",
      "mock": { ... },
      "aws": { ... },
      "openstack": { ... },
      "openmano": { ... },
      "vsphere": { ... },
      "cloudsim": { ... },
      "cloudsim_proxy": { ... },
      "openvim": { ... },
      "prop_cloud1": { ... },
      "vdu-instance-timeout": 300
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwcal:cloud-accounts xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:cloud-account-list>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:account-type>aws</rwcal:account-type>
    <rwcal:mock>...</rwcal:mock>
    <rwcal:aws>...</rwcal:aws>
    <rwcal:openstack>...</rwcal:openstack>
    <rwcal:openmano>...</rwcal:openmano>
    <rwcal:vsphere>...</rwcal:vsphere>
    <rwcal:cloudsim>...</rwcal:cloudsim>
    <rwcal:cloudsim_proxy>...</rwcal:cloudsim_proxy>
    <rwcal:openvim>...</rwcal:openvim>
    <rwcal:prop_cloud1>...</rwcal:prop_cloud1>
    <rwcal:vdu-instance-timeout>300</rwcal:vdu-instance-timeout>
  </rwcal:cloud-account-list>
</rwcal:cloud-accounts>

XML Sample

<rwcal:cloud-accounts xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:cloud-account-list>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:account-type>aws</rwcal:account-type>
    <rwcal:mock>...</rwcal:mock>
    <rwcal:aws>...</rwcal:aws>
    <rwcal:openstack>...</rwcal:openstack>
    <rwcal:openmano>...</rwcal:openmano>
    <rwcal:vsphere>...</rwcal:vsphere>
    <rwcal:cloudsim>...</rwcal:cloudsim>
    <rwcal:cloudsim_proxy>...</rwcal:cloudsim_proxy>
    <rwcal:openvim>...</rwcal:openvim>
    <rwcal:prop_cloud1>...</rwcal:prop_cloud1>
    <rwcal:vdu-instance-timeout>300</rwcal:vdu-instance-timeout>
  </rwcal:cloud-account-list>
</rwcal:cloud-accounts>

rwcal:cloud-account-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING

Fields

Name	Type	Description
name	STRING
account-type	ENUM
mock	CONTAINER
aws	CONTAINER
openstack	CONTAINER
openmano	CONTAINER
vsphere	CONTAINER
cloudsim	CONTAINER
cloudsim_proxy	CONTAINER
openvim	CONTAINER
prop_cloud1	CONTAINER
vdu-instance-timeout	UINT64	VDU instantiation timeout

JSON Config Sample

[
  {
    "name": "STRING",
    "account-type": "aws",
    "mock": {
      "username": "STRING",
      "plugin-name": "rwcal_mock",
      "dynamic-flavor-support": true
    },
    "aws": {
      "key": "STRING",
      "secret": "STRING",
      "region": "STRING",
      "vpcid": "STRING",
      "ssh-key": "STRING",
      "availability-zone": "STRING",
      "default-subnet-id": "STRING",
      "plugin-name": "rwcal_aws",
      "dynamic-flavor-support": true
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "user-domain": "Default",
      "project-domain": "Default",
      "tenant": "STRING",
      "region": "RegionOne",
      "admin": false,
      "mgmt-network": "STRING",
      "plugin-name": "rwcal_openstack",
      "security-groups": [ "STRING", ... ],
      "dynamic-flavor-support": true,
      "floating-ip-pool": "STRING",
      "cert-validate": false
    },
    "openmano": {
      "host": "localhost",
      "port": 9090,
      "tenant-id": "STRING",
      "plugin-name": "rwcal_openmano"
    },
    "vsphere": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwcal-python",
      "dynamic-flavor-support": false
    },
    "cloudsim": {
      "plugin-name": "rwcal_cloudsim",
      "dynamic-flavor-support": true
    },
    "cloudsim_proxy": {
      "host": "localhost",
      "plugin-name": "rwcal_cloudsimproxy",
      "dynamic-flavor-support": true
    },
    "openvim": {
      "host": "STRING",
      "port": 9080,
      "tenant-name": "STRING",
      "mgmt-network": "STRING",
      "plugin-name": "rwcal_openmano_vimconnector",
      "dynamic-flavor-support": true,
      "image-management": { ... }
    },
    "prop_cloud1": {
      "host": "STRING",
      "username": "STRING",
      "password": "STRING",
      "mgmt-network": "STRING",
      "public-ip-pool": "STRING",
      "wan-interface": "STRING",
      "firewall": "STRING",
      "plugin-name": "rwcal_brocade",
      "dynamic-flavor-support": true
    },
    "vdu-instance-timeout": 300
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "account-type": "aws",
    "mock": {
      "username": "STRING",
      "plugin-name": "rwcal_mock",
      "dynamic-flavor-support": true
    },
    "aws": {
      "key": "STRING",
      "secret": "STRING",
      "region": "STRING",
      "vpcid": "STRING",
      "ssh-key": "STRING",
      "availability-zone": "STRING",
      "default-subnet-id": "STRING",
      "plugin-name": "rwcal_aws",
      "dynamic-flavor-support": true
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "user-domain": "Default",
      "project-domain": "Default",
      "tenant": "STRING",
      "region": "RegionOne",
      "admin": false,
      "mgmt-network": "STRING",
      "plugin-name": "rwcal_openstack",
      "security-groups": [ "STRING", ... ],
      "dynamic-flavor-support": true,
      "floating-ip-pool": "STRING",
      "cert-validate": false
    },
    "openmano": {
      "host": "localhost",
      "port": 9090,
      "tenant-id": "STRING",
      "plugin-name": "rwcal_openmano"
    },
    "vsphere": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwcal-python",
      "dynamic-flavor-support": false
    },
    "cloudsim": {
      "plugin-name": "rwcal_cloudsim",
      "dynamic-flavor-support": true
    },
    "cloudsim_proxy": {
      "host": "localhost",
      "plugin-name": "rwcal_cloudsimproxy",
      "dynamic-flavor-support": true
    },
    "openvim": {
      "host": "STRING",
      "port": 9080,
      "tenant-name": "STRING",
      "mgmt-network": "STRING",
      "plugin-name": "rwcal_openmano_vimconnector",
      "dynamic-flavor-support": true,
      "image-management": { ... }
    },
    "prop_cloud1": {
      "host": "STRING",
      "username": "STRING",
      "password": "STRING",
      "mgmt-network": "STRING",
      "public-ip-pool": "STRING",
      "wan-interface": "STRING",
      "firewall": "STRING",
      "plugin-name": "rwcal_brocade",
      "dynamic-flavor-support": true
    },
    "vdu-instance-timeout": 300
  }, {
    ...
  }
]

XML Config Sample

<rwcal:cloud-account-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:account-type>aws</rwcal:account-type>
  <rwcal:mock>
    <rwcal:username>STRING</rwcal:username>
    <rwcal:plugin-name>rwcal_mock</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:mock>
  <rwcal:aws>
    <rwcal:key>STRING</rwcal:key>
    <rwcal:secret>STRING</rwcal:secret>
    <rwcal:region>STRING</rwcal:region>
    <rwcal:vpcid>STRING</rwcal:vpcid>
    <rwcal:ssh-key>STRING</rwcal:ssh-key>
    <rwcal:availability-zone>STRING</rwcal:availability-zone>
    <rwcal:default-subnet-id>STRING</rwcal:default-subnet-id>
    <rwcal:plugin-name>rwcal_aws</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:aws>
  <rwcal:openstack>
    <rwcal:key>STRING</rwcal:key>
    <rwcal:secret>STRING</rwcal:secret>
    <rwcal:auth_url>STRING</rwcal:auth_url>
    <rwcal:user-domain>Default</rwcal:user-domain>
    <rwcal:project-domain>Default</rwcal:project-domain>
    <rwcal:tenant>STRING</rwcal:tenant>
    <rwcal:region>RegionOne</rwcal:region>
    <rwcal:admin>false</rwcal:admin>
    <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
    <rwcal:plugin-name>rwcal_openstack</rwcal:plugin-name>
    <rwcal:security-groups>STRING</rwcal:security-groups>
    <rwcal:security-groups>...</rwcal:security-groups>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
    <rwcal:floating-ip-pool>STRING</rwcal:floating-ip-pool>
    <rwcal:cert-validate>false</rwcal:cert-validate>
  </rwcal:openstack>
  <rwcal:openmano>
    <rwcal:host>localhost</rwcal:host>
    <rwcal:port>9090</rwcal:port>
    <rwcal:tenant-id>STRING</rwcal:tenant-id>
    <rwcal:plugin-name>rwcal_openmano</rwcal:plugin-name>
  </rwcal:openmano>
  <rwcal:vsphere>
    <rwcal:username>STRING</rwcal:username>
    <rwcal:password>STRING</rwcal:password>
    <rwcal:url>STRING</rwcal:url>
    <rwcal:plugin-name>rwcal-python</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>false</rwcal:dynamic-flavor-support>
  </rwcal:vsphere>
  <rwcal:cloudsim>
    <rwcal:plugin-name>rwcal_cloudsim</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:cloudsim>
  <rwcal:cloudsim_proxy>
    <rwcal:host>localhost</rwcal:host>
    <rwcal:plugin-name>rwcal_cloudsimproxy</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:cloudsim_proxy>
  <rwcal:openvim>
    <rwcal:host>STRING</rwcal:host>
    <rwcal:port>9080</rwcal:port>
    <rwcal:tenant-name>STRING</rwcal:tenant-name>
    <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
    <rwcal:plugin-name>rwcal_openmano_vimconnector</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
    <rwcal:image-management>...</rwcal:image-management>
  </rwcal:openvim>
  <rwcal:prop_cloud1>
    <rwcal:host>STRING</rwcal:host>
    <rwcal:username>STRING</rwcal:username>
    <rwcal:password>STRING</rwcal:password>
    <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
    <rwcal:public-ip-pool>STRING</rwcal:public-ip-pool>
    <rwcal:wan-interface>STRING</rwcal:wan-interface>
    <rwcal:firewall>STRING</rwcal:firewall>
    <rwcal:plugin-name>rwcal_brocade</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:prop_cloud1>
  <rwcal:vdu-instance-timeout>300</rwcal:vdu-instance-timeout>
</rwcal:cloud-account-list>

XML Sample

<rwcal:cloud-account-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:account-type>aws</rwcal:account-type>
  <rwcal:mock>
    <rwcal:username>STRING</rwcal:username>
    <rwcal:plugin-name>rwcal_mock</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:mock>
  <rwcal:aws>
    <rwcal:key>STRING</rwcal:key>
    <rwcal:secret>STRING</rwcal:secret>
    <rwcal:region>STRING</rwcal:region>
    <rwcal:vpcid>STRING</rwcal:vpcid>
    <rwcal:ssh-key>STRING</rwcal:ssh-key>
    <rwcal:availability-zone>STRING</rwcal:availability-zone>
    <rwcal:default-subnet-id>STRING</rwcal:default-subnet-id>
    <rwcal:plugin-name>rwcal_aws</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:aws>
  <rwcal:openstack>
    <rwcal:key>STRING</rwcal:key>
    <rwcal:secret>STRING</rwcal:secret>
    <rwcal:auth_url>STRING</rwcal:auth_url>
    <rwcal:user-domain>Default</rwcal:user-domain>
    <rwcal:project-domain>Default</rwcal:project-domain>
    <rwcal:tenant>STRING</rwcal:tenant>
    <rwcal:region>RegionOne</rwcal:region>
    <rwcal:admin>false</rwcal:admin>
    <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
    <rwcal:plugin-name>rwcal_openstack</rwcal:plugin-name>
    <rwcal:security-groups>STRING</rwcal:security-groups>
    <rwcal:security-groups>...</rwcal:security-groups>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
    <rwcal:floating-ip-pool>STRING</rwcal:floating-ip-pool>
    <rwcal:cert-validate>false</rwcal:cert-validate>
  </rwcal:openstack>
  <rwcal:openmano>
    <rwcal:host>localhost</rwcal:host>
    <rwcal:port>9090</rwcal:port>
    <rwcal:tenant-id>STRING</rwcal:tenant-id>
    <rwcal:plugin-name>rwcal_openmano</rwcal:plugin-name>
  </rwcal:openmano>
  <rwcal:vsphere>
    <rwcal:username>STRING</rwcal:username>
    <rwcal:password>STRING</rwcal:password>
    <rwcal:url>STRING</rwcal:url>
    <rwcal:plugin-name>rwcal-python</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>false</rwcal:dynamic-flavor-support>
  </rwcal:vsphere>
  <rwcal:cloudsim>
    <rwcal:plugin-name>rwcal_cloudsim</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:cloudsim>
  <rwcal:cloudsim_proxy>
    <rwcal:host>localhost</rwcal:host>
    <rwcal:plugin-name>rwcal_cloudsimproxy</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:cloudsim_proxy>
  <rwcal:openvim>
    <rwcal:host>STRING</rwcal:host>
    <rwcal:port>9080</rwcal:port>
    <rwcal:tenant-name>STRING</rwcal:tenant-name>
    <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
    <rwcal:plugin-name>rwcal_openmano_vimconnector</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
    <rwcal:image-management>...</rwcal:image-management>
  </rwcal:openvim>
  <rwcal:prop_cloud1>
    <rwcal:host>STRING</rwcal:host>
    <rwcal:username>STRING</rwcal:username>
    <rwcal:password>STRING</rwcal:password>
    <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
    <rwcal:public-ip-pool>STRING</rwcal:public-ip-pool>
    <rwcal:wan-interface>STRING</rwcal:wan-interface>
    <rwcal:firewall>STRING</rwcal:firewall>
    <rwcal:plugin-name>rwcal_brocade</rwcal:plugin-name>
    <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  </rwcal:prop_cloud1>
  <rwcal:vdu-instance-timeout>300</rwcal:vdu-instance-timeout>
</rwcal:cloud-account-list>

rwcal:mock

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:mock

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:mock

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/mock

Fields

Name	Type	Description
username	STRING
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "username": "STRING",
  "plugin-name": "rwcal_mock",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "username": "STRING",
  "plugin-name": "rwcal_mock",
  "dynamic-flavor-support": true
}

XML Config Sample

<rwcal:mock xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:username>STRING</rwcal:username>
  <rwcal:plugin-name>rwcal_mock</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:mock>

XML Sample

<rwcal:mock xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:username>STRING</rwcal:username>
  <rwcal:plugin-name>rwcal_mock</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:mock>

rwcal:aws

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:aws

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:aws

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/aws

Fields

Name	Type	Description
key	STRING
secret	STRING
region	STRING
vpcid	STRING	VPC ID to use to instantiate EC2 instances
ssh-key	STRING	Key pair name to connect to EC2 instance
availability-zone	STRING	Availability zone where EC2 instance should be started
default-subnet-id	STRING	Default subnet ID to create network interface at instance creation time
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "key": "STRING",
  "secret": "STRING",
  "region": "STRING",
  "vpcid": "STRING",
  "ssh-key": "STRING",
  "availability-zone": "STRING",
  "default-subnet-id": "STRING",
  "plugin-name": "rwcal_aws",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "key": "STRING",
  "secret": "STRING",
  "region": "STRING",
  "vpcid": "STRING",
  "ssh-key": "STRING",
  "availability-zone": "STRING",
  "default-subnet-id": "STRING",
  "plugin-name": "rwcal_aws",
  "dynamic-flavor-support": true
}

XML Config Sample

<rwcal:aws xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:key>STRING</rwcal:key>
  <rwcal:secret>STRING</rwcal:secret>
  <rwcal:region>STRING</rwcal:region>
  <rwcal:vpcid>STRING</rwcal:vpcid>
  <rwcal:ssh-key>STRING</rwcal:ssh-key>
  <rwcal:availability-zone>STRING</rwcal:availability-zone>
  <rwcal:default-subnet-id>STRING</rwcal:default-subnet-id>
  <rwcal:plugin-name>rwcal_aws</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:aws>

XML Sample

<rwcal:aws xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:key>STRING</rwcal:key>
  <rwcal:secret>STRING</rwcal:secret>
  <rwcal:region>STRING</rwcal:region>
  <rwcal:vpcid>STRING</rwcal:vpcid>
  <rwcal:ssh-key>STRING</rwcal:ssh-key>
  <rwcal:availability-zone>STRING</rwcal:availability-zone>
  <rwcal:default-subnet-id>STRING</rwcal:default-subnet-id>
  <rwcal:plugin-name>rwcal_aws</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:aws>

rwcal:openstack

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:openstack

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:openstack

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/openstack

Fields

Name	Type	Description
key	STRING
secret	STRING
auth_url	STRING
user-domain	STRING	Domain of the OpenStack user
project-domain	STRING	Domain of the OpenStack project
tenant	STRING
region	STRING
admin	BOOLEAN
mgmt-network	STRING
plugin-name	STRING
security-groups	LEAF_LIST	Names of the security groups for the VM
dynamic-flavor-support	BOOLEAN
floating-ip-pool	STRING	Name of floating IP pool to use for floating IP address assignement
cert-validate	BOOLEAN	Certificate validatation policy in case of SSL/TLS connection

JSON Config Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "user-domain": "Default",
  "project-domain": "Default",
  "tenant": "STRING",
  "region": "RegionOne",
  "admin": false,
  "mgmt-network": "STRING",
  "plugin-name": "rwcal_openstack",
  "security-groups": [ "STRING", ... ],
  "dynamic-flavor-support": true,
  "floating-ip-pool": "STRING",
  "cert-validate": false
}

JSON Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "user-domain": "Default",
  "project-domain": "Default",
  "tenant": "STRING",
  "region": "RegionOne",
  "admin": false,
  "mgmt-network": "STRING",
  "plugin-name": "rwcal_openstack",
  "security-groups": [ "STRING", ... ],
  "dynamic-flavor-support": true,
  "floating-ip-pool": "STRING",
  "cert-validate": false
}

XML Config Sample

<rwcal:openstack xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:key>STRING</rwcal:key>
  <rwcal:secret>STRING</rwcal:secret>
  <rwcal:auth_url>STRING</rwcal:auth_url>
  <rwcal:user-domain>Default</rwcal:user-domain>
  <rwcal:project-domain>Default</rwcal:project-domain>
  <rwcal:tenant>STRING</rwcal:tenant>
  <rwcal:region>RegionOne</rwcal:region>
  <rwcal:admin>false</rwcal:admin>
  <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
  <rwcal:plugin-name>rwcal_openstack</rwcal:plugin-name>
  <rwcal:security-groups>STRING</rwcal:security-groups>
  <rwcal:security-groups>...</rwcal:security-groups>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  <rwcal:floating-ip-pool>STRING</rwcal:floating-ip-pool>
  <rwcal:cert-validate>false</rwcal:cert-validate>
</rwcal:openstack>

XML Sample

<rwcal:openstack xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:key>STRING</rwcal:key>
  <rwcal:secret>STRING</rwcal:secret>
  <rwcal:auth_url>STRING</rwcal:auth_url>
  <rwcal:user-domain>Default</rwcal:user-domain>
  <rwcal:project-domain>Default</rwcal:project-domain>
  <rwcal:tenant>STRING</rwcal:tenant>
  <rwcal:region>RegionOne</rwcal:region>
  <rwcal:admin>false</rwcal:admin>
  <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
  <rwcal:plugin-name>rwcal_openstack</rwcal:plugin-name>
  <rwcal:security-groups>STRING</rwcal:security-groups>
  <rwcal:security-groups>...</rwcal:security-groups>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  <rwcal:floating-ip-pool>STRING</rwcal:floating-ip-pool>
  <rwcal:cert-validate>false</rwcal:cert-validate>
</rwcal:openstack>

rwcal:security-groups

Names of the security groups for the VM

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:openstack/rwcal:security-groups

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:openstack/rwcal:security-groups

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/openstack/security-groups

JSON Config Sample

[ "STRING", ... ]

JSON Sample

[ "STRING", ... ]

XML Config Sample

<rwcal:security-groups xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">STRING</rwcal:security-groups>
<rwcal:security-groups xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">...</rwcal:security-groups>

XML Sample

<rwcal:security-groups xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">STRING</rwcal:security-groups>
<rwcal:security-groups xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">...</rwcal:security-groups>

rwcal:openmano

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:openmano

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:openmano

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/openmano

Fields

Name	Type	Description
host	STRING
port	UINT16
tenant-id	STRING
plugin-name	STRING

JSON Config Sample

{
  "host": "localhost",
  "port": 9090,
  "tenant-id": "STRING",
  "plugin-name": "rwcal_openmano"
}

JSON Sample

{
  "host": "localhost",
  "port": 9090,
  "tenant-id": "STRING",
  "plugin-name": "rwcal_openmano"
}

XML Config Sample

<rwcal:openmano xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host>localhost</rwcal:host>
  <rwcal:port>9090</rwcal:port>
  <rwcal:tenant-id>STRING</rwcal:tenant-id>
  <rwcal:plugin-name>rwcal_openmano</rwcal:plugin-name>
</rwcal:openmano>

XML Sample

<rwcal:openmano xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host>localhost</rwcal:host>
  <rwcal:port>9090</rwcal:port>
  <rwcal:tenant-id>STRING</rwcal:tenant-id>
  <rwcal:plugin-name>rwcal_openmano</rwcal:plugin-name>
</rwcal:openmano>

rwcal:vsphere

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:vsphere

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:vsphere

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/vsphere

Fields

Name	Type	Description
username	STRING
password	STRING
url	STRING
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwcal-python",
  "dynamic-flavor-support": false
}

JSON Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwcal-python",
  "dynamic-flavor-support": false
}

XML Config Sample

<rwcal:vsphere xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:username>STRING</rwcal:username>
  <rwcal:password>STRING</rwcal:password>
  <rwcal:url>STRING</rwcal:url>
  <rwcal:plugin-name>rwcal-python</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>false</rwcal:dynamic-flavor-support>
</rwcal:vsphere>

XML Sample

<rwcal:vsphere xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:username>STRING</rwcal:username>
  <rwcal:password>STRING</rwcal:password>
  <rwcal:url>STRING</rwcal:url>
  <rwcal:plugin-name>rwcal-python</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>false</rwcal:dynamic-flavor-support>
</rwcal:vsphere>

rwcal:cloudsim

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:cloudsim

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:cloudsim

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/cloudsim

Fields

Name	Type	Description
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "plugin-name": "rwcal_cloudsim",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "plugin-name": "rwcal_cloudsim",
  "dynamic-flavor-support": true
}

XML Config Sample

<rwcal:cloudsim xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:plugin-name>rwcal_cloudsim</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:cloudsim>

XML Sample

<rwcal:cloudsim xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:plugin-name>rwcal_cloudsim</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:cloudsim>

rwcal:cloudsim_proxy

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:cloudsim_proxy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:cloudsim_proxy

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/cloudsim_proxy

Fields

Name	Type	Description
host	STRING
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "host": "localhost",
  "plugin-name": "rwcal_cloudsimproxy",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "host": "localhost",
  "plugin-name": "rwcal_cloudsimproxy",
  "dynamic-flavor-support": true
}

XML Config Sample

<rwcal:cloudsim_proxy xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host>localhost</rwcal:host>
  <rwcal:plugin-name>rwcal_cloudsimproxy</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:cloudsim_proxy>

XML Sample

<rwcal:cloudsim_proxy xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host>localhost</rwcal:host>
  <rwcal:plugin-name>rwcal_cloudsimproxy</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:cloudsim_proxy>

rwcal:openvim

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:openvim

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:openvim

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/openvim

Fields

Name	Type	Description
host	STRING
port	UINT16
tenant-name	STRING	Mandatory parameter to indicate openvim tenant name
mgmt-network	STRING
plugin-name	STRING
dynamic-flavor-support	BOOLEAN
image-management	CONTAINER	Information required for OpenVim image upload operation

JSON Config Sample

{
  "host": "STRING",
  "port": 9080,
  "tenant-name": "STRING",
  "mgmt-network": "STRING",
  "plugin-name": "rwcal_openmano_vimconnector",
  "dynamic-flavor-support": true,
  "image-management": {
    "username": "STRING",
    "password": "STRING",
    "image-directory-path": "/opt/VNF/images"
  }
}

JSON Sample

{
  "host": "STRING",
  "port": 9080,
  "tenant-name": "STRING",
  "mgmt-network": "STRING",
  "plugin-name": "rwcal_openmano_vimconnector",
  "dynamic-flavor-support": true,
  "image-management": {
    "username": "STRING",
    "password": "STRING",
    "image-directory-path": "/opt/VNF/images"
  }
}

XML Config Sample

<rwcal:openvim xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host>STRING</rwcal:host>
  <rwcal:port>9080</rwcal:port>
  <rwcal:tenant-name>STRING</rwcal:tenant-name>
  <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
  <rwcal:plugin-name>rwcal_openmano_vimconnector</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  <rwcal:image-management>
    <rwcal:username>STRING</rwcal:username>
    <rwcal:password>STRING</rwcal:password>
    <rwcal:image-directory-path>/opt/VNF/images</rwcal:image-directory-path>
  </rwcal:image-management>
</rwcal:openvim>

XML Sample

<rwcal:openvim xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host>STRING</rwcal:host>
  <rwcal:port>9080</rwcal:port>
  <rwcal:tenant-name>STRING</rwcal:tenant-name>
  <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
  <rwcal:plugin-name>rwcal_openmano_vimconnector</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
  <rwcal:image-management>
    <rwcal:username>STRING</rwcal:username>
    <rwcal:password>STRING</rwcal:password>
    <rwcal:image-directory-path>/opt/VNF/images</rwcal:image-directory-path>
  </rwcal:image-management>
</rwcal:openvim>

rwcal:image-management

Information required for OpenVim image upload operation

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:openvim/rwcal:image-management

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:openvim/rwcal:image-management

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/openvim/image-management

Fields

Name	Type	Description
username	STRING	Username for host access
password	STRING	Password for host access
image-directory-path	STRING	Name of the directory on the host where image needs to be copied

JSON Config Sample

{
  "username": "STRING",
  "password": "STRING",
  "image-directory-path": "/opt/VNF/images"
}

JSON Sample

{
  "username": "STRING",
  "password": "STRING",
  "image-directory-path": "/opt/VNF/images"
}

XML Config Sample

<rwcal:image-management xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:username>STRING</rwcal:username>
  <rwcal:password>STRING</rwcal:password>
  <rwcal:image-directory-path>/opt/VNF/images</rwcal:image-directory-path>
</rwcal:image-management>

XML Sample

<rwcal:image-management xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:username>STRING</rwcal:username>
  <rwcal:password>STRING</rwcal:password>
  <rwcal:image-directory-path>/opt/VNF/images</rwcal:image-directory-path>
</rwcal:image-management>

rwcal:prop_cloud1

Key Identifiers:

XPath Path

/rw-project:project/rwcal:cloud-accounts/rwcal:cloud-account-list/rwcal:prop_cloud1

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:cloud-accounts/rwcal:cloud-account-list[rwcal:name='STRING']/rwcal:prop_cloud1

RW.REST URI Path

/rw-project:project/STRING/rwcal:cloud-accounts/cloud-account-list/STRING/prop_cloud1

Fields

Name	Type	Description
host	STRING	This is a single-host cloud. IP address of host
username	STRING	Username to access host
password	STRING	Password for user
mgmt-network	STRING	Name of bridge used for management access to VMs on cloud
public-ip-pool	STRING	Public IP pool for VMs
wan-interface	STRING	WAN interface name
firewall	STRING	Firewall services
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "host": "STRING",
  "username": "STRING",
  "password": "STRING",
  "mgmt-network": "STRING",
  "public-ip-pool": "STRING",
  "wan-interface": "STRING",
  "firewall": "STRING",
  "plugin-name": "rwcal_brocade",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "host": "STRING",
  "username": "STRING",
  "password": "STRING",
  "mgmt-network": "STRING",
  "public-ip-pool": "STRING",
  "wan-interface": "STRING",
  "firewall": "STRING",
  "plugin-name": "rwcal_brocade",
  "dynamic-flavor-support": true
}

XML Config Sample

<rwcal:prop_cloud1 xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host>STRING</rwcal:host>
  <rwcal:username>STRING</rwcal:username>
  <rwcal:password>STRING</rwcal:password>
  <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
  <rwcal:public-ip-pool>STRING</rwcal:public-ip-pool>
  <rwcal:wan-interface>STRING</rwcal:wan-interface>
  <rwcal:firewall>STRING</rwcal:firewall>
  <rwcal:plugin-name>rwcal_brocade</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:prop_cloud1>

XML Sample

<rwcal:prop_cloud1 xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host>STRING</rwcal:host>
  <rwcal:username>STRING</rwcal:username>
  <rwcal:password>STRING</rwcal:password>
  <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
  <rwcal:public-ip-pool>STRING</rwcal:public-ip-pool>
  <rwcal:wan-interface>STRING</rwcal:wan-interface>
  <rwcal:firewall>STRING</rwcal:firewall>
  <rwcal:plugin-name>rwcal_brocade</rwcal:plugin-name>
  <rwcal:dynamic-flavor-support>true</rwcal:dynamic-flavor-support>
</rwcal:prop_cloud1>

rwcal:vim-resources

Key Identifiers:

XPath Path	/rw-project:project/rwcal:vim-resources
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources
RW.REST URI Path	/rw-project:project/STRING/rwcal:vim-resources

Fields

Name	Type	Description
vminfo-list	LIST
imageinfo-list	LIST
tenantinfo-list	LIST
userinfo-list	LIST
roleinfo-list	LIST
hostinfo-list	LIST
networkinfo-list	LIST
portinfo-list	LIST
flavorinfo-list	LIST

JSON Sample

{
  "vminfo-list": [
    {
      "vm-name": "STRING",
      "vm-size": "STRING",
      "vm-id": "STRING",
      "flavor-id": "STRING",
      "image-id": "STRING",
      "state": "STRING",
      "availability-zone": "STRING",
      "tenant-name": "STRING",
      "host-name": "STRING",
      "management-ip": "STRING",
      "public-ip": "STRING",
      "allocate-public-address": false,
      "private-ip-list": [ { ... }, { ... } ],
      "public-ip-list": [ { ... }, { ... } ],
      "port-list": [ { ... }, { ... } ],
      "network-list": [ { ... }, { ... } ],
      "cloud-init": { ... },
      "user_tags": { ... },
      "server-group": "STRING"
    }, {
      ...
    }
  ],
  "imageinfo-list": [
    {
      "id": "STRING",
      "name": "STRING",
      "location": "STRING",
      "fileno": 0,
      "checksum": "STRING",
      "virtual_size_mbytes": 0,
      "disk_format": "qcow2",
      "container_format": "bare",
      "state": "unknown",
      "user-tags": { ... },
      "properties": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "tenantinfo-list": [
    {
      "tenant-name": "STRING",
      "tenant-id": "STRING"
    }, {
      ...
    }
  ],
  "userinfo-list": [
    {
      "user-name": "STRING",
      "user-id": "STRING"
    }, {
      ...
    }
  ],
  "roleinfo-list": [
    {
      "role-name": "STRING",
      "role-id": "STRING"
    }, {
      ...
    }
  ],
  "hostinfo-list": [
    {
      "host-name": "STRING",
      "host-id": "STRING"
    }, {
      ...
    }
  ],
  "networkinfo-list": [
    {
      "network-name": "STRING",
      "network-id": "STRING",
      "subnet": "STRING",
      "provider-network": { ... }
    }, {
      ...
    }
  ],
  "portinfo-list": [
    {
      "port-name": "STRING",
      "port-id": "STRING",
      "port-state": "STRING",
      "network-id": "STRING",
      "ip-address": "STRING",
      "vm-id": "STRING",
      "port-type": "normal",
      "lxc": { ... }
    }, {
      ...
    }
  ],
  "flavorinfo-list": [
    {
      "id": "STRING",
      "name": "STRING",
      "vm-flavor": { ... },
      "guest-epa": { ... },
      "vswitch-epa": { ... },
      "hypervisor-epa": { ... },
      "host-epa": { ... },
      "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

<rwcal:vim-resources xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:vminfo-list>
    <rwcal:vm-id>STRING</rwcal:vm-id>
    <rwcal:vm-name>STRING</rwcal:vm-name>
    <rwcal:vm-size>STRING</rwcal:vm-size>
    <rwcal:flavor-id>STRING</rwcal:flavor-id>
    <rwcal:image-id>STRING</rwcal:image-id>
    <rwcal:state>STRING</rwcal:state>
    <rwcal:availability-zone>STRING</rwcal:availability-zone>
    <rwcal:tenant-name>STRING</rwcal:tenant-name>
    <rwcal:host-name>STRING</rwcal:host-name>
    <rwcal:management-ip>STRING</rwcal:management-ip>
    <rwcal:public-ip>STRING</rwcal:public-ip>
    <rwcal:allocate-public-address>false</rwcal:allocate-public-address>
    <rwcal:private-ip-list>...</rwcal:private-ip-list>
    <rwcal:public-ip-list>...</rwcal:public-ip-list>
    <rwcal:port-list>...</rwcal:port-list>
    <rwcal:network-list>...</rwcal:network-list>
    <rwcal:cloud-init>...</rwcal:cloud-init>
    <rwcal:user_tags>...</rwcal:user_tags>
    <rwcal:server-group>STRING</rwcal:server-group>
  </rwcal:vminfo-list>
  <rwcal:imageinfo-list>
    <rwcal:id>STRING</rwcal:id>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:location>STRING</rwcal:location>
    <rwcal:fileno>0</rwcal:fileno>
    <rwcal:checksum>STRING</rwcal:checksum>
    <rwcal:virtual_size_mbytes>0</rwcal:virtual_size_mbytes>
    <rwcal:disk_format>qcow2</rwcal:disk_format>
    <rwcal:container_format>bare</rwcal:container_format>
    <rwcal:state>unknown</rwcal:state>
    <rwcal:user-tags>...</rwcal:user-tags>
    <rwcal:properties>...</rwcal:properties>
  </rwcal:imageinfo-list>
  <rwcal:tenantinfo-list>
    <rwcal:tenant-id>STRING</rwcal:tenant-id>
    <rwcal:tenant-name>STRING</rwcal:tenant-name>
  </rwcal:tenantinfo-list>
  <rwcal:userinfo-list>
    <rwcal:user-id>STRING</rwcal:user-id>
    <rwcal:user-name>STRING</rwcal:user-name>
  </rwcal:userinfo-list>
  <rwcal:roleinfo-list>
    <rwcal:role-id>STRING</rwcal:role-id>
    <rwcal:role-name>STRING</rwcal:role-name>
  </rwcal:roleinfo-list>
  <rwcal:hostinfo-list>
    <rwcal:host-id>STRING</rwcal:host-id>
    <rwcal:host-name>STRING</rwcal:host-name>
  </rwcal:hostinfo-list>
  <rwcal:networkinfo-list>
    <rwcal:network-id>STRING</rwcal:network-id>
    <rwcal:network-name>STRING</rwcal:network-name>
    <rwcal:subnet>STRING</rwcal:subnet>
    <rwcal:provider-network>...</rwcal:provider-network>
  </rwcal:networkinfo-list>
  <rwcal:portinfo-list>
    <rwcal:port-id>STRING</rwcal:port-id>
    <rwcal:port-name>STRING</rwcal:port-name>
    <rwcal:port-state>STRING</rwcal:port-state>
    <rwcal:network-id>STRING</rwcal:network-id>
    <rwcal:ip-address>STRING</rwcal:ip-address>
    <rwcal:vm-id>STRING</rwcal:vm-id>
    <rwcal:port-type>normal</rwcal:port-type>
    <rwcal:lxc>...</rwcal:lxc>
  </rwcal:portinfo-list>
  <rwcal:flavorinfo-list>
    <rwcal:id>STRING</rwcal:id>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:vm-flavor>...</rwcal:vm-flavor>
    <rwcal:guest-epa>...</rwcal:guest-epa>
    <rwcal:vswitch-epa>...</rwcal:vswitch-epa>
    <rwcal:hypervisor-epa>...</rwcal:hypervisor-epa>
    <rwcal:host-epa>...</rwcal:host-epa>
    <rwcal:cloud-type>aws</rwcal:cloud-type>
    <rwcal:availability-zone>...</rwcal:availability-zone>
    <rwcal:server-group>...</rwcal:server-group>
    <rwcal:host-aggregate>...</rwcal:host-aggregate>
    <rwcal:aws-construct/>
    <rwcal:openmano-construct/>
    <rwcal:vsphere-construct/>
    <rwcal:mock-construct/>
    <rwcal:cloudsim-construct/>
  </rwcal:flavorinfo-list>
</rwcal:vim-resources>

rwcal:vminfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:vminfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:vminfo-list[rwcal:vm-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/vminfo-list/STRING

Fields

Name	Type	Description
vm-name	STRING
vm-size	STRING
vm-id	STRING
flavor-id	STRING
image-id	STRING
state	STRING
availability-zone	STRING
tenant-name	STRING
host-name	STRING
management-ip	STRING
public-ip	STRING
allocate-public-address	BOOLEAN	If this VM should allocate a floating public IP address
private-ip-list	LIST
public-ip-list	LIST
port-list	LIST
network-list	LIST
cloud-init	CONTAINER
user_tags	CONTAINER
server-group	STRING

JSON Sample

[
  {
    "vm-name": "STRING",
    "vm-size": "STRING",
    "vm-id": "STRING",
    "flavor-id": "STRING",
    "image-id": "STRING",
    "state": "STRING",
    "availability-zone": "STRING",
    "tenant-name": "STRING",
    "host-name": "STRING",
    "management-ip": "STRING",
    "public-ip": "STRING",
    "allocate-public-address": false,
    "private-ip-list": [
      {
        "ip-address": "STRING"
      }, {
        ...
      }
    ],
    "public-ip-list": [
      {
        "ip-address": "STRING"
      }, {
        ...
      }
    ],
    "port-list": [
      {
        "port-id": "STRING"
      }, {
        ...
      }
    ],
    "network-list": [
      {
        "network-id": "STRING"
      }, {
        ...
      }
    ],
    "cloud-init": {
      "userdata": "STRING"
    },
    "user_tags": {
      "node-id": "STRING",
      "pci_assignement": "STRING",
      "tag1": "STRING"
    },
    "server-group": "STRING"
  }, {
    ...
  }
]

XML Sample

<rwcal:vminfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:vm-id>STRING</rwcal:vm-id>
  <rwcal:vm-name>STRING</rwcal:vm-name>
  <rwcal:vm-size>STRING</rwcal:vm-size>
  <rwcal:flavor-id>STRING</rwcal:flavor-id>
  <rwcal:image-id>STRING</rwcal:image-id>
  <rwcal:state>STRING</rwcal:state>
  <rwcal:availability-zone>STRING</rwcal:availability-zone>
  <rwcal:tenant-name>STRING</rwcal:tenant-name>
  <rwcal:host-name>STRING</rwcal:host-name>
  <rwcal:management-ip>STRING</rwcal:management-ip>
  <rwcal:public-ip>STRING</rwcal:public-ip>
  <rwcal:allocate-public-address>false</rwcal:allocate-public-address>
  <rwcal:private-ip-list>
    <rwcal:ip-address>STRING</rwcal:ip-address>
  </rwcal:private-ip-list>
  <rwcal:public-ip-list>
    <rwcal:ip-address>STRING</rwcal:ip-address>
  </rwcal:public-ip-list>
  <rwcal:port-list>
    <rwcal:port-id>STRING</rwcal:port-id>
  </rwcal:port-list>
  <rwcal:network-list>
    <rwcal:network-id>STRING</rwcal:network-id>
  </rwcal:network-list>
  <rwcal:cloud-init>
    <rwcal:userdata>STRING</rwcal:userdata>
  </rwcal:cloud-init>
  <rwcal:user_tags>
    <rwcal:node-id>STRING</rwcal:node-id>
    <rwcal:pci_assignement>STRING</rwcal:pci_assignement>
    <rwcal:tag1>STRING</rwcal:tag1>
  </rwcal:user_tags>
  <rwcal:server-group>STRING</rwcal:server-group>
</rwcal:vminfo-list>

rwcal:private-ip-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:vminfo-list/rwcal:private-ip-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:vminfo-list[rwcal:vm-id='STRING']/rwcal:private-ip-list[rwcal:ip-address='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/vminfo-list/STRING/private-ip-list/STRING

Fields

Name	Type	Description
ip-address	STRING

JSON Sample

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

XML Sample

<rwcal:private-ip-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:ip-address>STRING</rwcal:ip-address>
</rwcal:private-ip-list>

rwcal:public-ip-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:vminfo-list/rwcal:public-ip-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:vminfo-list[rwcal:vm-id='STRING']/rwcal:public-ip-list[rwcal:ip-address='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/vminfo-list/STRING/public-ip-list/STRING

Fields

Name	Type	Description
ip-address	STRING

JSON Sample

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

XML Sample

<rwcal:public-ip-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:ip-address>STRING</rwcal:ip-address>
</rwcal:public-ip-list>

rwcal:port-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:vminfo-list/rwcal:port-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:vminfo-list[rwcal:vm-id='STRING']/rwcal:port-list[rwcal:port-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/vminfo-list/STRING/port-list/STRING

Fields

Name	Type	Description
port-id	STRING

JSON Sample

[
  {
    "port-id": "STRING"
  }, {
    ...
  }
]

XML Sample

<rwcal:port-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:port-id>STRING</rwcal:port-id>
</rwcal:port-list>

rwcal:network-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:vminfo-list/rwcal:network-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:vminfo-list[rwcal:vm-id='STRING']/rwcal:network-list[rwcal:network-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/vminfo-list/STRING/network-list/STRING

Fields

Name	Type	Description
network-id	STRING

JSON Sample

[
  {
    "network-id": "STRING"
  }, {
    ...
  }
]

XML Sample

<rwcal:network-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:network-id>STRING</rwcal:network-id>
</rwcal:network-list>

rwcal:cloud-init

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:vminfo-list/rwcal:cloud-init

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:vminfo-list[rwcal:vm-id='STRING']/rwcal:cloud-init

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/vminfo-list/STRING/cloud-init

Fields

Name	Type	Description
userdata	STRING	The userdata field for cloud-init should contain the contents of the script that cloud-init should invoke when configuring the system. Note that this script is expected to be in the cloud-config format

JSON Sample

{
  "userdata": "STRING"
}

XML Sample

<rwcal:cloud-init xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:userdata>STRING</rwcal:userdata>
</rwcal:cloud-init>

rwcal:user_tags

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:vminfo-list/rwcal:user_tags

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:vminfo-list[rwcal:vm-id='STRING']/rwcal:user_tags

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/vminfo-list/STRING/user_tags

Fields

Name	Type	Description
node-id	STRING
pci_assignement	STRING
tag1	STRING

JSON Sample

{
  "node-id": "STRING",
  "pci_assignement": "STRING",
  "tag1": "STRING"
}

XML Sample

<rwcal:user_tags xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:node-id>STRING</rwcal:node-id>
  <rwcal:pci_assignement>STRING</rwcal:pci_assignement>
  <rwcal:tag1>STRING</rwcal:tag1>
</rwcal:user_tags>

rwcal:imageinfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:imageinfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:imageinfo-list[rwcal:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/imageinfo-list/STRING

Fields

Name	Type	Description
id	STRING
name	STRING
location	STRING	Image URL location
fileno	UINT32	Image file descriptor
checksum	STRING
virtual_size_mbytes	UINT64	Virtual size of the image
disk_format	STRING	Format of the Disk
container_format	STRING	Format of the container
state	ENUM	State of the Image object in CAL
user-tags	CONTAINER	User tags associated with Image
properties	LIST

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "location": "STRING",
    "fileno": 0,
    "checksum": "STRING",
    "virtual_size_mbytes": 0,
    "disk_format": "qcow2",
    "container_format": "bare",
    "state": "unknown",
    "user-tags": {
      "checksum": "STRING"
    },
    "properties": [
      {
        "name": "STRING",
        "property_value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rwcal:imageinfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:id>STRING</rwcal:id>
  <rwcal:name>STRING</rwcal:name>
  <rwcal:location>STRING</rwcal:location>
  <rwcal:fileno>0</rwcal:fileno>
  <rwcal:checksum>STRING</rwcal:checksum>
  <rwcal:virtual_size_mbytes>0</rwcal:virtual_size_mbytes>
  <rwcal:disk_format>qcow2</rwcal:disk_format>
  <rwcal:container_format>bare</rwcal:container_format>
  <rwcal:state>unknown</rwcal:state>
  <rwcal:user-tags>
    <rwcal:checksum>STRING</rwcal:checksum>
  </rwcal:user-tags>
  <rwcal:properties>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:property_value>STRING</rwcal:property_value>
  </rwcal:properties>
</rwcal:imageinfo-list>

rwcal:user-tags

User tags associated with Image

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:imageinfo-list/rwcal:user-tags

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:imageinfo-list[rwcal:id='STRING']/rwcal:user-tags

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/imageinfo-list/STRING/user-tags

Fields

Name	Type	Description
checksum	STRING

JSON Sample

{
  "checksum": "STRING"
}

XML Sample

<rwcal:user-tags xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:checksum>STRING</rwcal:checksum>
</rwcal:user-tags>

rwcal:properties

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:imageinfo-list/rwcal:properties

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:imageinfo-list[rwcal:id='STRING']/rwcal:properties[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/imageinfo-list/STRING/properties/STRING

Fields

Name	Type	Description
name	STRING	Name of the image property
property_value	STRING	Value of the image property

JSON Sample

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

XML Sample

<rwcal:properties xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:property_value>STRING</rwcal:property_value>
</rwcal:properties>

rwcal:tenantinfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:tenantinfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:tenantinfo-list[rwcal:tenant-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/tenantinfo-list/STRING

Fields

Name	Type	Description
tenant-name	STRING
tenant-id	STRING

JSON Sample

[
  {
    "tenant-name": "STRING",
    "tenant-id": "STRING"
  }, {
    ...
  }
]

XML Sample

<rwcal:tenantinfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:tenant-id>STRING</rwcal:tenant-id>
  <rwcal:tenant-name>STRING</rwcal:tenant-name>
</rwcal:tenantinfo-list>

rwcal:userinfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:userinfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:userinfo-list[rwcal:user-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/userinfo-list/STRING

Fields

Name	Type	Description
user-name	STRING
user-id	STRING

JSON Sample

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

XML Sample

<rwcal:userinfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:user-id>STRING</rwcal:user-id>
  <rwcal:user-name>STRING</rwcal:user-name>
</rwcal:userinfo-list>

rwcal:roleinfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:roleinfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:roleinfo-list[rwcal:role-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/roleinfo-list/STRING

Fields

Name	Type	Description
role-name	STRING
role-id	STRING

JSON Sample

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

XML Sample

<rwcal:roleinfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:role-id>STRING</rwcal:role-id>
  <rwcal:role-name>STRING</rwcal:role-name>
</rwcal:roleinfo-list>

rwcal:hostinfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:hostinfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:hostinfo-list[rwcal:host-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/hostinfo-list/STRING

Fields

Name	Type	Description
host-name	STRING
host-id	STRING

JSON Sample

[
  {
    "host-name": "STRING",
    "host-id": "STRING"
  }, {
    ...
  }
]

XML Sample

<rwcal:hostinfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:host-id>STRING</rwcal:host-id>
  <rwcal:host-name>STRING</rwcal:host-name>
</rwcal:hostinfo-list>

rwcal:networkinfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:networkinfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:networkinfo-list[rwcal:network-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/networkinfo-list/STRING

Fields

Name	Type	Description
network-name	STRING
network-id	STRING
subnet	STRING
provider-network	CONTAINER	Container for the provider network.

JSON Sample

[
  {
    "network-name": "STRING",
    "network-id": "STRING",
    "subnet": "STRING",
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "segmentation_id": 0
    }
  }, {
    ...
  }
]

XML Sample

<rwcal:networkinfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:network-id>STRING</rwcal:network-id>
  <rwcal:network-name>STRING</rwcal:network-name>
  <rwcal:subnet>STRING</rwcal:subnet>
  <rwcal:provider-network>
    <rwcal:physical-network>STRING</rwcal:physical-network>
    <rwcal:overlay-type>LOCAL</rwcal:overlay-type>
    <rwcal:segmentation_id>0</rwcal:segmentation_id>
  </rwcal:provider-network>
</rwcal:networkinfo-list>

rwcal:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:networkinfo-list/rwcal:provider-network

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:networkinfo-list[rwcal:network-id='STRING']/rwcal:provider-network

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/networkinfo-list/STRING/provider-network

Fields

Name	Type	Description
physical-network	STRING	Name of the physical network on which the provider network is built.
overlay-type	ENUM	Type of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels PORTGROUP - Provider networks implemented for VIO support
segmentation_id	UINT32	ID of segregated virtual networks

JSON Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

XML Sample

<rwcal:provider-network xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:physical-network>STRING</rwcal:physical-network>
  <rwcal:overlay-type>LOCAL</rwcal:overlay-type>
  <rwcal:segmentation_id>0</rwcal:segmentation_id>
</rwcal:provider-network>

rwcal:portinfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:portinfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:portinfo-list[rwcal:port-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/portinfo-list/STRING

Fields

Name	Type	Description
port-name	STRING
port-id	STRING
port-state	STRING
network-id	STRING
ip-address	STRING
vm-id	STRING
port-type	ENUM	Type of the port
lxc	CONTAINER

JSON Sample

[
  {
    "port-name": "STRING",
    "port-id": "STRING",
    "port-state": "STRING",
    "network-id": "STRING",
    "ip-address": "STRING",
    "vm-id": "STRING",
    "port-type": "normal",
    "lxc": {
      "veth-name": "STRING"
    }
  }, {
    ...
  }
]

XML Sample

<rwcal:portinfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:port-id>STRING</rwcal:port-id>
  <rwcal:port-name>STRING</rwcal:port-name>
  <rwcal:port-state>STRING</rwcal:port-state>
  <rwcal:network-id>STRING</rwcal:network-id>
  <rwcal:ip-address>STRING</rwcal:ip-address>
  <rwcal:vm-id>STRING</rwcal:vm-id>
  <rwcal:port-type>normal</rwcal:port-type>
  <rwcal:lxc>
    <rwcal:veth-name>STRING</rwcal:veth-name>
  </rwcal:lxc>
</rwcal:portinfo-list>

rwcal:lxc

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:portinfo-list/rwcal:lxc

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:portinfo-list[rwcal:port-id='STRING']/rwcal:lxc

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/portinfo-list/STRING/lxc

Fields

Name	Type	Description
veth-name	STRING

JSON Sample

{
  "veth-name": "STRING"
}

XML Sample

<rwcal:lxc xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:veth-name>STRING</rwcal:veth-name>
</rwcal:lxc>

rwcal:flavorinfo-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/STRING

Fields

Name	Type	Description
id	STRING
name	STRING
vm-flavor	CONTAINER
guest-epa	CONTAINER
vswitch-epa	CONTAINER
hypervisor-epa	CONTAINER
host-epa	CONTAINER	Specifies the host level EPA attributes.
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

[
  {
    "id": "STRING",
    "name": "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": [ { ... }, { ... } ]
    },
    "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

<rwcal:flavorinfo-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:id>STRING</rwcal:id>
  <rwcal:name>STRING</rwcal:name>
  <rwcal:vm-flavor>
    <rwcal:vcpu-count>0</rwcal:vcpu-count>
    <rwcal:memory-mb>0</rwcal:memory-mb>
    <rwcal:storage-gb>0</rwcal:storage-gb>
  </rwcal:vm-flavor>
  <rwcal:guest-epa>
    <rwcal:trusted-execution>true</rwcal:trusted-execution>
    <rwcal:mempage-size>LARGE</rwcal:mempage-size>
    <rwcal:cpu-pinning-policy>ANY</rwcal:cpu-pinning-policy>
    <rwcal:cpu-thread-pinning-policy>AVOID</rwcal:cpu-thread-pinning-policy>
    <rwcal:pcie-device>...</rwcal:pcie-device>
    <rwcal:numa-unaware/>
    <rwcal:numa-node-policy>...</rwcal:numa-node-policy>
  </rwcal:guest-epa>
  <rwcal:vswitch-epa>
    <rwcal:ovs-acceleration>MANDATORY</rwcal:ovs-acceleration>
    <rwcal:ovs-offload>MANDATORY</rwcal:ovs-offload>
  </rwcal:vswitch-epa>
  <rwcal:hypervisor-epa>
    <rwcal:type>PREFER_KVM</rwcal:type>
    <rwcal:version>STRING</rwcal:version>
  </rwcal:hypervisor-epa>
  <rwcal:host-epa>
    <rwcal:cpu-model>PREFER_WESTMERE</rwcal:cpu-model>
    <rwcal:cpu-arch>PREFER_X86</rwcal:cpu-arch>
    <rwcal:cpu-vendor>PREFER_INTEL</rwcal:cpu-vendor>
    <rwcal:cpu-socket-count>0</rwcal:cpu-socket-count>
    <rwcal:cpu-core-count>0</rwcal:cpu-core-count>
    <rwcal:cpu-core-thread-count>0</rwcal:cpu-core-thread-count>
    <rwcal:cpu-feature>...</rwcal:cpu-feature>
    <rwcal:om-cpu-model-string>STRING</rwcal:om-cpu-model-string>
    <rwcal:om-cpu-feature>...</rwcal:om-cpu-feature>
  </rwcal:host-epa>
  <rwcal:cloud-type>aws</rwcal:cloud-type>
  <rwcal:availability-zone>
    <rwcal:name>STRING</rwcal:name>
  </rwcal:availability-zone>
  <rwcal:server-group>
    <rwcal:name>STRING</rwcal:name>
  </rwcal:server-group>
  <rwcal:host-aggregate>
    <rwcal:metadata-key>STRING</rwcal:metadata-key>
    <rwcal:metadata-value>STRING</rwcal:metadata-value>
  </rwcal:host-aggregate>
  <rwcal:aws-construct/>
  <rwcal:openmano-construct/>
  <rwcal:vsphere-construct/>
  <rwcal:mock-construct/>
  <rwcal:cloudsim-construct/>
</rwcal:flavorinfo-list>

rwcal:vm-flavor

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:vm-flavor

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:vm-flavor

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:guest-epa

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:guest-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:guest-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:guest-epa/rwcal:pcie-device

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:guest-epa/rwcal:pcie-device[rwcal:device-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal: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/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:guest-epa/rwcal:numa-node-policy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:node

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:vcpu

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:vcpu[rwcal:id='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:paired-threads

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:paired-threads

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:paired-threads

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:paired-thread-ids

List of thread pairs to use in case of paired-thread NUMA

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:paired-threads/rwcal:paired-thread-ids

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:paired-threads/rwcal:paired-thread-ids[rwcal:thread-a='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:vswitch-epa

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:vswitch-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:vswitch-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:hypervisor-epa

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:hypervisor-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:hypervisor-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:host-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:host-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

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

rwcal:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:host-epa/rwcal:cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:host-epa/rwcal:cpu-feature[rwcal:feature='PREFER_AES']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/STRING/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

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

XML Sample

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

rwcal:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:host-epa/rwcal:om-cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:host-epa/rwcal:om-cpu-feature[rwcal:feature='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/STRING/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

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

XML Sample

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

rwcal:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:availability-zone

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:availability-zone

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

<rwcal:availability-zone xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
</rwcal:availability-zone>

rwcal:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:server-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:server-group

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

<rwcal:server-group xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
</rwcal:server-group>

rwcal:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vim-resources/rwcal:flavorinfo-list/rwcal:host-aggregate

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vim-resources/rwcal:flavorinfo-list[rwcal:id='STRING']/rwcal:host-aggregate[rwcal:metadata-key='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vim-resources/flavorinfo-list/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

<rwcal:host-aggregate xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:metadata-key>STRING</rwcal:metadata-key>
  <rwcal:metadata-value>STRING</rwcal:metadata-value>
</rwcal:host-aggregate>

rwcal:virtual-link-req-params

This object defines the parameters required to create a virtual-link

Key Identifiers:

XPath Path	/rw-project:project/rwcal:virtual-link-req-params
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:virtual-link-req-params
RW.REST URI Path	/rw-project:project/STRING/rwcal:virtual-link-req-params

Fields

Name	Type	Description
name	STRING	Name of the Virtual-Link
subnet	STRING
associate-public-ip	BOOLEAN
vim-network-name	STRING	Name of network in VIM account. This is used to indicate pre-provisioned network name in cloud account.
virtual-cps	LIST
provider-network	CONTAINER	Container for the provider network.
ip-profile-params	CONTAINER

JSON Config Sample

{
  "name": "STRING",
  "subnet": "STRING",
  "associate-public-ip": false,
  "vim-network-name": "STRING",
  "virtual-cps": [
    {
      "name": "STRING",
      "type": "VPORT",
      "security-group": "STRING",
      "port-security-enabled": true,
      "static-ip-address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "provider-network": {
    "physical-network": "STRING",
    "overlay-type": "LOCAL",
    "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"
  }
}

JSON Sample

{
  "name": "STRING",
  "subnet": "STRING",
  "associate-public-ip": false,
  "vim-network-name": "STRING",
  "virtual-cps": [
    {
      "name": "STRING",
      "type": "VPORT",
      "security-group": "STRING",
      "port-security-enabled": true,
      "static-ip-address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "provider-network": {
    "physical-network": "STRING",
    "overlay-type": "LOCAL",
    "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"
  }
}

XML Config Sample

<rwcal:virtual-link-req-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:subnet>STRING</rwcal:subnet>
  <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
  <rwcal:vim-network-name>STRING</rwcal:vim-network-name>
  <rwcal:virtual-cps>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:type>VPORT</rwcal:type>
    <rwcal:security-group>STRING</rwcal:security-group>
    <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
    <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
  </rwcal:virtual-cps>
  <rwcal:provider-network>
    <rwcal:physical-network>STRING</rwcal:physical-network>
    <rwcal:overlay-type>LOCAL</rwcal:overlay-type>
    <rwcal:segmentation_id>0</rwcal:segmentation_id>
  </rwcal:provider-network>
  <rwcal:ip-profile-params>
    <rwcal:ip-version>ipv4</rwcal:ip-version>
    <rwcal:subnet-address>UNION_VALUE</rwcal:subnet-address>
    <rwcal:gateway-address>UNION_VALUE</rwcal:gateway-address>
    <rwcal:security-group>STRING</rwcal:security-group>
    <rwcal:dns-server>...</rwcal:dns-server>
    <rwcal:dhcp-params>...</rwcal:dhcp-params>
    <rwcal:subnet-prefix-pool>STRING</rwcal:subnet-prefix-pool>
  </rwcal:ip-profile-params>
</rwcal:virtual-link-req-params>

XML Sample

<rwcal:virtual-link-req-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:subnet>STRING</rwcal:subnet>
  <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
  <rwcal:vim-network-name>STRING</rwcal:vim-network-name>
  <rwcal:virtual-cps>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:type>VPORT</rwcal:type>
    <rwcal:security-group>STRING</rwcal:security-group>
    <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
    <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
  </rwcal:virtual-cps>
  <rwcal:provider-network>
    <rwcal:physical-network>STRING</rwcal:physical-network>
    <rwcal:overlay-type>LOCAL</rwcal:overlay-type>
    <rwcal:segmentation_id>0</rwcal:segmentation_id>
  </rwcal:provider-network>
  <rwcal:ip-profile-params>
    <rwcal:ip-version>ipv4</rwcal:ip-version>
    <rwcal:subnet-address>UNION_VALUE</rwcal:subnet-address>
    <rwcal:gateway-address>UNION_VALUE</rwcal:gateway-address>
    <rwcal:security-group>STRING</rwcal:security-group>
    <rwcal:dns-server>...</rwcal:dns-server>
    <rwcal:dhcp-params>...</rwcal:dhcp-params>
    <rwcal:subnet-prefix-pool>STRING</rwcal:subnet-prefix-pool>
  </rwcal:ip-profile-params>
</rwcal:virtual-link-req-params>

rwcal:virtual-cps

Key Identifiers:

XPath Path

/rw-project:project/rwcal:virtual-link-req-params/rwcal:virtual-cps

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:virtual-link-req-params/rwcal:virtual-cps[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:virtual-link-req-params/virtual-cps/STRING

Fields

Name	Type	Description
name	STRING	Name of virtual connection point
type	ENUM	Type of the Virtual Connection Point
security-group	STRING	Name of the security group
port-security-enabled	BOOLEAN	Enables the port security
static-ip-address	UNION	Static IP address for the connection point

JSON Config Sample

[
  {
    "name": "STRING",
    "type": "VPORT",
    "security-group": "STRING",
    "port-security-enabled": true,
    "static-ip-address": "UNION_VALUE"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "type": "VPORT",
    "security-group": "STRING",
    "port-security-enabled": true,
    "static-ip-address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Config Sample

<rwcal:virtual-cps xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:type>VPORT</rwcal:type>
  <rwcal:security-group>STRING</rwcal:security-group>
  <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
  <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
</rwcal:virtual-cps>

XML Sample

<rwcal:virtual-cps xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:type>VPORT</rwcal:type>
  <rwcal:security-group>STRING</rwcal:security-group>
  <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
  <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
</rwcal:virtual-cps>

rwcal:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:virtual-link-req-params/rwcal:provider-network

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:virtual-link-req-params/rwcal:provider-network

RW.REST URI Path

/rw-project:project/STRING/rwcal:virtual-link-req-params/provider-network

Fields

Name	Type	Description
physical-network	STRING	Name of the physical network on which the provider network is built.
overlay-type	ENUM	Type of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels PORTGROUP - Provider networks implemented for VIO support
segmentation_id	UINT32	ID of segregated virtual networks

JSON Config Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

JSON Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

XML Config Sample

<rwcal:provider-network xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:physical-network>STRING</rwcal:physical-network>
  <rwcal:overlay-type>LOCAL</rwcal:overlay-type>
  <rwcal:segmentation_id>0</rwcal:segmentation_id>
</rwcal:provider-network>

XML Sample

<rwcal:provider-network xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:physical-network>STRING</rwcal:physical-network>
  <rwcal:overlay-type>LOCAL</rwcal:overlay-type>
  <rwcal:segmentation_id>0</rwcal:segmentation_id>
</rwcal:provider-network>

rwcal:ip-profile-params

Key Identifiers:

XPath Path

/rw-project:project/rwcal:virtual-link-req-params/rwcal:ip-profile-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:virtual-link-req-params/rwcal:ip-profile-params

RW.REST URI Path

/rw-project:project/STRING/rwcal:virtual-link-req-params/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

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

XML Sample

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

rwcal:dns-server

Key Identifiers:

XPath Path

/rw-project:project/rwcal:virtual-link-req-params/rwcal:ip-profile-params/rwcal:dns-server

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:virtual-link-req-params/rwcal:ip-profile-params/rwcal:dns-server[rwcal:address='UNION_VALUE']

RW.REST URI Path

/rw-project:project/STRING/rwcal:virtual-link-req-params/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

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

XML Sample

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

rwcal:dhcp-params

Key Identifiers:

XPath Path

/rw-project:project/rwcal:virtual-link-req-params/rwcal:ip-profile-params/rwcal:dhcp-params

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:virtual-link-req-params/rwcal:ip-profile-params/rwcal:dhcp-params

RW.REST URI Path

/rw-project:project/STRING/rwcal:virtual-link-req-params/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

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

XML Sample

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

rwcal:vdu-init-params

This object defines the parameters required to create a VDU

Key Identifiers:

XPath Path	/rw-project:project/rwcal:vdu-init-params
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params
RW.REST URI Path	/rw-project:project/STRING/rwcal:vdu-init-params

Fields

Name	Type	Description
name	STRING	Name of the 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.
node-id	STRING
flavor-id	STRING	CAL assigned flavor-id for the VDU image
image-id	STRING	CAL assigned image-id for the VDU image
image-name	STRING	Image name which can be used to lookup the image-id
image-checksum	STRING	Image md5sum checksum used in combination with image name to lookup image-id
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
connection-points	LIST
mgmt-network	STRING	Explicit mgmt-network name, otherwise the mgmt-network from Cloud account is used
allocate-public-address	BOOLEAN	If this VDU needs public IP address
vdu-init	CONTAINER
supplemental-boot-data	CONTAINER
volumes	LIST

JSON Config Sample

{
  "name": "STRING",
  "mgmt-vpci": "STRING",
  "vm-flavor": {
    "vcpu-count": 0,
    "memory-mb": 0,
    "storage-gb": 0,
    "vm-flavor-name": "STRING"
  },
  "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": [ { ... }, { ... } ]
  },
  "node-id": "STRING",
  "flavor-id": "STRING",
  "image-id": "STRING",
  "image-name": "STRING",
  "image-checksum": "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],
  "connection-points": [
    {
      "name": "STRING",
      "virtual-link-id": "STRING",
      "associate-public-ip": false,
      "vpci": "STRING",
      "security-group": "STRING",
      "port-security-enabled": true,
      "static-ip-address": "UNION_VALUE",
      "port-order": 0,
      "virtual_cps": [ { ... }, { ... } ],
      "type": "VIRTIO"
    }, {
      ...
    }
  ],
  "mgmt-network": "STRING",
  "allocate-public-address": false,
  "vdu-init": {
    "userdata": "STRING"
  },
  "supplemental-boot-data": {
    "config-file": [ { ... }, { ... } ],
    "boot-data-drive": false,
    "custom-meta-data": [ { ... }, { ... } ]
  },
  "volumes": [
    {
      "name": "STRING",
      "description": "STRING",
      "size": 0,
      "ephemeral": [null],
      "image": "STRING",
      "image-checksum": "STRING",
      "volume-ref": "STRING",
      "device-bus": "ide",
      "device-type": "disk",
      "boot-volume": true,
      "boot-priority": 0
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "name": "STRING",
  "mgmt-vpci": "STRING",
  "vm-flavor": {
    "vcpu-count": 0,
    "memory-mb": 0,
    "storage-gb": 0,
    "vm-flavor-name": "STRING"
  },
  "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": [ { ... }, { ... } ]
  },
  "node-id": "STRING",
  "flavor-id": "STRING",
  "image-id": "STRING",
  "image-name": "STRING",
  "image-checksum": "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],
  "connection-points": [
    {
      "name": "STRING",
      "virtual-link-id": "STRING",
      "associate-public-ip": false,
      "vpci": "STRING",
      "security-group": "STRING",
      "port-security-enabled": true,
      "static-ip-address": "UNION_VALUE",
      "port-order": 0,
      "virtual_cps": [ { ... }, { ... } ],
      "type": "VIRTIO"
    }, {
      ...
    }
  ],
  "mgmt-network": "STRING",
  "allocate-public-address": false,
  "vdu-init": {
    "userdata": "STRING"
  },
  "supplemental-boot-data": {
    "config-file": [ { ... }, { ... } ],
    "boot-data-drive": false,
    "custom-meta-data": [ { ... }, { ... } ]
  },
  "volumes": [
    {
      "name": "STRING",
      "description": "STRING",
      "size": 0,
      "ephemeral": [null],
      "image": "STRING",
      "image-checksum": "STRING",
      "volume-ref": "STRING",
      "device-bus": "ide",
      "device-type": "disk",
      "boot-volume": true,
      "boot-priority": 0
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwcal:vdu-init-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:mgmt-vpci>STRING</rwcal:mgmt-vpci>
  <rwcal:vm-flavor>
    <rwcal:vcpu-count>0</rwcal:vcpu-count>
    <rwcal:memory-mb>0</rwcal:memory-mb>
    <rwcal:storage-gb>0</rwcal:storage-gb>
    <rwcal:vm-flavor-name>STRING</rwcal:vm-flavor-name>
  </rwcal:vm-flavor>
  <rwcal:guest-epa>
    <rwcal:trusted-execution>true</rwcal:trusted-execution>
    <rwcal:mempage-size>LARGE</rwcal:mempage-size>
    <rwcal:cpu-pinning-policy>ANY</rwcal:cpu-pinning-policy>
    <rwcal:cpu-thread-pinning-policy>AVOID</rwcal:cpu-thread-pinning-policy>
    <rwcal:pcie-device>...</rwcal:pcie-device>
    <rwcal:numa-unaware/>
    <rwcal:numa-node-policy>...</rwcal:numa-node-policy>
  </rwcal:guest-epa>
  <rwcal:vswitch-epa>
    <rwcal:ovs-acceleration>MANDATORY</rwcal:ovs-acceleration>
    <rwcal:ovs-offload>MANDATORY</rwcal:ovs-offload>
  </rwcal:vswitch-epa>
  <rwcal:hypervisor-epa>
    <rwcal:type>PREFER_KVM</rwcal:type>
    <rwcal:version>STRING</rwcal:version>
  </rwcal:hypervisor-epa>
  <rwcal:host-epa>
    <rwcal:cpu-model>PREFER_WESTMERE</rwcal:cpu-model>
    <rwcal:cpu-arch>PREFER_X86</rwcal:cpu-arch>
    <rwcal:cpu-vendor>PREFER_INTEL</rwcal:cpu-vendor>
    <rwcal:cpu-socket-count>0</rwcal:cpu-socket-count>
    <rwcal:cpu-core-count>0</rwcal:cpu-core-count>
    <rwcal:cpu-core-thread-count>0</rwcal:cpu-core-thread-count>
    <rwcal:cpu-feature>...</rwcal:cpu-feature>
    <rwcal:om-cpu-model-string>STRING</rwcal:om-cpu-model-string>
    <rwcal:om-cpu-feature>...</rwcal:om-cpu-feature>
  </rwcal:host-epa>
  <rwcal:node-id>STRING</rwcal:node-id>
  <rwcal:flavor-id>STRING</rwcal:flavor-id>
  <rwcal:image-id>STRING</rwcal:image-id>
  <rwcal:image-name>STRING</rwcal:image-name>
  <rwcal:image-checksum>STRING</rwcal:image-checksum>
  <rwcal:cloud-type>aws</rwcal:cloud-type>
  <rwcal:availability-zone>
    <rwcal:name>STRING</rwcal:name>
  </rwcal:availability-zone>
  <rwcal:server-group>
    <rwcal:name>STRING</rwcal:name>
  </rwcal:server-group>
  <rwcal:host-aggregate>
    <rwcal:metadata-key>STRING</rwcal:metadata-key>
    <rwcal:metadata-value>STRING</rwcal:metadata-value>
  </rwcal:host-aggregate>
  <rwcal:aws-construct/>
  <rwcal:openmano-construct/>
  <rwcal:vsphere-construct/>
  <rwcal:mock-construct/>
  <rwcal:cloudsim-construct/>
  <rwcal:connection-points>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
    <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
    <rwcal:vpci>STRING</rwcal:vpci>
    <rwcal:security-group>STRING</rwcal:security-group>
    <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
    <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
    <rwcal:port-order>0</rwcal:port-order>
    <rwcal:virtual_cps>...</rwcal:virtual_cps>
    <rwcal:type>VIRTIO</rwcal:type>
  </rwcal:connection-points>
  <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
  <rwcal:allocate-public-address>false</rwcal:allocate-public-address>
  <rwcal:vdu-init>
    <rwcal:userdata>STRING</rwcal:userdata>
  </rwcal:vdu-init>
  <rwcal:supplemental-boot-data>
    <rwcal:config-file>...</rwcal:config-file>
    <rwcal:boot-data-drive>false</rwcal:boot-data-drive>
    <rwcal:custom-meta-data>...</rwcal:custom-meta-data>
  </rwcal:supplemental-boot-data>
  <rwcal:volumes>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:description>STRING</rwcal:description>
    <rwcal:size>0</rwcal:size>
    <rwcal:ephemeral/>
    <rwcal:image>STRING</rwcal:image>
    <rwcal:image-checksum>STRING</rwcal:image-checksum>
    <rwcal:volume-ref>STRING</rwcal:volume-ref>
    <rwcal:device-bus>ide</rwcal:device-bus>
    <rwcal:device-type>disk</rwcal:device-type>
    <rwcal:boot-volume>true</rwcal:boot-volume>
    <rwcal:boot-priority>0</rwcal:boot-priority>
  </rwcal:volumes>
</rwcal:vdu-init-params>

XML Sample

<rwcal:vdu-init-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:mgmt-vpci>STRING</rwcal:mgmt-vpci>
  <rwcal:vm-flavor>
    <rwcal:vcpu-count>0</rwcal:vcpu-count>
    <rwcal:memory-mb>0</rwcal:memory-mb>
    <rwcal:storage-gb>0</rwcal:storage-gb>
    <rwcal:vm-flavor-name>STRING</rwcal:vm-flavor-name>
  </rwcal:vm-flavor>
  <rwcal:guest-epa>
    <rwcal:trusted-execution>true</rwcal:trusted-execution>
    <rwcal:mempage-size>LARGE</rwcal:mempage-size>
    <rwcal:cpu-pinning-policy>ANY</rwcal:cpu-pinning-policy>
    <rwcal:cpu-thread-pinning-policy>AVOID</rwcal:cpu-thread-pinning-policy>
    <rwcal:pcie-device>...</rwcal:pcie-device>
    <rwcal:numa-unaware/>
    <rwcal:numa-node-policy>...</rwcal:numa-node-policy>
  </rwcal:guest-epa>
  <rwcal:vswitch-epa>
    <rwcal:ovs-acceleration>MANDATORY</rwcal:ovs-acceleration>
    <rwcal:ovs-offload>MANDATORY</rwcal:ovs-offload>
  </rwcal:vswitch-epa>
  <rwcal:hypervisor-epa>
    <rwcal:type>PREFER_KVM</rwcal:type>
    <rwcal:version>STRING</rwcal:version>
  </rwcal:hypervisor-epa>
  <rwcal:host-epa>
    <rwcal:cpu-model>PREFER_WESTMERE</rwcal:cpu-model>
    <rwcal:cpu-arch>PREFER_X86</rwcal:cpu-arch>
    <rwcal:cpu-vendor>PREFER_INTEL</rwcal:cpu-vendor>
    <rwcal:cpu-socket-count>0</rwcal:cpu-socket-count>
    <rwcal:cpu-core-count>0</rwcal:cpu-core-count>
    <rwcal:cpu-core-thread-count>0</rwcal:cpu-core-thread-count>
    <rwcal:cpu-feature>...</rwcal:cpu-feature>
    <rwcal:om-cpu-model-string>STRING</rwcal:om-cpu-model-string>
    <rwcal:om-cpu-feature>...</rwcal:om-cpu-feature>
  </rwcal:host-epa>
  <rwcal:node-id>STRING</rwcal:node-id>
  <rwcal:flavor-id>STRING</rwcal:flavor-id>
  <rwcal:image-id>STRING</rwcal:image-id>
  <rwcal:image-name>STRING</rwcal:image-name>
  <rwcal:image-checksum>STRING</rwcal:image-checksum>
  <rwcal:cloud-type>aws</rwcal:cloud-type>
  <rwcal:availability-zone>
    <rwcal:name>STRING</rwcal:name>
  </rwcal:availability-zone>
  <rwcal:server-group>
    <rwcal:name>STRING</rwcal:name>
  </rwcal:server-group>
  <rwcal:host-aggregate>
    <rwcal:metadata-key>STRING</rwcal:metadata-key>
    <rwcal:metadata-value>STRING</rwcal:metadata-value>
  </rwcal:host-aggregate>
  <rwcal:aws-construct/>
  <rwcal:openmano-construct/>
  <rwcal:vsphere-construct/>
  <rwcal:mock-construct/>
  <rwcal:cloudsim-construct/>
  <rwcal:connection-points>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
    <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
    <rwcal:vpci>STRING</rwcal:vpci>
    <rwcal:security-group>STRING</rwcal:security-group>
    <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
    <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
    <rwcal:port-order>0</rwcal:port-order>
    <rwcal:virtual_cps>...</rwcal:virtual_cps>
    <rwcal:type>VIRTIO</rwcal:type>
  </rwcal:connection-points>
  <rwcal:mgmt-network>STRING</rwcal:mgmt-network>
  <rwcal:allocate-public-address>false</rwcal:allocate-public-address>
  <rwcal:vdu-init>
    <rwcal:userdata>STRING</rwcal:userdata>
  </rwcal:vdu-init>
  <rwcal:supplemental-boot-data>
    <rwcal:config-file>...</rwcal:config-file>
    <rwcal:boot-data-drive>false</rwcal:boot-data-drive>
    <rwcal:custom-meta-data>...</rwcal:custom-meta-data>
  </rwcal:supplemental-boot-data>
  <rwcal:volumes>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:description>STRING</rwcal:description>
    <rwcal:size>0</rwcal:size>
    <rwcal:ephemeral/>
    <rwcal:image>STRING</rwcal:image>
    <rwcal:image-checksum>STRING</rwcal:image-checksum>
    <rwcal:volume-ref>STRING</rwcal:volume-ref>
    <rwcal:device-bus>ide</rwcal:device-bus>
    <rwcal:device-type>disk</rwcal:device-type>
    <rwcal:boot-volume>true</rwcal:boot-volume>
    <rwcal:boot-priority>0</rwcal:boot-priority>
  </rwcal:volumes>
</rwcal:vdu-init-params>

rwcal:vm-flavor

Key Identifiers:

XPath Path	/rw-project:project/rwcal:vdu-init-params/rwcal:vm-flavor
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:vm-flavor
RW.REST URI Path	/rw-project:project/STRING/rwcal:vdu-init-params/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.
vm-flavor-name	STRING	flavor name to be used while creating vm using cloud account

JSON Config Sample

{
  "vcpu-count": 0,
  "memory-mb": 0,
  "storage-gb": 0,
  "vm-flavor-name": "STRING"
}

JSON Sample

{
  "vcpu-count": 0,
  "memory-mb": 0,
  "storage-gb": 0,
  "vm-flavor-name": "STRING"
}

XML Config Sample

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

XML Sample

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

rwcal:guest-epa

Key Identifiers:

XPath Path	/rw-project:project/rwcal:vdu-init-params/rwcal:guest-epa
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:guest-epa
RW.REST URI Path	/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:pcie-device

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:pcie-device[rwcal:device-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:numa-node-policy

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:node

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:vcpu

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:vcpu[rwcal:id='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:paired-threads

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:paired-threads

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:paired-threads

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:paired-thread-ids

List of thread pairs to use in case of paired-thread NUMA

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:paired-threads/rwcal:paired-thread-ids

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:paired-threads/rwcal:paired-thread-ids[rwcal:thread-a='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:vswitch-epa

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:vswitch-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:vswitch-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:hypervisor-epa

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:hypervisor-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:hypervisor-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path	/rw-project:project/rwcal:vdu-init-params/rwcal:host-epa
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:host-epa
RW.REST URI Path	/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:host-epa/rwcal:cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:host-epa/rwcal:cpu-feature[rwcal:feature='PREFER_AES']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:host-epa/rwcal:om-cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:host-epa/rwcal:om-cpu-feature[rwcal:feature='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:availability-zone

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:availability-zone

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<rwcal:availability-zone xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
</rwcal:availability-zone>

XML Sample

<rwcal:availability-zone xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
</rwcal:availability-zone>

rwcal:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:server-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:server-group

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<rwcal:server-group xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
</rwcal:server-group>

XML Sample

<rwcal:server-group xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
</rwcal:server-group>

rwcal:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:host-aggregate

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:host-aggregate[rwcal:metadata-key='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

<rwcal:host-aggregate xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:metadata-key>STRING</rwcal:metadata-key>
  <rwcal:metadata-value>STRING</rwcal:metadata-value>
</rwcal:host-aggregate>

XML Sample

<rwcal:host-aggregate xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:metadata-key>STRING</rwcal:metadata-key>
  <rwcal:metadata-value>STRING</rwcal:metadata-value>
</rwcal:host-aggregate>

rwcal:connection-points

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:connection-points

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:connection-points[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/connection-points/STRING

Fields

Name	Type	Description
name	STRING	Name of the connection point
virtual-link-id	STRING	CAL assigned resource Id for the Virtual Link
associate-public-ip	BOOLEAN
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.
security-group	STRING	Name of the security group
port-security-enabled	BOOLEAN	Enables the port security
static-ip-address	UNION	Static IP address for the connection point
port-order	UINT32	Port Sequence Order
virtual_cps	LIST
type	ENUM	Specifies the type of connection point 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. VPORT : Virtual Port.

JSON Config Sample

[
  {
    "name": "STRING",
    "virtual-link-id": "STRING",
    "associate-public-ip": false,
    "vpci": "STRING",
    "security-group": "STRING",
    "port-security-enabled": true,
    "static-ip-address": "UNION_VALUE",
    "port-order": 0,
    "virtual_cps": [
      {
        "connection-point-id": "STRING",
        "name": "STRING",
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING"
      }, {
        ...
      }
    ],
    "type": "VIRTIO"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "virtual-link-id": "STRING",
    "associate-public-ip": false,
    "vpci": "STRING",
    "security-group": "STRING",
    "port-security-enabled": true,
    "static-ip-address": "UNION_VALUE",
    "port-order": 0,
    "virtual_cps": [
      {
        "connection-point-id": "STRING",
        "name": "STRING",
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING"
      }, {
        ...
      }
    ],
    "type": "VIRTIO"
  }, {
    ...
  }
]

XML Config Sample

<rwcal:connection-points xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
  <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
  <rwcal:vpci>STRING</rwcal:vpci>
  <rwcal:security-group>STRING</rwcal:security-group>
  <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
  <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
  <rwcal:port-order>0</rwcal:port-order>
  <rwcal:virtual_cps>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
    <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
    <rwcal:mac-address>STRING</rwcal:mac-address>
  </rwcal:virtual_cps>
  <rwcal:type>VIRTIO</rwcal:type>
</rwcal:connection-points>

XML Sample

<rwcal:connection-points xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
  <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
  <rwcal:vpci>STRING</rwcal:vpci>
  <rwcal:security-group>STRING</rwcal:security-group>
  <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
  <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
  <rwcal:port-order>0</rwcal:port-order>
  <rwcal:virtual_cps>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
    <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
    <rwcal:mac-address>STRING</rwcal:mac-address>
  </rwcal:virtual_cps>
  <rwcal:type>VIRTIO</rwcal:type>
</rwcal:connection-points>

rwcal:virtual_cps

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:connection-points/rwcal:virtual_cps

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:connection-points[rwcal:name='STRING']/rwcal:virtual_cps[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/connection-points/STRING/virtual_cps/STRING

Fields

Name	Type	Description
connection-point-id	STRING	Connection point id
name	STRING	Name of virtual connection point
ip-address	UNION	IP address of the virtual connection point
mac-address	STRING	MAC address of the virtual connection point

JSON Config Sample

[
  {
    "connection-point-id": "STRING",
    "name": "STRING",
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "connection-point-id": "STRING",
    "name": "STRING",
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rwcal:virtual_cps xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
  <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
  <rwcal:mac-address>STRING</rwcal:mac-address>
</rwcal:virtual_cps>

XML Sample

<rwcal:virtual_cps xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
  <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
  <rwcal:mac-address>STRING</rwcal:mac-address>
</rwcal:virtual_cps>

rwcal:vdu-init

Key Identifiers:

XPath Path	/rw-project:project/rwcal:vdu-init-params/rwcal:vdu-init
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:vdu-init
RW.REST URI Path	/rw-project:project/STRING/rwcal:vdu-init-params/vdu-init

Fields

Name	Type	Description
userdata	STRING	The userdata field for vdu-init should contain the contents of the script that cloud-init should invoke when configuring the system. Note that this script is expected to be in the cloud-config format

JSON Config Sample

{
  "userdata": "STRING"
}

JSON Sample

{
  "userdata": "STRING"
}

XML Config Sample

<rwcal:vdu-init xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:userdata>STRING</rwcal:userdata>
</rwcal:vdu-init>

XML Sample

<rwcal:vdu-init xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:userdata>STRING</rwcal:userdata>
</rwcal:vdu-init>

rwcal:supplemental-boot-data

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:supplemental-boot-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:supplemental-boot-data

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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
custom-meta-data	LIST	List of meta-data to be associated with the instance

JSON Config Sample

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false,
  "custom-meta-data": [
    {
      "name": "STRING",
      "data-type": "STRING",
      "value": "STRING",
      "destination": "CLOUD_METADATA"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false,
  "custom-meta-data": [
    {
      "name": "STRING",
      "data-type": "STRING",
      "value": "STRING",
      "destination": "CLOUD_METADATA"
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwcal:supplemental-boot-data xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:config-file>
    <rwcal:source>STRING</rwcal:source>
    <rwcal:dest>STRING</rwcal:dest>
  </rwcal:config-file>
  <rwcal:boot-data-drive>false</rwcal:boot-data-drive>
  <rwcal:custom-meta-data>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:data-type>STRING</rwcal:data-type>
    <rwcal:value>STRING</rwcal:value>
    <rwcal:destination>CLOUD_METADATA</rwcal:destination>
  </rwcal:custom-meta-data>
</rwcal:supplemental-boot-data>

XML Sample

<rwcal:supplemental-boot-data xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:config-file>
    <rwcal:source>STRING</rwcal:source>
    <rwcal:dest>STRING</rwcal:dest>
  </rwcal:config-file>
  <rwcal:boot-data-drive>false</rwcal:boot-data-drive>
  <rwcal:custom-meta-data>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:data-type>STRING</rwcal:data-type>
    <rwcal:value>STRING</rwcal:value>
    <rwcal:destination>CLOUD_METADATA</rwcal:destination>
  </rwcal:custom-meta-data>
</rwcal:supplemental-boot-data>

rwcal:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:supplemental-boot-data/rwcal:config-file

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:supplemental-boot-data/rwcal:config-file[rwcal:source='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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

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

XML Sample

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

rwcal:custom-meta-data

List of meta-data to be associated with the instance

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:supplemental-boot-data/rwcal:custom-meta-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:supplemental-boot-data/rwcal:custom-meta-data[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/supplemental-boot-data/custom-meta-data/STRING

Fields

Name	Type	Description
name	STRING	Name of the meta-data parameter
data-type	ENUM	Data-type the meta-data parameter
value	STRING	Value of the meta-data parameter
destination	ENUM	Type of input parameter

JSON Config Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "value": "STRING",
    "destination": "CLOUD_METADATA"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "value": "STRING",
    "destination": "CLOUD_METADATA"
  }, {
    ...
  }
]

XML Config Sample

<rwcal:custom-meta-data xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:data-type>STRING</rwcal:data-type>
  <rwcal:value>STRING</rwcal:value>
  <rwcal:destination>CLOUD_METADATA</rwcal:destination>
</rwcal:custom-meta-data>

XML Sample

<rwcal:custom-meta-data xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:data-type>STRING</rwcal:data-type>
  <rwcal:value>STRING</rwcal:value>
  <rwcal:destination>CLOUD_METADATA</rwcal:destination>
</rwcal:custom-meta-data>

rwcal:volumes

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-init-params/rwcal:volumes

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-init-params/rwcal:volumes[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-init-params/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.
volume-ref	STRING	Reference for pre-existing volume in VIM
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
boot-volume	BOOLEAN	This flag indicates if this is boot volume or not
boot-priority	INT32	Boot priority associated with volume

JSON Config Sample

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

JSON Sample

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

XML Config Sample

<rwcal:volumes xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:description>STRING</rwcal:description>
  <rwcal:size>0</rwcal:size>
  <rwcal:ephemeral/>
  <rwcal:image>STRING</rwcal:image>
  <rwcal:image-checksum>STRING</rwcal:image-checksum>
  <rwcal:volume-ref>STRING</rwcal:volume-ref>
  <rwcal:device-bus>ide</rwcal:device-bus>
  <rwcal:device-type>disk</rwcal:device-type>
  <rwcal:boot-volume>true</rwcal:boot-volume>
  <rwcal:boot-priority>0</rwcal:boot-priority>
</rwcal:volumes>

XML Sample

<rwcal:volumes xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:description>STRING</rwcal:description>
  <rwcal:size>0</rwcal:size>
  <rwcal:ephemeral/>
  <rwcal:image>STRING</rwcal:image>
  <rwcal:image-checksum>STRING</rwcal:image-checksum>
  <rwcal:volume-ref>STRING</rwcal:volume-ref>
  <rwcal:device-bus>ide</rwcal:device-bus>
  <rwcal:device-type>disk</rwcal:device-type>
  <rwcal:boot-volume>true</rwcal:boot-volume>
  <rwcal:boot-priority>0</rwcal:boot-priority>
</rwcal:volumes>

rwcal:vdu-modify-params

This object defines the parameters required to modify VDU

Key Identifiers:

XPath Path	/rw-project:project/rwcal:vdu-modify-params
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:vdu-modify-params
RW.REST URI Path	/rw-project:project/STRING/rwcal:vdu-modify-params

Fields

Name	Type	Description
vdu-id	STRING	CAL assigned id for VDU to which this connection point belongs
static-ip-address	UNION	Static IP address for the connection point
type	ENUM	Specifies the type of connection point 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. VPORT : Virtual Port.
image-id	STRING	CAL assigned image-id for the VDU image
connection-points-add	LIST
connection-points-remove	LIST

JSON Config Sample

{
  "vdu-id": "STRING",
  "static-ip-address": "UNION_VALUE",
  "type": "VIRTIO",
  "image-id": "STRING",
  "connection-points-add": [
    {
      "name": "STRING",
      "virtual-link-id": "STRING",
      "associate-public-ip": false,
      "port-security-enabled": true,
      "type": "VIRTIO"
    }, {
      ...
    }
  ],
  "connection-points-remove": [
    {
      "connection-point-id": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "vdu-id": "STRING",
  "static-ip-address": "UNION_VALUE",
  "type": "VIRTIO",
  "image-id": "STRING",
  "connection-points-add": [
    {
      "name": "STRING",
      "virtual-link-id": "STRING",
      "associate-public-ip": false,
      "port-security-enabled": true,
      "type": "VIRTIO"
    }, {
      ...
    }
  ],
  "connection-points-remove": [
    {
      "connection-point-id": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwcal:vdu-modify-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:vdu-id>STRING</rwcal:vdu-id>
  <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
  <rwcal:type>VIRTIO</rwcal:type>
  <rwcal:image-id>STRING</rwcal:image-id>
  <rwcal:connection-points-add>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
    <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
    <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
    <rwcal:type>VIRTIO</rwcal:type>
  </rwcal:connection-points-add>
  <rwcal:connection-points-remove>
    <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
  </rwcal:connection-points-remove>
</rwcal:vdu-modify-params>

XML Sample

<rwcal:vdu-modify-params xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:vdu-id>STRING</rwcal:vdu-id>
  <rwcal:static-ip-address>UNION_VALUE</rwcal:static-ip-address>
  <rwcal:type>VIRTIO</rwcal:type>
  <rwcal:image-id>STRING</rwcal:image-id>
  <rwcal:connection-points-add>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
    <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
    <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
    <rwcal:type>VIRTIO</rwcal:type>
  </rwcal:connection-points-add>
  <rwcal:connection-points-remove>
    <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
  </rwcal:connection-points-remove>
</rwcal:vdu-modify-params>

rwcal:connection-points-add

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-modify-params/rwcal:connection-points-add

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-modify-params/rwcal:connection-points-add[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-modify-params/connection-points-add/STRING

Fields

Name	Type	Description
name	STRING	Name of the connection point
virtual-link-id	STRING	CAL assigned resource Id for the Virtual Link
associate-public-ip	BOOLEAN
port-security-enabled	BOOLEAN	Enables the port security
type	ENUM	Specifies the type of connection point 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. VPORT : Virtual Port.

JSON Config Sample

[
  {
    "name": "STRING",
    "virtual-link-id": "STRING",
    "associate-public-ip": false,
    "port-security-enabled": true,
    "type": "VIRTIO"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "virtual-link-id": "STRING",
    "associate-public-ip": false,
    "port-security-enabled": true,
    "type": "VIRTIO"
  }, {
    ...
  }
]

XML Config Sample

<rwcal:connection-points-add xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
  <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
  <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
  <rwcal:type>VIRTIO</rwcal:type>
</rwcal:connection-points-add>

XML Sample

<rwcal:connection-points-add xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
  <rwcal:associate-public-ip>false</rwcal:associate-public-ip>
  <rwcal:port-security-enabled>true</rwcal:port-security-enabled>
  <rwcal:type>VIRTIO</rwcal:type>
</rwcal:connection-points-add>

rwcal:connection-points-remove

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vdu-modify-params/rwcal:connection-points-remove

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vdu-modify-params/rwcal:connection-points-remove[rwcal:connection-point-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vdu-modify-params/connection-points-remove/STRING

Fields

Name	Type	Description
connection-point-id	STRING

JSON Config Sample

[
  {
    "connection-point-id": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "connection-point-id": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rwcal:connection-points-remove xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
</rwcal:connection-points-remove>

XML Sample

<rwcal:connection-points-remove xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
</rwcal:connection-points-remove>

rwcal:vnf-resources

Key Identifiers:

XPath Path	/rw-project:project/rwcal:vnf-resources
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources
RW.REST URI Path	/rw-project:project/STRING/rwcal:vnf-resources

Fields

Name	Type	Description
virtual-link-info-list	LIST
vdu-info-list	LIST

JSON Sample

{
  "virtual-link-info-list": [
    {
      "name": "STRING",
      "state": "unknown",
      "virtual-link-id": "STRING",
      "connection-points": [ { ... }, { ... } ],
      "virtual-connection-points": [ { ... }, { ... } ],
      "subnet": "STRING",
      "provider-network": { ... }
    }, {
      ...
    }
  ],
  "vdu-info-list": [
    {
      "vdu-id": "STRING",
      "name": "STRING",
      "flavor-id": "STRING",
      "image-id": "STRING",
      "node-id": "STRING",
      "state": "unknown",
      "management-ip": "STRING",
      "public-ip": "STRING",
      "vm-flavor": { ... },
      "guest-epa": { ... },
      "vswitch-epa": { ... },
      "hypervisor-epa": { ... },
      "host-epa": { ... },
      "cloud-type": "aws",
      "availability-zone": { ... },
      "server-group": { ... },
      "host-aggregate": [ { ... }, { ... } ],
      "aws-construct": [null],
      "openmano-construct": [null],
      "vsphere-construct": [null],
      "mock-construct": [null],
      "cloudsim-construct": [null],
      "connection-points": [ { ... }, { ... } ],
      "console-url": "STRING",
      "supplemental-boot-data": { ... },
      "volumes": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<rwcal:vnf-resources xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:virtual-link-info-list>
    <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:state>unknown</rwcal:state>
    <rwcal:connection-points>...</rwcal:connection-points>
    <rwcal:virtual-connection-points>...</rwcal:virtual-connection-points>
    <rwcal:subnet>STRING</rwcal:subnet>
    <rwcal:provider-network>...</rwcal:provider-network>
  </rwcal:virtual-link-info-list>
  <rwcal:vdu-info-list>
    <rwcal:vdu-id>STRING</rwcal:vdu-id>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:flavor-id>STRING</rwcal:flavor-id>
    <rwcal:image-id>STRING</rwcal:image-id>
    <rwcal:node-id>STRING</rwcal:node-id>
    <rwcal:state>unknown</rwcal:state>
    <rwcal:management-ip>STRING</rwcal:management-ip>
    <rwcal:public-ip>STRING</rwcal:public-ip>
    <rwcal:vm-flavor>...</rwcal:vm-flavor>
    <rwcal:guest-epa>...</rwcal:guest-epa>
    <rwcal:vswitch-epa>...</rwcal:vswitch-epa>
    <rwcal:hypervisor-epa>...</rwcal:hypervisor-epa>
    <rwcal:host-epa>...</rwcal:host-epa>
    <rwcal:cloud-type>aws</rwcal:cloud-type>
    <rwcal:availability-zone>...</rwcal:availability-zone>
    <rwcal:server-group>...</rwcal:server-group>
    <rwcal:host-aggregate>...</rwcal:host-aggregate>
    <rwcal:aws-construct/>
    <rwcal:openmano-construct/>
    <rwcal:vsphere-construct/>
    <rwcal:mock-construct/>
    <rwcal:cloudsim-construct/>
    <rwcal:connection-points>...</rwcal:connection-points>
    <rwcal:console-url>STRING</rwcal:console-url>
    <rwcal:supplemental-boot-data>...</rwcal:supplemental-boot-data>
    <rwcal:volumes>...</rwcal:volumes>
  </rwcal:vdu-info-list>
</rwcal:vnf-resources>

rwcal:virtual-link-info-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:virtual-link-info-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:virtual-link-info-list[rwcal:virtual-link-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/virtual-link-info-list/STRING

Fields

Name	Type	Description
name	STRING	Name of the Virtual-Link
state	ENUM	State of the Virtual Link
virtual-link-id	STRING	CAL assigned resource ID of the Virtual-Link
connection-points	LIST
virtual-connection-points	LIST
subnet	STRING
provider-network	CONTAINER	Container for the provider network.

JSON Sample

[
  {
    "name": "STRING",
    "state": "unknown",
    "virtual-link-id": "STRING",
    "connection-points": [
      {
        "connection-point-id": "STRING",
        "name": "STRING",
        "virtual-link-id": "STRING",
        "vdu-id": "STRING",
        "state": "active",
        "ip-address": "UNION_VALUE",
        "public-ip": "STRING",
        "mac-addr": "STRING",
        "port-order": 0,
        "virtual-cp-info": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "virtual-connection-points": [
      {
        "connection-point-id": "STRING",
        "name": "STRING",
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING"
      }, {
        ...
      }
    ],
    "subnet": "STRING",
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "segmentation_id": 0
    }
  }, {
    ...
  }
]

XML Sample

<rwcal:virtual-link-info-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
  <rwcal:name>STRING</rwcal:name>
  <rwcal:state>unknown</rwcal:state>
  <rwcal:connection-points>
    <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
    <rwcal:vdu-id>STRING</rwcal:vdu-id>
    <rwcal:state>active</rwcal:state>
    <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
    <rwcal:public-ip>STRING</rwcal:public-ip>
    <rwcal:mac-addr>STRING</rwcal:mac-addr>
    <rwcal:port-order>0</rwcal:port-order>
    <rwcal:virtual-cp-info>...</rwcal:virtual-cp-info>
  </rwcal:connection-points>
  <rwcal:virtual-connection-points>
    <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
    <rwcal:mac-address>STRING</rwcal:mac-address>
  </rwcal:virtual-connection-points>
  <rwcal:subnet>STRING</rwcal:subnet>
  <rwcal:provider-network>
    <rwcal:physical-network>STRING</rwcal:physical-network>
    <rwcal:overlay-type>LOCAL</rwcal:overlay-type>
    <rwcal:segmentation_id>0</rwcal:segmentation_id>
  </rwcal:provider-network>
</rwcal:virtual-link-info-list>

rwcal:connection-points

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:virtual-link-info-list/rwcal:connection-points

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:virtual-link-info-list[rwcal:virtual-link-id='STRING']/rwcal:connection-points[rwcal:connection-point-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/virtual-link-info-list/STRING/connection-points/STRING

Fields

Name	Type	Description
connection-point-id	STRING
name	STRING	Name of the connection point
virtual-link-id	STRING	CAL assigned resource ID of the Virtual-Link
vdu-id	STRING	CAL assigned id for VDU to which this connection point belongs
state	ENUM	CMP agnostic generic state of the connection point
ip-address	UNION
public-ip	STRING
mac-addr	STRING
port-order	UINT32	Port Sequence Order
virtual-cp-info	LIST

JSON Sample

[
  {
    "connection-point-id": "STRING",
    "name": "STRING",
    "virtual-link-id": "STRING",
    "vdu-id": "STRING",
    "state": "active",
    "ip-address": "UNION_VALUE",
    "public-ip": "STRING",
    "mac-addr": "STRING",
    "port-order": 0,
    "virtual-cp-info": [
      {
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rwcal:connection-points xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
  <rwcal:name>STRING</rwcal:name>
  <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
  <rwcal:vdu-id>STRING</rwcal:vdu-id>
  <rwcal:state>active</rwcal:state>
  <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
  <rwcal:public-ip>STRING</rwcal:public-ip>
  <rwcal:mac-addr>STRING</rwcal:mac-addr>
  <rwcal:port-order>0</rwcal:port-order>
  <rwcal:virtual-cp-info>
    <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
    <rwcal:mac-address>STRING</rwcal:mac-address>
  </rwcal:virtual-cp-info>
</rwcal:connection-points>

rwcal:virtual-cp-info

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:virtual-link-info-list/rwcal:connection-points/rwcal:virtual-cp-info

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:virtual-link-info-list[rwcal:virtual-link-id='STRING']/rwcal:connection-points[rwcal:connection-point-id='STRING']/rwcal:virtual-cp-info[rwcal:ip-address='UNION_VALUE']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/virtual-link-info-list/STRING/connection-points/STRING/virtual-cp-info/UNION_VALUE

Fields

Name	Type	Description
ip-address	UNION
mac-address	STRING

JSON Sample

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

XML Sample

<rwcal:virtual-cp-info xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
  <rwcal:mac-address>STRING</rwcal:mac-address>
</rwcal:virtual-cp-info>

rwcal:virtual-connection-points

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:virtual-link-info-list/rwcal:virtual-connection-points

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:virtual-link-info-list[rwcal:virtual-link-id='STRING']/rwcal:virtual-connection-points[rwcal:connection-point-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/virtual-link-info-list/STRING/virtual-connection-points/STRING

Fields

Name	Type	Description
connection-point-id	STRING	Connection point id
name	STRING	Name of virtual connection point
ip-address	UNION	IP address of the virtual connection point
mac-address	STRING	MAC address of the virtual connection point

JSON Sample

[
  {
    "connection-point-id": "STRING",
    "name": "STRING",
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING"
  }, {
    ...
  }
]

XML Sample

<rwcal:virtual-connection-points xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
  <rwcal:name>STRING</rwcal:name>
  <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
  <rwcal:mac-address>STRING</rwcal:mac-address>
</rwcal:virtual-connection-points>

rwcal:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:virtual-link-info-list/rwcal:provider-network

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:virtual-link-info-list[rwcal:virtual-link-id='STRING']/rwcal:provider-network

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/virtual-link-info-list/STRING/provider-network

Fields

Name	Type	Description
physical-network	STRING	Name of the physical network on which the provider network is built.
overlay-type	ENUM	Type of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels PORTGROUP - Provider networks implemented for VIO support
segmentation_id	UINT32	ID of segregated virtual networks

JSON Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

XML Sample

<rwcal:provider-network xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:physical-network>STRING</rwcal:physical-network>
  <rwcal:overlay-type>LOCAL</rwcal:overlay-type>
  <rwcal:segmentation_id>0</rwcal:segmentation_id>
</rwcal:provider-network>

rwcal:vdu-info-list

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING

Fields

Name	Type	Description
vdu-id	STRING	CAL assigned id for VDU
name	STRING	Name of the VDU
flavor-id	STRING	CAL assigned flavor-id for the VDU image
image-id	STRING	CAL assigned image-id for the VDU image
node-id	STRING
state	ENUM	State of the VDU
management-ip	STRING
public-ip	STRING
vm-flavor	CONTAINER
guest-epa	CONTAINER
vswitch-epa	CONTAINER
hypervisor-epa	CONTAINER
host-epa	CONTAINER	Specifies the host level EPA attributes.
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
connection-points	LIST
console-url	STRING	Console URL from the VIM, if available
supplemental-boot-data	CONTAINER
volumes	LIST

JSON Sample

[
  {
    "vdu-id": "STRING",
    "name": "STRING",
    "flavor-id": "STRING",
    "image-id": "STRING",
    "node-id": "STRING",
    "state": "unknown",
    "management-ip": "STRING",
    "public-ip": "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": [ { ... }, { ... } ]
    },
    "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],
    "connection-points": [
      {
        "connection-point-id": "STRING",
        "name": "STRING",
        "virtual-link-id": "STRING",
        "vdu-id": "STRING",
        "state": "active",
        "ip-address": "UNION_VALUE",
        "public-ip": "STRING",
        "mac-addr": "STRING",
        "port-order": 0,
        "virtual-cp-info": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "console-url": "STRING",
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false,
      "custom-meta-data": [ { ... }, { ... } ]
    },
    "volumes": [
      {
        "name": "STRING",
        "volume-id": "STRING",
        "custom-meta-data": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rwcal:vdu-info-list xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:vdu-id>STRING</rwcal:vdu-id>
  <rwcal:name>STRING</rwcal:name>
  <rwcal:flavor-id>STRING</rwcal:flavor-id>
  <rwcal:image-id>STRING</rwcal:image-id>
  <rwcal:node-id>STRING</rwcal:node-id>
  <rwcal:state>unknown</rwcal:state>
  <rwcal:management-ip>STRING</rwcal:management-ip>
  <rwcal:public-ip>STRING</rwcal:public-ip>
  <rwcal:vm-flavor>
    <rwcal:vcpu-count>0</rwcal:vcpu-count>
    <rwcal:memory-mb>0</rwcal:memory-mb>
    <rwcal:storage-gb>0</rwcal:storage-gb>
  </rwcal:vm-flavor>
  <rwcal:guest-epa>
    <rwcal:trusted-execution>true</rwcal:trusted-execution>
    <rwcal:mempage-size>LARGE</rwcal:mempage-size>
    <rwcal:cpu-pinning-policy>ANY</rwcal:cpu-pinning-policy>
    <rwcal:cpu-thread-pinning-policy>AVOID</rwcal:cpu-thread-pinning-policy>
    <rwcal:pcie-device>...</rwcal:pcie-device>
    <rwcal:numa-unaware/>
    <rwcal:numa-node-policy>...</rwcal:numa-node-policy>
  </rwcal:guest-epa>
  <rwcal:vswitch-epa>
    <rwcal:ovs-acceleration>MANDATORY</rwcal:ovs-acceleration>
    <rwcal:ovs-offload>MANDATORY</rwcal:ovs-offload>
  </rwcal:vswitch-epa>
  <rwcal:hypervisor-epa>
    <rwcal:type>PREFER_KVM</rwcal:type>
    <rwcal:version>STRING</rwcal:version>
  </rwcal:hypervisor-epa>
  <rwcal:host-epa>
    <rwcal:cpu-model>PREFER_WESTMERE</rwcal:cpu-model>
    <rwcal:cpu-arch>PREFER_X86</rwcal:cpu-arch>
    <rwcal:cpu-vendor>PREFER_INTEL</rwcal:cpu-vendor>
    <rwcal:cpu-socket-count>0</rwcal:cpu-socket-count>
    <rwcal:cpu-core-count>0</rwcal:cpu-core-count>
    <rwcal:cpu-core-thread-count>0</rwcal:cpu-core-thread-count>
    <rwcal:cpu-feature>...</rwcal:cpu-feature>
    <rwcal:om-cpu-model-string>STRING</rwcal:om-cpu-model-string>
    <rwcal:om-cpu-feature>...</rwcal:om-cpu-feature>
  </rwcal:host-epa>
  <rwcal:cloud-type>aws</rwcal:cloud-type>
  <rwcal:availability-zone>
    <rwcal:name>STRING</rwcal:name>
  </rwcal:availability-zone>
  <rwcal:server-group>
    <rwcal:name>STRING</rwcal:name>
  </rwcal:server-group>
  <rwcal:host-aggregate>
    <rwcal:metadata-key>STRING</rwcal:metadata-key>
    <rwcal:metadata-value>STRING</rwcal:metadata-value>
  </rwcal:host-aggregate>
  <rwcal:aws-construct/>
  <rwcal:openmano-construct/>
  <rwcal:vsphere-construct/>
  <rwcal:mock-construct/>
  <rwcal:cloudsim-construct/>
  <rwcal:connection-points>
    <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
    <rwcal:vdu-id>STRING</rwcal:vdu-id>
    <rwcal:state>active</rwcal:state>
    <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
    <rwcal:public-ip>STRING</rwcal:public-ip>
    <rwcal:mac-addr>STRING</rwcal:mac-addr>
    <rwcal:port-order>0</rwcal:port-order>
    <rwcal:virtual-cp-info>...</rwcal:virtual-cp-info>
  </rwcal:connection-points>
  <rwcal:console-url>STRING</rwcal:console-url>
  <rwcal:supplemental-boot-data>
    <rwcal:config-file>...</rwcal:config-file>
    <rwcal:boot-data-drive>false</rwcal:boot-data-drive>
    <rwcal:custom-meta-data>...</rwcal:custom-meta-data>
  </rwcal:supplemental-boot-data>
  <rwcal:volumes>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:volume-id>STRING</rwcal:volume-id>
    <rwcal:custom-meta-data>...</rwcal:custom-meta-data>
  </rwcal:volumes>
</rwcal:vdu-info-list>

rwcal:vm-flavor

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:vm-flavor

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:vm-flavor

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:guest-epa

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:guest-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:guest-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:guest-epa/rwcal:pcie-device

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:guest-epa/rwcal:pcie-device[rwcal:device-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:numa-node-policy

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:guest-epa/rwcal:numa-node-policy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:node

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:vcpu

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:vcpu[rwcal:id='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:paired-threads

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:paired-threads

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:paired-threads

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:paired-thread-ids

List of thread pairs to use in case of paired-thread NUMA

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node/rwcal:paired-threads/rwcal:paired-thread-ids

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:guest-epa/rwcal:numa-node-policy/rwcal:node[rwcal:id='0']/rwcal:paired-threads/rwcal:paired-thread-ids[rwcal:thread-a='0']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:vswitch-epa

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:vswitch-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:vswitch-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:hypervisor-epa

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:hypervisor-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:hypervisor-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:host-epa

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:host-epa

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:host-epa/rwcal:cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:host-epa/rwcal:cpu-feature[rwcal:feature='PREFER_AES']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

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

XML Sample

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

rwcal:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:host-epa/rwcal:om-cpu-feature

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:host-epa/rwcal:om-cpu-feature[rwcal:feature='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

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

XML Sample

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

rwcal:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:availability-zone

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:availability-zone

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

<rwcal:availability-zone xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
</rwcal:availability-zone>

rwcal:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:server-group

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:server-group

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

<rwcal:server-group xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
</rwcal:server-group>

rwcal:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:host-aggregate

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:host-aggregate[rwcal:metadata-key='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

<rwcal:host-aggregate xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:metadata-key>STRING</rwcal:metadata-key>
  <rwcal:metadata-value>STRING</rwcal:metadata-value>
</rwcal:host-aggregate>

rwcal:connection-points

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:connection-points

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:connection-points[rwcal:connection-point-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/connection-points/STRING

Fields

Name	Type	Description
connection-point-id	STRING
name	STRING	Name of the connection point
virtual-link-id	STRING	CAL assigned resource ID of the Virtual-Link
vdu-id	STRING	CAL assigned id for VDU to which this connection point belongs
state	ENUM	CMP agnostic generic state of the connection point
ip-address	UNION
public-ip	STRING
mac-addr	STRING
port-order	UINT32	Port Sequence Order
virtual-cp-info	LIST

JSON Sample

[
  {
    "connection-point-id": "STRING",
    "name": "STRING",
    "virtual-link-id": "STRING",
    "vdu-id": "STRING",
    "state": "active",
    "ip-address": "UNION_VALUE",
    "public-ip": "STRING",
    "mac-addr": "STRING",
    "port-order": 0,
    "virtual-cp-info": [
      {
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rwcal:connection-points xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:connection-point-id>STRING</rwcal:connection-point-id>
  <rwcal:name>STRING</rwcal:name>
  <rwcal:virtual-link-id>STRING</rwcal:virtual-link-id>
  <rwcal:vdu-id>STRING</rwcal:vdu-id>
  <rwcal:state>active</rwcal:state>
  <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
  <rwcal:public-ip>STRING</rwcal:public-ip>
  <rwcal:mac-addr>STRING</rwcal:mac-addr>
  <rwcal:port-order>0</rwcal:port-order>
  <rwcal:virtual-cp-info>
    <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
    <rwcal:mac-address>STRING</rwcal:mac-address>
  </rwcal:virtual-cp-info>
</rwcal:connection-points>

rwcal:virtual-cp-info

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:connection-points/rwcal:virtual-cp-info

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:connection-points[rwcal:connection-point-id='STRING']/rwcal:virtual-cp-info[rwcal:ip-address='UNION_VALUE']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/connection-points/STRING/virtual-cp-info/UNION_VALUE

Fields

Name	Type	Description
ip-address	UNION
mac-address	STRING

JSON Sample

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

XML Sample

<rwcal:virtual-cp-info xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:ip-address>UNION_VALUE</rwcal:ip-address>
  <rwcal:mac-address>STRING</rwcal:mac-address>
</rwcal:virtual-cp-info>

rwcal:supplemental-boot-data

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:supplemental-boot-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:supplemental-boot-data

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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
custom-meta-data	LIST	List of meta-data to be associated with the instance

JSON Sample

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false,
  "custom-meta-data": [
    {
      "name": "STRING",
      "data-type": "STRING",
      "value": "STRING",
      "destination": "CLOUD_METADATA"
    }, {
      ...
    }
  ]
}

XML Sample

<rwcal:supplemental-boot-data xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:config-file>
    <rwcal:source>STRING</rwcal:source>
    <rwcal:dest>STRING</rwcal:dest>
  </rwcal:config-file>
  <rwcal:boot-data-drive>false</rwcal:boot-data-drive>
  <rwcal:custom-meta-data>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:data-type>STRING</rwcal:data-type>
    <rwcal:value>STRING</rwcal:value>
    <rwcal:destination>CLOUD_METADATA</rwcal:destination>
  </rwcal:custom-meta-data>
</rwcal:supplemental-boot-data>

rwcal:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:supplemental-boot-data/rwcal:config-file

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:supplemental-boot-data/rwcal:config-file[rwcal:source='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/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

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

rwcal:custom-meta-data

List of meta-data to be associated with the instance

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:supplemental-boot-data/rwcal:custom-meta-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:supplemental-boot-data/rwcal:custom-meta-data[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/supplemental-boot-data/custom-meta-data/STRING

Fields

Name	Type	Description
name	STRING	Name of the meta-data parameter
data-type	ENUM	Data-type the meta-data parameter
value	STRING	Value of the meta-data parameter
destination	ENUM	Type of input parameter

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "value": "STRING",
    "destination": "CLOUD_METADATA"
  }, {
    ...
  }
]

XML Sample

<rwcal:custom-meta-data xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:data-type>STRING</rwcal:data-type>
  <rwcal:value>STRING</rwcal:value>
  <rwcal:destination>CLOUD_METADATA</rwcal:destination>
</rwcal:custom-meta-data>

rwcal:volumes

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:volumes

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:volumes[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/volumes/STRING

Fields

Name	Type	Description
name	STRING	Name of the disk-volumes, e.g. vda, vdb etc
volume-id	STRING	CAL assigned volume-id
custom-meta-data	LIST	List of meta-data to be associated with the instance

JSON Sample

[
  {
    "name": "STRING",
    "volume-id": "STRING",
    "custom-meta-data": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "value": "STRING",
        "destination": "CLOUD_METADATA"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rwcal:volumes xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:volume-id>STRING</rwcal:volume-id>
  <rwcal:custom-meta-data>
    <rwcal:name>STRING</rwcal:name>
    <rwcal:data-type>STRING</rwcal:data-type>
    <rwcal:value>STRING</rwcal:value>
    <rwcal:destination>CLOUD_METADATA</rwcal:destination>
  </rwcal:custom-meta-data>
</rwcal:volumes>

rwcal:custom-meta-data

List of meta-data to be associated with the instance

Key Identifiers:

XPath Path

/rw-project:project/rwcal:vnf-resources/rwcal:vdu-info-list/rwcal:volumes/rwcal:custom-meta-data

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwcal:vnf-resources/rwcal:vdu-info-list[rwcal:vdu-id='STRING']/rwcal:volumes[rwcal:name='STRING']/rwcal:custom-meta-data[rwcal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwcal:vnf-resources/vdu-info-list/STRING/volumes/STRING/custom-meta-data/STRING

Fields

Name	Type	Description
name	STRING	Name of the meta-data parameter
data-type	ENUM	Data-type the meta-data parameter
value	STRING	Value of the meta-data parameter
destination	ENUM	Type of input parameter

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "value": "STRING",
    "destination": "CLOUD_METADATA"
  }, {
    ...
  }
]

XML Sample

<rwcal:custom-meta-data xmlns:rwcal="http://riftio.com/ns/riftware-1.0/rwcal">
  <rwcal:name>STRING</rwcal:name>
  <rwcal:data-type>STRING</rwcal:data-type>
  <rwcal:value>STRING</rwcal:value>
  <rwcal:destination>CLOUD_METADATA</rwcal:destination>
</rwcal:custom-meta-data>

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
vlr	LIST

JSON Sample

{
  "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",
      "rw-vlr:datacenter": "STRING",
      "rw-vlr:network_pool": "STRING",
      "rw-vlr:assigned-subnet": "STRING",
      "rw-vlr:operational-status-details": "STRING",
      "rw-vlr:virtual-connection-points": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<vlr:vlr-catalog xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <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>
    <rw-vlr:datacenter xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:datacenter>
    <rw-vlr:network_pool xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:network_pool>
    <rw-vlr:assigned-subnet xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:assigned-subnet>
    <rw-vlr:operational-status-details xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:operational-status-details>
    <rw-vlr:virtual-connection-points xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">...</rw-vlr:virtual-connection-points>
  </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.
datacenter	STRING	Datacenter name to use when instantiating the network service.
network_pool	STRING	The network pool the resource was allocated from.
assigned-subnet	STRING	Subnet added for the VL
operational-status-details	STRING	The error message in case of a failed VLR operational status
virtual-connection-points	LIST

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",
      "overlay-type": "LOCAL",
      "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",
    "rw-vlr:datacenter": "STRING",
    "rw-vlr:network_pool": "STRING",
    "rw-vlr:assigned-subnet": "STRING",
    "rw-vlr:operational-status-details": "STRING",
    "rw-vlr:virtual-connection-points": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "associated-cps": [ "STRING", ... ],
        "connection-point-id": "STRING",
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

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:overlay-type>LOCAL</vlr:overlay-type>
    <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>
  <rw-vlr:datacenter xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:datacenter>
  <rw-vlr:network_pool xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:network_pool>
  <rw-vlr:assigned-subnet xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:assigned-subnet>
  <rw-vlr:operational-status-details xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:operational-status-details>
  <rw-vlr:virtual-connection-points xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">
    <rw-vlr:name>STRING</rw-vlr:name>
    <rw-vlr:id>STRING</rw-vlr:id>
    <rw-vlr:short-name>STRING</rw-vlr:short-name>
    <rw-vlr:type>VPORT</rw-vlr:type>
    <rw-vlr:port-security-enabled>true</rw-vlr:port-security-enabled>
    <rw-vlr:associated-cps>STRING</rw-vlr:associated-cps>
    <rw-vlr:associated-cps>...</rw-vlr:associated-cps>
    <rw-vlr:connection-point-id>STRING</rw-vlr:connection-point-id>
    <rw-vlr:ip-address>UNION_VALUE</rw-vlr:ip-address>
    <rw-vlr:mac-address>STRING</rw-vlr:mac-address>
  </rw-vlr:virtual-connection-points>
</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.
overlay-type	ENUM	Type of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels PORTGROUP - Provider networks implemented for VIO support
segmentation_id	UINT32	ID of segregated virtual networks

JSON Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "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:overlay-type>LOCAL</vlr:overlay-type>
  <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>

rw-vlr:virtual-connection-points

Key Identifiers:

XPath Path

/rw-project:project/vlr:vlr-catalog/vlr:vlr/rw-vlr:virtual-connection-points

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/rw-vlr:virtual-connection-points[rw-vlr:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/rw-vlr:virtual-connection-points/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
associated-cps	LEAF_LIST
connection-point-id	STRING	VIM identifier for connection point
ip-address	UNION	IP Address of virtual connection point
mac-address	STRING	MAC Address of the virtual connection point

JSON Config Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "associated-cps": [ "STRING", ... ],
    "connection-point-id": "STRING",
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "associated-cps": [ "STRING", ... ],
    "connection-point-id": "STRING",
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rw-vlr:virtual-connection-points xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">
  <rw-vlr:name>STRING</rw-vlr:name>
  <rw-vlr:id>STRING</rw-vlr:id>
  <rw-vlr:short-name>STRING</rw-vlr:short-name>
  <rw-vlr:type>VPORT</rw-vlr:type>
  <rw-vlr:port-security-enabled>true</rw-vlr:port-security-enabled>
  <rw-vlr:associated-cps>STRING</rw-vlr:associated-cps>
  <rw-vlr:associated-cps>...</rw-vlr:associated-cps>
  <rw-vlr:connection-point-id>STRING</rw-vlr:connection-point-id>
  <rw-vlr:ip-address>UNION_VALUE</rw-vlr:ip-address>
  <rw-vlr:mac-address>STRING</rw-vlr:mac-address>
</rw-vlr:virtual-connection-points>

XML Sample

<rw-vlr:virtual-connection-points xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">
  <rw-vlr:name>STRING</rw-vlr:name>
  <rw-vlr:id>STRING</rw-vlr:id>
  <rw-vlr:short-name>STRING</rw-vlr:short-name>
  <rw-vlr:type>VPORT</rw-vlr:type>
  <rw-vlr:port-security-enabled>true</rw-vlr:port-security-enabled>
  <rw-vlr:associated-cps>STRING</rw-vlr:associated-cps>
  <rw-vlr:associated-cps>...</rw-vlr:associated-cps>
  <rw-vlr:connection-point-id>STRING</rw-vlr:connection-point-id>
  <rw-vlr:ip-address>UNION_VALUE</rw-vlr:ip-address>
  <rw-vlr:mac-address>STRING</rw-vlr:mac-address>
</rw-vlr:virtual-connection-points>

rw-vlr:associated-cps

Key Identifiers:

XPath Path

/rw-project:project/vlr:vlr-catalog/vlr:vlr/rw-vlr:virtual-connection-points/rw-vlr:associated-cps

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/rw-vlr:virtual-connection-points[rw-vlr:name='STRING']/rw-vlr:associated-cps

RW.REST URI Path

/rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/rw-vlr:virtual-connection-points/STRING/associated-cps

JSON Config Sample

[ "STRING", ... ]

JSON Sample

[ "STRING", ... ]

XML Config Sample

<rw-vlr:associated-cps xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:associated-cps>
<rw-vlr:associated-cps xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">...</rw-vlr:associated-cps>

XML Sample

<rw-vlr:associated-cps xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:associated-cps>
<rw-vlr:associated-cps xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">...</rw-vlr:associated-cps>

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": { ... },
      "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": { ... },
      "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: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: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	Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.
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": [ { ... }, { ... } ]
    },
    "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": { ... },
        "image": "STRING",
        "image-checksum": "STRING",
        "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": [ { ... }, { ... } ]
    },
    "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": { ... },
        "image": "STRING",
        "image-checksum": "STRING",
        "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: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:image>STRING</project-vnfd:image>
    <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
    <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: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:image>STRING</project-vnfd:image>
    <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
    <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

Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different 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.
initial-config-primitive	LIST	Initial set of configuration primitives.

JSON Config Sample

{
  "script": {
    "script-type": "rift"
  },
  "juju": {
    "charm": "STRING"
  },
  "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"
  },
  "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: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: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.

JSON Config Sample

{
  "charm": "STRING"
}

JSON Sample

{
  "charm": "STRING"
}

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: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:juju>

project-vnfd:config-primitive

List of config primitives supported by the configuration agent for this VNF.

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"
      }, {
        ...
      }
    ],
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "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"
      }, {
        ...
      }
    ],
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "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:internal-connection-point>
  <project-vnfd:provider-network>
    <project-vnfd:physical-network>STRING</project-vnfd:physical-network>
    <project-vnfd:overlay-type>LOCAL</project-vnfd:overlay-type>
    <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:internal-connection-point>
  <project-vnfd:provider-network>
    <project-vnfd:physical-network>STRING</project-vnfd:physical-network>
    <project-vnfd:overlay-type>LOCAL</project-vnfd:overlay-type>
    <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

JSON Config Sample

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

JSON Sample

[
  {
    "id-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-ref>STRING</project-vnfd:id-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-ref>STRING</project-vnfd:id-ref>
</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.
overlay-type	ENUM	Type of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels PORTGROUP - Provider networks implemented for VIO support
segmentation_id	UINT32	ID of segregated virtual networks

JSON Config Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

JSON Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "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:overlay-type>LOCAL</project-vnfd:overlay-type>
  <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:overlay-type>LOCAL</project-vnfd:overlay-type>
  <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.
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.
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": [ { ... }, { ... } ]
    },
    "image": "STRING",
    "image-checksum": "STRING",
    "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",
        "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": [ { ... }, { ... } ]
    },
    "image": "STRING",
    "image-checksum": "STRING",
    "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",
        "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:image>STRING</project-vnfd:image>
  <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
  <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: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:image>STRING</project-vnfd:image>
  <project-vnfd:image-checksum>STRING</project-vnfd:image-checksum>
  <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: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

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: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
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",
    "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",
    "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: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: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 : Used to specify openmano mgmt external-connection type
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>

vld:vld-catalog

Key Identifiers:

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

Fields

Name	Type	Description
vld	LIST

JSON Config Sample

{
  "vld": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "type": "ELAN",
      "root-bandwidth": 0,
      "leaf-bandwidth": 0,
      "vnfd-connection-point-ref": [ { ... }, { ... } ],
      "provider-network": { ... }
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "vld": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "type": "ELAN",
      "root-bandwidth": 0,
      "leaf-bandwidth": 0,
      "vnfd-connection-point-ref": [ { ... }, { ... } ],
      "provider-network": { ... }
    }, {
      ...
    }
  ]
}

XML Config Sample

<vld:vld-catalog xmlns:vld="urn:ietf:params:xml:ns:yang:nfvo:vld">
  <vld:vld>
    <vld:id>STRING</vld:id>
    <vld:name>STRING</vld:name>
    <vld:short-name>STRING</vld:short-name>
    <vld:vendor>STRING</vld:vendor>
    <vld:description>STRING</vld:description>
    <vld:version>STRING</vld:version>
    <vld:type>ELAN</vld:type>
    <vld:root-bandwidth>0</vld:root-bandwidth>
    <vld:leaf-bandwidth>0</vld:leaf-bandwidth>
    <vld:vnfd-connection-point-ref>...</vld:vnfd-connection-point-ref>
    <vld:provider-network>...</vld:provider-network>
  </vld:vld>
</vld:vld-catalog>

XML Sample

<vld:vld-catalog xmlns:vld="urn:ietf:params:xml:ns:yang:nfvo:vld">
  <vld:vld>
    <vld:id>STRING</vld:id>
    <vld:name>STRING</vld:name>
    <vld:short-name>STRING</vld:short-name>
    <vld:vendor>STRING</vld:vendor>
    <vld:description>STRING</vld:description>
    <vld:version>STRING</vld:version>
    <vld:type>ELAN</vld:type>
    <vld:root-bandwidth>0</vld:root-bandwidth>
    <vld:leaf-bandwidth>0</vld:leaf-bandwidth>
    <vld:vnfd-connection-point-ref>...</vld:vnfd-connection-point-ref>
    <vld:provider-network>...</vld:provider-network>
  </vld:vld>
</vld:vld-catalog>

vld:vld

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING	Identifier for the VLD.
name	STRING	Virtual Link Descriptor (VLD) name.
short-name	STRING	Short name for VLD for 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.
vnfd-connection-point-ref	LIST	A list of references to connection points.
provider-network	CONTAINER	Container for the provider network.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

<vld:vld xmlns:vld="urn:ietf:params:xml:ns:yang:nfvo:vld">
  <vld:id>STRING</vld:id>
  <vld:name>STRING</vld:name>
  <vld:short-name>STRING</vld:short-name>
  <vld:vendor>STRING</vld:vendor>
  <vld:description>STRING</vld:description>
  <vld:version>STRING</vld:version>
  <vld:type>ELAN</vld:type>
  <vld:root-bandwidth>0</vld:root-bandwidth>
  <vld:leaf-bandwidth>0</vld:leaf-bandwidth>
  <vld:vnfd-connection-point-ref>
    <vld:vnfd-ref>STRING</vld:vnfd-ref>
    <vld:member-vnf-index-ref>0</vld:member-vnf-index-ref>
    <vld:vnfd-connection-point-ref>STRING</vld:vnfd-connection-point-ref>
  </vld:vnfd-connection-point-ref>
  <vld:provider-network>
    <vld:physical-network>STRING</vld:physical-network>
    <vld:overlay-type>LOCAL</vld:overlay-type>
    <vld:segmentation_id>0</vld:segmentation_id>
  </vld:provider-network>
</vld:vld>

XML Sample

<vld:vld xmlns:vld="urn:ietf:params:xml:ns:yang:nfvo:vld">
  <vld:id>STRING</vld:id>
  <vld:name>STRING</vld:name>
  <vld:short-name>STRING</vld:short-name>
  <vld:vendor>STRING</vld:vendor>
  <vld:description>STRING</vld:description>
  <vld:version>STRING</vld:version>
  <vld:type>ELAN</vld:type>
  <vld:root-bandwidth>0</vld:root-bandwidth>
  <vld:leaf-bandwidth>0</vld:leaf-bandwidth>
  <vld:vnfd-connection-point-ref>
    <vld:vnfd-ref>STRING</vld:vnfd-ref>
    <vld:member-vnf-index-ref>0</vld:member-vnf-index-ref>
    <vld:vnfd-connection-point-ref>STRING</vld:vnfd-connection-point-ref>
  </vld:vnfd-connection-point-ref>
  <vld:provider-network>
    <vld:physical-network>STRING</vld:physical-network>
    <vld:overlay-type>LOCAL</vld:overlay-type>
    <vld:segmentation_id>0</vld:segmentation_id>
  </vld:provider-network>
</vld:vld>

vld:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

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

XPath Keyed Path

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

RW.REST URI Path

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

Fields

Name	Type	Description
vnfd-ref	LEAFREF	A reference to a vnfd
member-vnf-index-ref	UINT64	A reference to the consituent-vnfd id in nsd. Should have been a leafref to: '/rw-project:project/project-nsd:nsd-catalog:/nsd/constituent-vnfd/member-vnf-index-ref'. Instead using direct leaf to avoid circular reference.
vnfd-connection-point-ref	LEAFREF	A reference to a connection point name in a vnfd

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

vld:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

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

XPath Keyed Path

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

RW.REST URI Path

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

Fields

Name	Type	Description
physical-network	STRING	Name of the physical network on which the provider network is built.
overlay-type	ENUM	Type of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels PORTGROUP - Provider networks implemented for VIO support
segmentation_id	UINT32	ID of segregated virtual networks

JSON Config Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

JSON Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

XML Config Sample

<vld:provider-network xmlns:vld="urn:ietf:params:xml:ns:yang:nfvo:vld">
  <vld:physical-network>STRING</vld:physical-network>
  <vld:overlay-type>LOCAL</vld:overlay-type>
  <vld:segmentation_id>0</vld:segmentation_id>
</vld:provider-network>

XML Sample

<vld:provider-network xmlns:vld="urn:ietf:params:xml:ns:yang:nfvo:vld">
  <vld:physical-network>STRING</vld:physical-network>
  <vld:overlay-type>LOCAL</vld:overlay-type>
  <vld:segmentation_id>0</vld:segmentation_id>
</vld:provider-network>

rwsdnal:sdn-accounts

Key Identifiers:

XPath Path	/rw-project:project/rwsdnal:sdn-accounts
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts
RW.REST URI Path	/rw-project:project/STRING/rwsdnal:sdn-accounts

Fields

Name	Type	Description
sdn-account-list	LIST

JSON Config Sample

{
  "sdn-account-list": [
    {
      "name": "STRING",
      "account-type": "odl",
      "odl": { ... },
      "mock": { ... },
      "sdnsim": { ... },
      "openstack": { ... }
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "sdn-account-list": [
    {
      "name": "STRING",
      "account-type": "odl",
      "odl": { ... },
      "mock": { ... },
      "sdnsim": { ... },
      "openstack": { ... },
      "connection-status": { ... }
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwsdnal:sdn-accounts xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:sdn-account-list>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:account-type>odl</rwsdnal:account-type>
    <rwsdnal:odl>...</rwsdnal:odl>
    <rwsdnal:mock>...</rwsdnal:mock>
    <rwsdnal:sdnsim>...</rwsdnal:sdnsim>
    <rwsdnal:openstack>...</rwsdnal:openstack>
  </rwsdnal:sdn-account-list>
</rwsdnal:sdn-accounts>

XML Sample

<rwsdnal:sdn-accounts xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:sdn-account-list>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:account-type>odl</rwsdnal:account-type>
    <rwsdnal:odl>...</rwsdnal:odl>
    <rwsdnal:mock>...</rwsdnal:mock>
    <rwsdnal:sdnsim>...</rwsdnal:sdnsim>
    <rwsdnal:openstack>...</rwsdnal:openstack>
    <rwsdnal:connection-status>...</rwsdnal:connection-status>
  </rwsdnal:sdn-account-list>
</rwsdnal:sdn-accounts>

rwsdnal:sdn-account-list

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING

Fields

Name	Type	Description
name	STRING
account-type	ENUM
odl	CONTAINER
mock	CONTAINER
sdnsim	CONTAINER
openstack	CONTAINER
connection-status	CONTAINER

JSON Config Sample

[
  {
    "name": "STRING",
    "account-type": "odl",
    "odl": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwsdn_odl"
    },
    "mock": {
      "username": "STRING",
      "plugin-name": "rwsdn_mock"
    },
    "sdnsim": {
      "username": "STRING",
      "topology-source": "STRING",
      "plugin-name": "rwsdn_sim"
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "tenant": "STRING",
      "admin": false,
      "user-domain": "Default",
      "project-domain": "Default",
      "region": "RegionOne",
      "plugin-name": "rwsdn_openstack",
      "cert-validate": false
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "account-type": "odl",
    "odl": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwsdn_odl"
    },
    "mock": {
      "username": "STRING",
      "plugin-name": "rwsdn_mock"
    },
    "sdnsim": {
      "username": "STRING",
      "topology-source": "STRING",
      "plugin-name": "rwsdn_sim"
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "tenant": "STRING",
      "admin": false,
      "user-domain": "Default",
      "project-domain": "Default",
      "region": "RegionOne",
      "plugin-name": "rwsdn_openstack",
      "cert-validate": false
    },
    "connection-status": {
      "status": "unknown",
      "details": "STRING"
    }
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:sdn-account-list xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:account-type>odl</rwsdnal:account-type>
  <rwsdnal:odl>
    <rwsdnal:username>STRING</rwsdnal:username>
    <rwsdnal:password>STRING</rwsdnal:password>
    <rwsdnal:url>STRING</rwsdnal:url>
    <rwsdnal:plugin-name>rwsdn_odl</rwsdnal:plugin-name>
  </rwsdnal:odl>
  <rwsdnal:mock>
    <rwsdnal:username>STRING</rwsdnal:username>
    <rwsdnal:plugin-name>rwsdn_mock</rwsdnal:plugin-name>
  </rwsdnal:mock>
  <rwsdnal:sdnsim>
    <rwsdnal:username>STRING</rwsdnal:username>
    <rwsdnal:topology-source>STRING</rwsdnal:topology-source>
    <rwsdnal:plugin-name>rwsdn_sim</rwsdnal:plugin-name>
  </rwsdnal:sdnsim>
  <rwsdnal:openstack>
    <rwsdnal:key>STRING</rwsdnal:key>
    <rwsdnal:secret>STRING</rwsdnal:secret>
    <rwsdnal:auth_url>STRING</rwsdnal:auth_url>
    <rwsdnal:tenant>STRING</rwsdnal:tenant>
    <rwsdnal:admin>false</rwsdnal:admin>
    <rwsdnal:user-domain>Default</rwsdnal:user-domain>
    <rwsdnal:project-domain>Default</rwsdnal:project-domain>
    <rwsdnal:region>RegionOne</rwsdnal:region>
    <rwsdnal:plugin-name>rwsdn_openstack</rwsdnal:plugin-name>
    <rwsdnal:cert-validate>false</rwsdnal:cert-validate>
  </rwsdnal:openstack>
</rwsdnal:sdn-account-list>

XML Sample

<rwsdnal:sdn-account-list xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:account-type>odl</rwsdnal:account-type>
  <rwsdnal:odl>
    <rwsdnal:username>STRING</rwsdnal:username>
    <rwsdnal:password>STRING</rwsdnal:password>
    <rwsdnal:url>STRING</rwsdnal:url>
    <rwsdnal:plugin-name>rwsdn_odl</rwsdnal:plugin-name>
  </rwsdnal:odl>
  <rwsdnal:mock>
    <rwsdnal:username>STRING</rwsdnal:username>
    <rwsdnal:plugin-name>rwsdn_mock</rwsdnal:plugin-name>
  </rwsdnal:mock>
  <rwsdnal:sdnsim>
    <rwsdnal:username>STRING</rwsdnal:username>
    <rwsdnal:topology-source>STRING</rwsdnal:topology-source>
    <rwsdnal:plugin-name>rwsdn_sim</rwsdnal:plugin-name>
  </rwsdnal:sdnsim>
  <rwsdnal:openstack>
    <rwsdnal:key>STRING</rwsdnal:key>
    <rwsdnal:secret>STRING</rwsdnal:secret>
    <rwsdnal:auth_url>STRING</rwsdnal:auth_url>
    <rwsdnal:tenant>STRING</rwsdnal:tenant>
    <rwsdnal:admin>false</rwsdnal:admin>
    <rwsdnal:user-domain>Default</rwsdnal:user-domain>
    <rwsdnal:project-domain>Default</rwsdnal:project-domain>
    <rwsdnal:region>RegionOne</rwsdnal:region>
    <rwsdnal:plugin-name>rwsdn_openstack</rwsdnal:plugin-name>
    <rwsdnal:cert-validate>false</rwsdnal:cert-validate>
  </rwsdnal:openstack>
  <rwsdnal:connection-status>
    <rwsdnal:status>unknown</rwsdnal:status>
    <rwsdnal:details>STRING</rwsdnal:details>
  </rwsdnal:connection-status>
</rwsdnal:sdn-account-list>

rwsdnal:odl

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:odl

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:odl

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/odl

Fields

Name	Type	Description
username	STRING
password	STRING
url	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwsdn_odl"
}

JSON Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwsdn_odl"
}

XML Config Sample

<rwsdnal:odl xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:username>STRING</rwsdnal:username>
  <rwsdnal:password>STRING</rwsdnal:password>
  <rwsdnal:url>STRING</rwsdnal:url>
  <rwsdnal:plugin-name>rwsdn_odl</rwsdnal:plugin-name>
</rwsdnal:odl>

XML Sample

<rwsdnal:odl xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:username>STRING</rwsdnal:username>
  <rwsdnal:password>STRING</rwsdnal:password>
  <rwsdnal:url>STRING</rwsdnal:url>
  <rwsdnal:plugin-name>rwsdn_odl</rwsdnal:plugin-name>
</rwsdnal:odl>

rwsdnal:mock

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:mock

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:mock

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/mock

Fields

Name	Type	Description
username	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "plugin-name": "rwsdn_mock"
}

JSON Sample

{
  "username": "STRING",
  "plugin-name": "rwsdn_mock"
}

XML Config Sample

<rwsdnal:mock xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:username>STRING</rwsdnal:username>
  <rwsdnal:plugin-name>rwsdn_mock</rwsdnal:plugin-name>
</rwsdnal:mock>

XML Sample

<rwsdnal:mock xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:username>STRING</rwsdnal:username>
  <rwsdnal:plugin-name>rwsdn_mock</rwsdnal:plugin-name>
</rwsdnal:mock>

rwsdnal:sdnsim

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:sdnsim

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:sdnsim

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/sdnsim

Fields

Name	Type	Description
username	STRING
topology-source	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "topology-source": "STRING",
  "plugin-name": "rwsdn_sim"
}

JSON Sample

{
  "username": "STRING",
  "topology-source": "STRING",
  "plugin-name": "rwsdn_sim"
}

XML Config Sample

<rwsdnal:sdnsim xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:username>STRING</rwsdnal:username>
  <rwsdnal:topology-source>STRING</rwsdnal:topology-source>
  <rwsdnal:plugin-name>rwsdn_sim</rwsdnal:plugin-name>
</rwsdnal:sdnsim>

XML Sample

<rwsdnal:sdnsim xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:username>STRING</rwsdnal:username>
  <rwsdnal:topology-source>STRING</rwsdnal:topology-source>
  <rwsdnal:plugin-name>rwsdn_sim</rwsdnal:plugin-name>
</rwsdnal:sdnsim>

rwsdnal:openstack

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:openstack

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:openstack

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/openstack

Fields

Name	Type	Description
key	STRING
secret	STRING
auth_url	STRING
tenant	STRING
admin	BOOLEAN
user-domain	STRING	Domain of the OpenStack user
project-domain	STRING	Domain of the OpenStack project
region	STRING
plugin-name	STRING
cert-validate	BOOLEAN	Certificate validatation policy in case of SSL/TLS connection

JSON Config Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "tenant": "STRING",
  "admin": false,
  "user-domain": "Default",
  "project-domain": "Default",
  "region": "RegionOne",
  "plugin-name": "rwsdn_openstack",
  "cert-validate": false
}

JSON Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "tenant": "STRING",
  "admin": false,
  "user-domain": "Default",
  "project-domain": "Default",
  "region": "RegionOne",
  "plugin-name": "rwsdn_openstack",
  "cert-validate": false
}

XML Config Sample

<rwsdnal:openstack xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:key>STRING</rwsdnal:key>
  <rwsdnal:secret>STRING</rwsdnal:secret>
  <rwsdnal:auth_url>STRING</rwsdnal:auth_url>
  <rwsdnal:tenant>STRING</rwsdnal:tenant>
  <rwsdnal:admin>false</rwsdnal:admin>
  <rwsdnal:user-domain>Default</rwsdnal:user-domain>
  <rwsdnal:project-domain>Default</rwsdnal:project-domain>
  <rwsdnal:region>RegionOne</rwsdnal:region>
  <rwsdnal:plugin-name>rwsdn_openstack</rwsdnal:plugin-name>
  <rwsdnal:cert-validate>false</rwsdnal:cert-validate>
</rwsdnal:openstack>

XML Sample

<rwsdnal:openstack xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:key>STRING</rwsdnal:key>
  <rwsdnal:secret>STRING</rwsdnal:secret>
  <rwsdnal:auth_url>STRING</rwsdnal:auth_url>
  <rwsdnal:tenant>STRING</rwsdnal:tenant>
  <rwsdnal:admin>false</rwsdnal:admin>
  <rwsdnal:user-domain>Default</rwsdnal:user-domain>
  <rwsdnal:project-domain>Default</rwsdnal:project-domain>
  <rwsdnal:region>RegionOne</rwsdnal:region>
  <rwsdnal:plugin-name>rwsdn_openstack</rwsdnal:plugin-name>
  <rwsdnal:cert-validate>false</rwsdnal:cert-validate>
</rwsdnal:openstack>

rwsdnal:connection-status

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list/rwsdnal:connection-status

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:sdn-accounts/rwsdnal:sdn-account-list[rwsdnal:name='STRING']/rwsdnal:connection-status

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:sdn-accounts/sdn-account-list/STRING/connection-status

Fields

Name	Type	Description
status	ENUM
details	STRING

JSON Sample

{
  "status": "unknown",
  "details": "STRING"
}

XML Sample

<rwsdnal:connection-status xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:status>unknown</rwsdnal:status>
  <rwsdnal:details>STRING</rwsdnal:details>
</rwsdnal:connection-status>

rwsdnal:vnffgs

Key Identifiers:

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

Fields

Name	Type	Description
vnffg-chain	LIST

JSON Config Sample

{
  "vnffg-chain": [
    {
      "name": "STRING",
      "vnf-chain-path": [ { ... }, { ... } ],
      "sff": [ { ... }, { ... } ],
      "classifier-name": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "vnffg-chain": [
    {
      "name": "STRING",
      "vnf-chain-path": [ { ... }, { ... } ],
      "sff": [ { ... }, { ... } ],
      "classifier-name": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwsdnal:vnffgs xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnffg-chain>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:vnf-chain-path>...</rwsdnal:vnf-chain-path>
    <rwsdnal:sff>...</rwsdnal:sff>
    <rwsdnal:classifier-name>STRING</rwsdnal:classifier-name>
  </rwsdnal:vnffg-chain>
</rwsdnal:vnffgs>

XML Sample

<rwsdnal:vnffgs xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnffg-chain>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:vnf-chain-path>...</rwsdnal:vnf-chain-path>
    <rwsdnal:sff>...</rwsdnal:sff>
    <rwsdnal:classifier-name>STRING</rwsdnal:classifier-name>
  </rwsdnal:vnffg-chain>
</rwsdnal:vnffgs>

rwsdnal:vnffg-chain

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING

Fields

Name	Type	Description
name	STRING
vnf-chain-path	LIST
sff	LIST
classifier-name	STRING

JSON Config Sample

[
  {
    "name": "STRING",
    "vnf-chain-path": [
      {
        "order": 0,
        "service-function-type": "STRING",
        "nsh-aware": true,
        "transport-type": "STRING",
        "vnfr-ids": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "sff": [
      {
        "name": "STRING",
        "function-type": "STRING",
        "mgmt-address": "UNION_VALUE",
        "mgmt-port": 0,
        "dp-endpoints": [ { ... }, { ... } ],
        "vnfr-list": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier-name": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "vnf-chain-path": [
      {
        "order": 0,
        "service-function-type": "STRING",
        "nsh-aware": true,
        "transport-type": "STRING",
        "vnfr-ids": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "sff": [
      {
        "name": "STRING",
        "function-type": "STRING",
        "mgmt-address": "UNION_VALUE",
        "mgmt-port": 0,
        "dp-endpoints": [ { ... }, { ... } ],
        "vnfr-list": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier-name": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:vnffg-chain xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:vnf-chain-path>
    <rwsdnal:order>0</rwsdnal:order>
    <rwsdnal:service-function-type>STRING</rwsdnal:service-function-type>
    <rwsdnal:nsh-aware>true</rwsdnal:nsh-aware>
    <rwsdnal:transport-type>STRING</rwsdnal:transport-type>
    <rwsdnal:vnfr-ids>...</rwsdnal:vnfr-ids>
  </rwsdnal:vnf-chain-path>
  <rwsdnal:sff>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:function-type>STRING</rwsdnal:function-type>
    <rwsdnal:mgmt-address>UNION_VALUE</rwsdnal:mgmt-address>
    <rwsdnal:mgmt-port>0</rwsdnal:mgmt-port>
    <rwsdnal:dp-endpoints>...</rwsdnal:dp-endpoints>
    <rwsdnal:vnfr-list>...</rwsdnal:vnfr-list>
  </rwsdnal:sff>
  <rwsdnal:classifier-name>STRING</rwsdnal:classifier-name>
</rwsdnal:vnffg-chain>

XML Sample

<rwsdnal:vnffg-chain xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:vnf-chain-path>
    <rwsdnal:order>0</rwsdnal:order>
    <rwsdnal:service-function-type>STRING</rwsdnal:service-function-type>
    <rwsdnal:nsh-aware>true</rwsdnal:nsh-aware>
    <rwsdnal:transport-type>STRING</rwsdnal:transport-type>
    <rwsdnal:vnfr-ids>...</rwsdnal:vnfr-ids>
  </rwsdnal:vnf-chain-path>
  <rwsdnal:sff>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:function-type>STRING</rwsdnal:function-type>
    <rwsdnal:mgmt-address>UNION_VALUE</rwsdnal:mgmt-address>
    <rwsdnal:mgmt-port>0</rwsdnal:mgmt-port>
    <rwsdnal:dp-endpoints>...</rwsdnal:dp-endpoints>
    <rwsdnal:vnfr-list>...</rwsdnal:vnfr-list>
  </rwsdnal:sff>
  <rwsdnal:classifier-name>STRING</rwsdnal:classifier-name>
</rwsdnal:vnffg-chain>

rwsdnal:vnf-chain-path

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:vnf-chain-path[rwsdnal:order='0']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/vnf-chain-path/0

Fields

Name	Type	Description
order	UINT32	Order of the VNF in VNFFG chain
service-function-type	STRING
nsh-aware	BOOLEAN
transport-type	STRING
vnfr-ids	LIST

JSON Config Sample

[
  {
    "order": 0,
    "service-function-type": "STRING",
    "nsh-aware": true,
    "transport-type": "STRING",
    "vnfr-ids": [
      {
        "vnfr-id": "STRING",
        "vnfr-name": "STRING",
        "mgmt-address": "UNION_VALUE",
        "mgmt-port": 0,
        "vdu-list": [ { ... }, { ... } ],
        "sff-name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "order": 0,
    "service-function-type": "STRING",
    "nsh-aware": true,
    "transport-type": "STRING",
    "vnfr-ids": [
      {
        "vnfr-id": "STRING",
        "vnfr-name": "STRING",
        "mgmt-address": "UNION_VALUE",
        "mgmt-port": 0,
        "vdu-list": [ { ... }, { ... } ],
        "sff-name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:vnf-chain-path xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:order>0</rwsdnal:order>
  <rwsdnal:service-function-type>STRING</rwsdnal:service-function-type>
  <rwsdnal:nsh-aware>true</rwsdnal:nsh-aware>
  <rwsdnal:transport-type>STRING</rwsdnal:transport-type>
  <rwsdnal:vnfr-ids>
    <rwsdnal:vnfr-id>STRING</rwsdnal:vnfr-id>
    <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
    <rwsdnal:mgmt-address>UNION_VALUE</rwsdnal:mgmt-address>
    <rwsdnal:mgmt-port>0</rwsdnal:mgmt-port>
    <rwsdnal:vdu-list>...</rwsdnal:vdu-list>
    <rwsdnal:sff-name>STRING</rwsdnal:sff-name>
  </rwsdnal:vnfr-ids>
</rwsdnal:vnf-chain-path>

XML Sample

<rwsdnal:vnf-chain-path xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:order>0</rwsdnal:order>
  <rwsdnal:service-function-type>STRING</rwsdnal:service-function-type>
  <rwsdnal:nsh-aware>true</rwsdnal:nsh-aware>
  <rwsdnal:transport-type>STRING</rwsdnal:transport-type>
  <rwsdnal:vnfr-ids>
    <rwsdnal:vnfr-id>STRING</rwsdnal:vnfr-id>
    <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
    <rwsdnal:mgmt-address>UNION_VALUE</rwsdnal:mgmt-address>
    <rwsdnal:mgmt-port>0</rwsdnal:mgmt-port>
    <rwsdnal:vdu-list>...</rwsdnal:vdu-list>
    <rwsdnal:sff-name>STRING</rwsdnal:sff-name>
  </rwsdnal:vnfr-ids>
</rwsdnal:vnf-chain-path>

rwsdnal:vnfr-ids

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path/rwsdnal:vnfr-ids

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:vnf-chain-path[rwsdnal:order='0']/rwsdnal:vnfr-ids[rwsdnal:vnfr-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/vnf-chain-path/0/vnfr-ids/STRING

Fields

Name	Type	Description
vnfr-id	STRING
vnfr-name	STRING
mgmt-address	UNION
mgmt-port	UINT16
vdu-list	LIST
sff-name	STRING	SFF name useful for non OVS based SFF

JSON Config Sample

[
  {
    "vnfr-id": "STRING",
    "vnfr-name": "STRING",
    "mgmt-address": "UNION_VALUE",
    "mgmt-port": 0,
    "vdu-list": [
      {
        "port-id": "STRING",
        "vm-id": "STRING",
        "name": "STRING",
        "address": "UNION_VALUE",
        "port": 0
      }, {
        ...
      }
    ],
    "sff-name": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfr-id": "STRING",
    "vnfr-name": "STRING",
    "mgmt-address": "UNION_VALUE",
    "mgmt-port": 0,
    "vdu-list": [
      {
        "port-id": "STRING",
        "vm-id": "STRING",
        "name": "STRING",
        "address": "UNION_VALUE",
        "port": 0
      }, {
        ...
      }
    ],
    "sff-name": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:vnfr-ids xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnfr-id>STRING</rwsdnal:vnfr-id>
  <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
  <rwsdnal:mgmt-address>UNION_VALUE</rwsdnal:mgmt-address>
  <rwsdnal:mgmt-port>0</rwsdnal:mgmt-port>
  <rwsdnal:vdu-list>
    <rwsdnal:vm-id>STRING</rwsdnal:vm-id>
    <rwsdnal:port-id>STRING</rwsdnal:port-id>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:address>UNION_VALUE</rwsdnal:address>
    <rwsdnal:port>0</rwsdnal:port>
  </rwsdnal:vdu-list>
  <rwsdnal:sff-name>STRING</rwsdnal:sff-name>
</rwsdnal:vnfr-ids>

XML Sample

<rwsdnal:vnfr-ids xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnfr-id>STRING</rwsdnal:vnfr-id>
  <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
  <rwsdnal:mgmt-address>UNION_VALUE</rwsdnal:mgmt-address>
  <rwsdnal:mgmt-port>0</rwsdnal:mgmt-port>
  <rwsdnal:vdu-list>
    <rwsdnal:vm-id>STRING</rwsdnal:vm-id>
    <rwsdnal:port-id>STRING</rwsdnal:port-id>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:address>UNION_VALUE</rwsdnal:address>
    <rwsdnal:port>0</rwsdnal:port>
  </rwsdnal:vdu-list>
  <rwsdnal:sff-name>STRING</rwsdnal:sff-name>
</rwsdnal:vnfr-ids>

rwsdnal:vdu-list

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:vnf-chain-path/rwsdnal:vnfr-ids/rwsdnal:vdu-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:vnf-chain-path[rwsdnal:order='0']/rwsdnal:vnfr-ids[rwsdnal:vnfr-id='STRING']/rwsdnal:vdu-list[rwsdnal:vm-id='STRING'][rwsdnal:port-id='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/vnf-chain-path/0/vnfr-ids/STRING/vdu-list/STRING,STRING

Fields

Name	Type	Description
port-id	STRING
vm-id	STRING
name	STRING
address	UNION
port	UINT16

JSON Config Sample

[
  {
    "port-id": "STRING",
    "vm-id": "STRING",
    "name": "STRING",
    "address": "UNION_VALUE",
    "port": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "port-id": "STRING",
    "vm-id": "STRING",
    "name": "STRING",
    "address": "UNION_VALUE",
    "port": 0
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:vdu-list xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vm-id>STRING</rwsdnal:vm-id>
  <rwsdnal:port-id>STRING</rwsdnal:port-id>
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:address>UNION_VALUE</rwsdnal:address>
  <rwsdnal:port>0</rwsdnal:port>
</rwsdnal:vdu-list>

XML Sample

<rwsdnal:vdu-list xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vm-id>STRING</rwsdnal:vm-id>
  <rwsdnal:port-id>STRING</rwsdnal:port-id>
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:address>UNION_VALUE</rwsdnal:address>
  <rwsdnal:port>0</rwsdnal:port>
</rwsdnal:vdu-list>

rwsdnal:sff

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/sff/STRING

Fields

Name	Type	Description
name	STRING
function-type	STRING
mgmt-address	UNION
mgmt-port	UINT16
dp-endpoints	LIST
vnfr-list	LIST

JSON Config Sample

[
  {
    "name": "STRING",
    "function-type": "STRING",
    "mgmt-address": "UNION_VALUE",
    "mgmt-port": 0,
    "dp-endpoints": [
      {
        "name": "STRING",
        "address": "UNION_VALUE",
        "port": 0
      }, {
        ...
      }
    ],
    "vnfr-list": [
      {
        "vnfr-name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "function-type": "STRING",
    "mgmt-address": "UNION_VALUE",
    "mgmt-port": 0,
    "dp-endpoints": [
      {
        "name": "STRING",
        "address": "UNION_VALUE",
        "port": 0
      }, {
        ...
      }
    ],
    "vnfr-list": [
      {
        "vnfr-name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:sff xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:function-type>STRING</rwsdnal:function-type>
  <rwsdnal:mgmt-address>UNION_VALUE</rwsdnal:mgmt-address>
  <rwsdnal:mgmt-port>0</rwsdnal:mgmt-port>
  <rwsdnal:dp-endpoints>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:address>UNION_VALUE</rwsdnal:address>
    <rwsdnal:port>0</rwsdnal:port>
  </rwsdnal:dp-endpoints>
  <rwsdnal:vnfr-list>
    <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
  </rwsdnal:vnfr-list>
</rwsdnal:sff>

XML Sample

<rwsdnal:sff xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:function-type>STRING</rwsdnal:function-type>
  <rwsdnal:mgmt-address>UNION_VALUE</rwsdnal:mgmt-address>
  <rwsdnal:mgmt-port>0</rwsdnal:mgmt-port>
  <rwsdnal:dp-endpoints>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:address>UNION_VALUE</rwsdnal:address>
    <rwsdnal:port>0</rwsdnal:port>
  </rwsdnal:dp-endpoints>
  <rwsdnal:vnfr-list>
    <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
  </rwsdnal:vnfr-list>
</rwsdnal:sff>

rwsdnal:dp-endpoints

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff/rwsdnal:dp-endpoints

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING']/rwsdnal:dp-endpoints[rwsdnal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/sff/STRING/dp-endpoints/STRING

Fields

Name	Type	Description
name	STRING
address	UNION
port	UINT16

JSON Config Sample

[
  {
    "name": "STRING",
    "address": "UNION_VALUE",
    "port": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "address": "UNION_VALUE",
    "port": 0
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:dp-endpoints xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:address>UNION_VALUE</rwsdnal:address>
  <rwsdnal:port>0</rwsdnal:port>
</rwsdnal:dp-endpoints>

XML Sample

<rwsdnal:dp-endpoints xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:address>UNION_VALUE</rwsdnal:address>
  <rwsdnal:port>0</rwsdnal:port>
</rwsdnal:dp-endpoints>

rwsdnal:vnfr-list

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffgs/rwsdnal:vnffg-chain/rwsdnal:sff/rwsdnal:vnfr-list

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffgs/rwsdnal:vnffg-chain[rwsdnal:name='STRING']/rwsdnal:sff[rwsdnal:name='STRING']/rwsdnal:vnfr-list[rwsdnal:vnfr-name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffgs/vnffg-chain/STRING/sff/STRING/vnfr-list/STRING

Fields

Name	Type	Description
vnfr-name	STRING

JSON Config Sample

[
  {
    "vnfr-name": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfr-name": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:vnfr-list xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
</rwsdnal:vnfr-list>

XML Sample

<rwsdnal:vnfr-list xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
</rwsdnal:vnfr-list>

rwsdnal:vnffg-rendered-paths

Key Identifiers:

XPath Path	/rw-project:project/rwsdnal:vnffg-rendered-paths
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-rendered-paths
RW.REST URI Path	/rw-project:project/STRING/rwsdnal:vnffg-rendered-paths

Fields

Name	Type	Description
vnffg-rendered-path	LIST

JSON Config Sample

{
}

JSON Sample

{
  "vnffg-rendered-path": [
    {
      "name": "STRING",
      "path-id": 0,
      "rendered-path-hop": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwsdnal:vnffg-rendered-paths xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal"/>

XML Sample

<rwsdnal:vnffg-rendered-paths xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnffg-rendered-path>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:path-id>0</rwsdnal:path-id>
    <rwsdnal:rendered-path-hop>...</rwsdnal:rendered-path-hop>
  </rwsdnal:vnffg-rendered-path>
</rwsdnal:vnffg-rendered-paths>

rwsdnal:vnffg-rendered-path

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path[rwsdnal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffg-rendered-paths/vnffg-rendered-path/STRING

Fields

Name	Type	Description
name	STRING
path-id	UINT32	Unique Identifier for the service path
rendered-path-hop	LIST

JSON Sample

[
  {
    "name": "STRING",
    "path-id": 0,
    "rendered-path-hop": [
      {
        "hop-number": 0,
        "service-index": 0,
        "vnfr-name": "STRING",
        "service-function-forwarder": { ... }
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rwsdnal:vnffg-rendered-path xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:path-id>0</rwsdnal:path-id>
  <rwsdnal:rendered-path-hop>
    <rwsdnal:hop-number>0</rwsdnal:hop-number>
    <rwsdnal:service-index>0</rwsdnal:service-index>
    <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
    <rwsdnal:service-function-forwarder>...</rwsdnal:service-function-forwarder>
  </rwsdnal:rendered-path-hop>
</rwsdnal:vnffg-rendered-path>

rwsdnal:rendered-path-hop

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path/rwsdnal:rendered-path-hop

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path[rwsdnal:name='STRING']/rwsdnal:rendered-path-hop[rwsdnal:hop-number='0']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffg-rendered-paths/vnffg-rendered-path/STRING/rendered-path-hop/0

Fields

Name	Type	Description
hop-number	UINT8
service-index	UINT8	Location within the service path
vnfr-name	STRING
service-function-forwarder	CONTAINER

JSON Sample

[
  {
    "hop-number": 0,
    "service-index": 0,
    "vnfr-name": "STRING",
    "service-function-forwarder": {
      "name": "STRING",
      "ip-address": "UNION_VALUE",
      "port": 0
    }
  }, {
    ...
  }
]

XML Sample

<rwsdnal:rendered-path-hop xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:hop-number>0</rwsdnal:hop-number>
  <rwsdnal:service-index>0</rwsdnal:service-index>
  <rwsdnal:vnfr-name>STRING</rwsdnal:vnfr-name>
  <rwsdnal:service-function-forwarder>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:ip-address>UNION_VALUE</rwsdnal:ip-address>
    <rwsdnal:port>0</rwsdnal:port>
  </rwsdnal:service-function-forwarder>
</rwsdnal:rendered-path-hop>

rwsdnal:service-function-forwarder

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path/rwsdnal:rendered-path-hop/rwsdnal:service-function-forwarder

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-rendered-paths/rwsdnal:vnffg-rendered-path[rwsdnal:name='STRING']/rwsdnal:rendered-path-hop[rwsdnal:hop-number='0']/rwsdnal:service-function-forwarder

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffg-rendered-paths/vnffg-rendered-path/STRING/rendered-path-hop/0/service-function-forwarder

Fields

Name	Type	Description
name	STRING	Service Function Forwarder name
ip-address	UNION	Service Function Forwarder Data Plane IP address
port	UINT16	Service Function Forwarder Data Plane port

JSON Sample

{
  "name": "STRING",
  "ip-address": "UNION_VALUE",
  "port": 0
}

XML Sample

<rwsdnal:service-function-forwarder xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:ip-address>UNION_VALUE</rwsdnal:ip-address>
  <rwsdnal:port>0</rwsdnal:port>
</rwsdnal:service-function-forwarder>

rwsdnal:vnffg-classifiers

Key Identifiers:

XPath Path	/rw-project:project/rwsdnal:vnffg-classifiers
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-classifiers
RW.REST URI Path	/rw-project:project/STRING/rwsdnal:vnffg-classifiers

Fields

Name	Type	Description
vnffg-classifier	LIST

JSON Config Sample

{
  "vnffg-classifier": [
    {
      "name": "STRING",
      "rsp-name": "STRING",
      "rsp-id": "STRING",
      "port-id": "STRING",
      "vm-id": "STRING",
      "sff-name": "STRING",
      "vnffg-metadata": { ... },
      "match-attributes": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "vnffg-classifier": [
    {
      "name": "STRING",
      "rsp-name": "STRING",
      "rsp-id": "STRING",
      "port-id": "STRING",
      "vm-id": "STRING",
      "sff-name": "STRING",
      "vnffg-metadata": { ... },
      "match-attributes": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<rwsdnal:vnffg-classifiers xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnffg-classifier>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:rsp-name>STRING</rwsdnal:rsp-name>
    <rwsdnal:rsp-id>STRING</rwsdnal:rsp-id>
    <rwsdnal:port-id>STRING</rwsdnal:port-id>
    <rwsdnal:vm-id>STRING</rwsdnal:vm-id>
    <rwsdnal:sff-name>STRING</rwsdnal:sff-name>
    <rwsdnal:vnffg-metadata>...</rwsdnal:vnffg-metadata>
    <rwsdnal:match-attributes>...</rwsdnal:match-attributes>
  </rwsdnal:vnffg-classifier>
</rwsdnal:vnffg-classifiers>

XML Sample

<rwsdnal:vnffg-classifiers xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:vnffg-classifier>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:rsp-name>STRING</rwsdnal:rsp-name>
    <rwsdnal:rsp-id>STRING</rwsdnal:rsp-id>
    <rwsdnal:port-id>STRING</rwsdnal:port-id>
    <rwsdnal:vm-id>STRING</rwsdnal:vm-id>
    <rwsdnal:sff-name>STRING</rwsdnal:sff-name>
    <rwsdnal:vnffg-metadata>...</rwsdnal:vnffg-metadata>
    <rwsdnal:match-attributes>...</rwsdnal:match-attributes>
  </rwsdnal:vnffg-classifier>
</rwsdnal:vnffg-classifiers>

rwsdnal:vnffg-classifier

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffg-classifiers/vnffg-classifier/STRING

Fields

Name	Type	Description
name	STRING
rsp-name	STRING
rsp-id	STRING
port-id	STRING
vm-id	STRING
sff-name	STRING
vnffg-metadata	CONTAINER
match-attributes	LIST	List of match attributes.

JSON Config Sample

[
  {
    "name": "STRING",
    "rsp-name": "STRING",
    "rsp-id": "STRING",
    "port-id": "STRING",
    "vm-id": "STRING",
    "sff-name": "STRING",
    "vnffg-metadata": {
      "ctx1": "STRING",
      "ctx2": "STRING",
      "ctx3": "STRING",
      "ctx4": "STRING"
    },
    "match-attributes": [
      {
        "name": "STRING",
        "ip-proto": 0,
        "source-ip-address": "UNION_VALUE",
        "destination-ip-address": "UNION_VALUE",
        "source-port": 0,
        "destination-port": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "rsp-name": "STRING",
    "rsp-id": "STRING",
    "port-id": "STRING",
    "vm-id": "STRING",
    "sff-name": "STRING",
    "vnffg-metadata": {
      "ctx1": "STRING",
      "ctx2": "STRING",
      "ctx3": "STRING",
      "ctx4": "STRING"
    },
    "match-attributes": [
      {
        "name": "STRING",
        "ip-proto": 0,
        "source-ip-address": "UNION_VALUE",
        "destination-ip-address": "UNION_VALUE",
        "source-port": 0,
        "destination-port": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<rwsdnal:vnffg-classifier xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:rsp-name>STRING</rwsdnal:rsp-name>
  <rwsdnal:rsp-id>STRING</rwsdnal:rsp-id>
  <rwsdnal:port-id>STRING</rwsdnal:port-id>
  <rwsdnal:vm-id>STRING</rwsdnal:vm-id>
  <rwsdnal:sff-name>STRING</rwsdnal:sff-name>
  <rwsdnal:vnffg-metadata>
    <rwsdnal:ctx1>STRING</rwsdnal:ctx1>
    <rwsdnal:ctx2>STRING</rwsdnal:ctx2>
    <rwsdnal:ctx3>STRING</rwsdnal:ctx3>
    <rwsdnal:ctx4>STRING</rwsdnal:ctx4>
  </rwsdnal:vnffg-metadata>
  <rwsdnal:match-attributes>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:ip-proto>0</rwsdnal:ip-proto>
    <rwsdnal:source-ip-address>UNION_VALUE</rwsdnal:source-ip-address>
    <rwsdnal:destination-ip-address>UNION_VALUE</rwsdnal:destination-ip-address>
    <rwsdnal:source-port>0</rwsdnal:source-port>
    <rwsdnal:destination-port>0</rwsdnal:destination-port>
  </rwsdnal:match-attributes>
</rwsdnal:vnffg-classifier>

XML Sample

<rwsdnal:vnffg-classifier xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:name>STRING</rwsdnal:name>
  <rwsdnal:rsp-name>STRING</rwsdnal:rsp-name>
  <rwsdnal:rsp-id>STRING</rwsdnal:rsp-id>
  <rwsdnal:port-id>STRING</rwsdnal:port-id>
  <rwsdnal:vm-id>STRING</rwsdnal:vm-id>
  <rwsdnal:sff-name>STRING</rwsdnal:sff-name>
  <rwsdnal:vnffg-metadata>
    <rwsdnal:ctx1>STRING</rwsdnal:ctx1>
    <rwsdnal:ctx2>STRING</rwsdnal:ctx2>
    <rwsdnal:ctx3>STRING</rwsdnal:ctx3>
    <rwsdnal:ctx4>STRING</rwsdnal:ctx4>
  </rwsdnal:vnffg-metadata>
  <rwsdnal:match-attributes>
    <rwsdnal:name>STRING</rwsdnal:name>
    <rwsdnal:ip-proto>0</rwsdnal:ip-proto>
    <rwsdnal:source-ip-address>UNION_VALUE</rwsdnal:source-ip-address>
    <rwsdnal:destination-ip-address>UNION_VALUE</rwsdnal:destination-ip-address>
    <rwsdnal:source-port>0</rwsdnal:source-port>
    <rwsdnal:destination-port>0</rwsdnal:destination-port>
  </rwsdnal:match-attributes>
</rwsdnal:vnffg-classifier>

rwsdnal:vnffg-metadata

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier/rwsdnal:vnffg-metadata

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING']/rwsdnal:vnffg-metadata

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffg-classifiers/vnffg-classifier/STRING/vnffg-metadata

Fields

Name	Type	Description
ctx1	STRING
ctx2	STRING
ctx3	STRING
ctx4	STRING

JSON Config Sample

{
  "ctx1": "STRING",
  "ctx2": "STRING",
  "ctx3": "STRING",
  "ctx4": "STRING"
}

JSON Sample

{
  "ctx1": "STRING",
  "ctx2": "STRING",
  "ctx3": "STRING",
  "ctx4": "STRING"
}

XML Config Sample

<rwsdnal:vnffg-metadata xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:ctx1>STRING</rwsdnal:ctx1>
  <rwsdnal:ctx2>STRING</rwsdnal:ctx2>
  <rwsdnal:ctx3>STRING</rwsdnal:ctx3>
  <rwsdnal:ctx4>STRING</rwsdnal:ctx4>
</rwsdnal:vnffg-metadata>

XML Sample

<rwsdnal:vnffg-metadata xmlns:rwsdnal="http://riftio.com/ns/riftware-1.0/rwsdnal">
  <rwsdnal:ctx1>STRING</rwsdnal:ctx1>
  <rwsdnal:ctx2>STRING</rwsdnal:ctx2>
  <rwsdnal:ctx3>STRING</rwsdnal:ctx3>
  <rwsdnal:ctx4>STRING</rwsdnal:ctx4>
</rwsdnal:vnffg-metadata>

rwsdnal:match-attributes

List of match attributes.

Key Identifiers:

XPath Path

/rw-project:project/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier/rwsdnal:match-attributes

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rwsdnal:vnffg-classifiers/rwsdnal:vnffg-classifier[rwsdnal:name='STRING']/rwsdnal:match-attributes[rwsdnal:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rwsdnal:vnffg-classifiers/vnffg-classifier/STRING/match-attributes/STRING

Fields

Name	Type	Description
name	STRING	Name for the Access list
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

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

rw-sdn:sdn

Key Identifiers:

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

Fields

Name	Type	Description
account	LIST

JSON Config Sample

{
  "account": [
    {
      "name": "STRING",
      "account-type": "odl",
      "odl": { ... },
      "mock": { ... },
      "sdnsim": { ... },
      "openstack": { ... }
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "account": [
    {
      "name": "STRING",
      "account-type": "odl",
      "odl": { ... },
      "mock": { ... },
      "sdnsim": { ... },
      "openstack": { ... },
      "connection-status": { ... }
    }, {
      ...
    }
  ]
}

XML Config Sample

<rw-sdn:sdn xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:account>
    <rw-sdn:name>STRING</rw-sdn:name>
    <rw-sdn:account-type>odl</rw-sdn:account-type>
    <rw-sdn:odl>...</rw-sdn:odl>
    <rw-sdn:mock>...</rw-sdn:mock>
    <rw-sdn:sdnsim>...</rw-sdn:sdnsim>
    <rw-sdn:openstack>...</rw-sdn:openstack>
  </rw-sdn:account>
</rw-sdn:sdn>

XML Sample

<rw-sdn:sdn xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:account>
    <rw-sdn:name>STRING</rw-sdn:name>
    <rw-sdn:account-type>odl</rw-sdn:account-type>
    <rw-sdn:odl>...</rw-sdn:odl>
    <rw-sdn:mock>...</rw-sdn:mock>
    <rw-sdn:sdnsim>...</rw-sdn:sdnsim>
    <rw-sdn:openstack>...</rw-sdn:openstack>
    <rw-sdn:connection-status>...</rw-sdn:connection-status>
  </rw-sdn:account>
</rw-sdn:sdn>

rw-sdn:account

Key Identifiers:

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

Fields

Name	Type	Description
name	STRING
account-type	ENUM
odl	CONTAINER
mock	CONTAINER
sdnsim	CONTAINER
openstack	CONTAINER
connection-status	CONTAINER

JSON Config Sample

[
  {
    "name": "STRING",
    "account-type": "odl",
    "odl": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwsdn_odl"
    },
    "mock": {
      "username": "STRING",
      "plugin-name": "rwsdn_mock"
    },
    "sdnsim": {
      "username": "STRING",
      "topology-source": "STRING",
      "plugin-name": "rwsdn_sim"
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "tenant": "STRING",
      "admin": false,
      "user-domain": "Default",
      "project-domain": "Default",
      "region": "RegionOne",
      "plugin-name": "rwsdn_openstack",
      "cert-validate": false
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "account-type": "odl",
    "odl": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwsdn_odl"
    },
    "mock": {
      "username": "STRING",
      "plugin-name": "rwsdn_mock"
    },
    "sdnsim": {
      "username": "STRING",
      "topology-source": "STRING",
      "plugin-name": "rwsdn_sim"
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "tenant": "STRING",
      "admin": false,
      "user-domain": "Default",
      "project-domain": "Default",
      "region": "RegionOne",
      "plugin-name": "rwsdn_openstack",
      "cert-validate": false
    },
    "connection-status": {
      "status": "unknown",
      "details": "STRING"
    }
  }, {
    ...
  }
]

XML Config Sample

<rw-sdn:account xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:name>STRING</rw-sdn:name>
  <rw-sdn:account-type>odl</rw-sdn:account-type>
  <rw-sdn:odl>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:password>STRING</rw-sdn:password>
    <rw-sdn:url>STRING</rw-sdn:url>
    <rw-sdn:plugin-name>rwsdn_odl</rw-sdn:plugin-name>
  </rw-sdn:odl>
  <rw-sdn:mock>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:plugin-name>rwsdn_mock</rw-sdn:plugin-name>
  </rw-sdn:mock>
  <rw-sdn:sdnsim>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:topology-source>STRING</rw-sdn:topology-source>
    <rw-sdn:plugin-name>rwsdn_sim</rw-sdn:plugin-name>
  </rw-sdn:sdnsim>
  <rw-sdn:openstack>
    <rw-sdn:key>STRING</rw-sdn:key>
    <rw-sdn:secret>STRING</rw-sdn:secret>
    <rw-sdn:auth_url>STRING</rw-sdn:auth_url>
    <rw-sdn:tenant>STRING</rw-sdn:tenant>
    <rw-sdn:admin>false</rw-sdn:admin>
    <rw-sdn:user-domain>Default</rw-sdn:user-domain>
    <rw-sdn:project-domain>Default</rw-sdn:project-domain>
    <rw-sdn:region>RegionOne</rw-sdn:region>
    <rw-sdn:plugin-name>rwsdn_openstack</rw-sdn:plugin-name>
    <rw-sdn:cert-validate>false</rw-sdn:cert-validate>
  </rw-sdn:openstack>
</rw-sdn:account>

XML Sample

<rw-sdn:account xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:name>STRING</rw-sdn:name>
  <rw-sdn:account-type>odl</rw-sdn:account-type>
  <rw-sdn:odl>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:password>STRING</rw-sdn:password>
    <rw-sdn:url>STRING</rw-sdn:url>
    <rw-sdn:plugin-name>rwsdn_odl</rw-sdn:plugin-name>
  </rw-sdn:odl>
  <rw-sdn:mock>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:plugin-name>rwsdn_mock</rw-sdn:plugin-name>
  </rw-sdn:mock>
  <rw-sdn:sdnsim>
    <rw-sdn:username>STRING</rw-sdn:username>
    <rw-sdn:topology-source>STRING</rw-sdn:topology-source>
    <rw-sdn:plugin-name>rwsdn_sim</rw-sdn:plugin-name>
  </rw-sdn:sdnsim>
  <rw-sdn:openstack>
    <rw-sdn:key>STRING</rw-sdn:key>
    <rw-sdn:secret>STRING</rw-sdn:secret>
    <rw-sdn:auth_url>STRING</rw-sdn:auth_url>
    <rw-sdn:tenant>STRING</rw-sdn:tenant>
    <rw-sdn:admin>false</rw-sdn:admin>
    <rw-sdn:user-domain>Default</rw-sdn:user-domain>
    <rw-sdn:project-domain>Default</rw-sdn:project-domain>
    <rw-sdn:region>RegionOne</rw-sdn:region>
    <rw-sdn:plugin-name>rwsdn_openstack</rw-sdn:plugin-name>
    <rw-sdn:cert-validate>false</rw-sdn:cert-validate>
  </rw-sdn:openstack>
  <rw-sdn:connection-status>
    <rw-sdn:status>unknown</rw-sdn:status>
    <rw-sdn:details>STRING</rw-sdn:details>
  </rw-sdn:connection-status>
</rw-sdn:account>

rw-sdn:odl

Key Identifiers:

XPath Path

/rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:odl

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:odl

RW.REST URI Path

/rw-project:project/STRING/rw-sdn:sdn/account/STRING/odl

Fields

Name	Type	Description
username	STRING
password	STRING
url	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwsdn_odl"
}

JSON Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwsdn_odl"
}

XML Config Sample

<rw-sdn:odl xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:password>STRING</rw-sdn:password>
  <rw-sdn:url>STRING</rw-sdn:url>
  <rw-sdn:plugin-name>rwsdn_odl</rw-sdn:plugin-name>
</rw-sdn:odl>

XML Sample

<rw-sdn:odl xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:password>STRING</rw-sdn:password>
  <rw-sdn:url>STRING</rw-sdn:url>
  <rw-sdn:plugin-name>rwsdn_odl</rw-sdn:plugin-name>
</rw-sdn:odl>

rw-sdn:mock

Key Identifiers:

XPath Path

/rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:mock

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:mock

RW.REST URI Path

/rw-project:project/STRING/rw-sdn:sdn/account/STRING/mock

Fields

Name	Type	Description
username	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "plugin-name": "rwsdn_mock"
}

JSON Sample

{
  "username": "STRING",
  "plugin-name": "rwsdn_mock"
}

XML Config Sample

<rw-sdn:mock xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:plugin-name>rwsdn_mock</rw-sdn:plugin-name>
</rw-sdn:mock>

XML Sample

<rw-sdn:mock xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:plugin-name>rwsdn_mock</rw-sdn:plugin-name>
</rw-sdn:mock>

rw-sdn:sdnsim

Key Identifiers:

XPath Path

/rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:sdnsim

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:sdnsim

RW.REST URI Path

/rw-project:project/STRING/rw-sdn:sdn/account/STRING/sdnsim

Fields

Name	Type	Description
username	STRING
topology-source	STRING
plugin-name	STRING

JSON Config Sample

{
  "username": "STRING",
  "topology-source": "STRING",
  "plugin-name": "rwsdn_sim"
}

JSON Sample

{
  "username": "STRING",
  "topology-source": "STRING",
  "plugin-name": "rwsdn_sim"
}

XML Config Sample

<rw-sdn:sdnsim xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:topology-source>STRING</rw-sdn:topology-source>
  <rw-sdn:plugin-name>rwsdn_sim</rw-sdn:plugin-name>
</rw-sdn:sdnsim>

XML Sample

<rw-sdn:sdnsim xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:username>STRING</rw-sdn:username>
  <rw-sdn:topology-source>STRING</rw-sdn:topology-source>
  <rw-sdn:plugin-name>rwsdn_sim</rw-sdn:plugin-name>
</rw-sdn:sdnsim>

rw-sdn:openstack

Key Identifiers:

XPath Path

/rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:openstack

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:openstack

RW.REST URI Path

/rw-project:project/STRING/rw-sdn:sdn/account/STRING/openstack

Fields

Name	Type	Description
key	STRING
secret	STRING
auth_url	STRING
tenant	STRING
admin	BOOLEAN
user-domain	STRING	Domain of the OpenStack user
project-domain	STRING	Domain of the OpenStack project
region	STRING
plugin-name	STRING
cert-validate	BOOLEAN	Certificate validatation policy in case of SSL/TLS connection

JSON Config Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "tenant": "STRING",
  "admin": false,
  "user-domain": "Default",
  "project-domain": "Default",
  "region": "RegionOne",
  "plugin-name": "rwsdn_openstack",
  "cert-validate": false
}

JSON Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "tenant": "STRING",
  "admin": false,
  "user-domain": "Default",
  "project-domain": "Default",
  "region": "RegionOne",
  "plugin-name": "rwsdn_openstack",
  "cert-validate": false
}

XML Config Sample

<rw-sdn:openstack xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:key>STRING</rw-sdn:key>
  <rw-sdn:secret>STRING</rw-sdn:secret>
  <rw-sdn:auth_url>STRING</rw-sdn:auth_url>
  <rw-sdn:tenant>STRING</rw-sdn:tenant>
  <rw-sdn:admin>false</rw-sdn:admin>
  <rw-sdn:user-domain>Default</rw-sdn:user-domain>
  <rw-sdn:project-domain>Default</rw-sdn:project-domain>
  <rw-sdn:region>RegionOne</rw-sdn:region>
  <rw-sdn:plugin-name>rwsdn_openstack</rw-sdn:plugin-name>
  <rw-sdn:cert-validate>false</rw-sdn:cert-validate>
</rw-sdn:openstack>

XML Sample

<rw-sdn:openstack xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:key>STRING</rw-sdn:key>
  <rw-sdn:secret>STRING</rw-sdn:secret>
  <rw-sdn:auth_url>STRING</rw-sdn:auth_url>
  <rw-sdn:tenant>STRING</rw-sdn:tenant>
  <rw-sdn:admin>false</rw-sdn:admin>
  <rw-sdn:user-domain>Default</rw-sdn:user-domain>
  <rw-sdn:project-domain>Default</rw-sdn:project-domain>
  <rw-sdn:region>RegionOne</rw-sdn:region>
  <rw-sdn:plugin-name>rwsdn_openstack</rw-sdn:plugin-name>
  <rw-sdn:cert-validate>false</rw-sdn:cert-validate>
</rw-sdn:openstack>

rw-sdn:connection-status

Key Identifiers:

XPath Path

/rw-project:project/rw-sdn:sdn/rw-sdn:account/rw-sdn:connection-status

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-sdn:sdn/rw-sdn:account[rw-sdn:name='STRING']/rw-sdn:connection-status

RW.REST URI Path

/rw-project:project/STRING/rw-sdn:sdn/account/STRING/connection-status

Fields

Name	Type	Description
status	ENUM
details	STRING

JSON Sample

{
  "status": "unknown",
  "details": "STRING"
}

XML Sample

<rw-sdn:connection-status xmlns:rw-sdn="http://riftio.com/ns/riftware-1.0/rw-sdn">
  <rw-sdn:status>unknown</rw-sdn:status>
  <rw-sdn:details>STRING</rw-sdn:details>
</rw-sdn:connection-status>

rw-cloud:cloud

Key Identifiers:

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

Fields

Name	Type	Description
account	LIST	Configure Cloud Accounts

JSON Config Sample

{
  "account": [
    {
      "name": "STRING",
      "sdn-account": "STRING",
      "account-type": "aws",
      "mock": { ... },
      "aws": { ... },
      "openstack": { ... },
      "openmano": { ... },
      "vsphere": { ... },
      "cloudsim": { ... },
      "cloudsim_proxy": { ... },
      "openvim": { ... },
      "prop_cloud1": { ... },
      "vdu-instance-timeout": 300
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "account": [
    {
      "name": "STRING",
      "sdn-account": "STRING",
      "account-type": "aws",
      "mock": { ... },
      "aws": { ... },
      "openstack": { ... },
      "openmano": { ... },
      "vsphere": { ... },
      "cloudsim": { ... },
      "cloudsim_proxy": { ... },
      "openvim": { ... },
      "prop_cloud1": { ... },
      "connection-status": { ... },
      "vdu-instance-timeout": 300
    }, {
      ...
    }
  ]
}

XML Config Sample

<rw-cloud:cloud xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:account>
    <rw-cloud:name>STRING</rw-cloud:name>
    <rw-cloud:sdn-account>STRING</rw-cloud:sdn-account>
    <rw-cloud:account-type>aws</rw-cloud:account-type>
    <rw-cloud:mock>...</rw-cloud:mock>
    <rw-cloud:aws>...</rw-cloud:aws>
    <rw-cloud:openstack>...</rw-cloud:openstack>
    <rw-cloud:openmano>...</rw-cloud:openmano>
    <rw-cloud:vsphere>...</rw-cloud:vsphere>
    <rw-cloud:cloudsim>...</rw-cloud:cloudsim>
    <rw-cloud:cloudsim_proxy>...</rw-cloud:cloudsim_proxy>
    <rw-cloud:openvim>...</rw-cloud:openvim>
    <rw-cloud:prop_cloud1>...</rw-cloud:prop_cloud1>
    <rw-cloud:vdu-instance-timeout>300</rw-cloud:vdu-instance-timeout>
  </rw-cloud:account>
</rw-cloud:cloud>

XML Sample

<rw-cloud:cloud xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:account>
    <rw-cloud:name>STRING</rw-cloud:name>
    <rw-cloud:sdn-account>STRING</rw-cloud:sdn-account>
    <rw-cloud:account-type>aws</rw-cloud:account-type>
    <rw-cloud:mock>...</rw-cloud:mock>
    <rw-cloud:aws>...</rw-cloud:aws>
    <rw-cloud:openstack>...</rw-cloud:openstack>
    <rw-cloud:openmano>...</rw-cloud:openmano>
    <rw-cloud:vsphere>...</rw-cloud:vsphere>
    <rw-cloud:cloudsim>...</rw-cloud:cloudsim>
    <rw-cloud:cloudsim_proxy>...</rw-cloud:cloudsim_proxy>
    <rw-cloud:openvim>...</rw-cloud:openvim>
    <rw-cloud:prop_cloud1>...</rw-cloud:prop_cloud1>
    <rw-cloud:connection-status>...</rw-cloud:connection-status>
    <rw-cloud:vdu-instance-timeout>300</rw-cloud:vdu-instance-timeout>
  </rw-cloud:account>
</rw-cloud:cloud>

rw-cloud:account

Configure Cloud Accounts

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING

Fields

Name	Type	Description
name	STRING
sdn-account	LEAFREF	Configured SDN account associated with this cloud account
account-type	ENUM
mock	CONTAINER
aws	CONTAINER
openstack	CONTAINER
openmano	CONTAINER
vsphere	CONTAINER
cloudsim	CONTAINER
cloudsim_proxy	CONTAINER
openvim	CONTAINER
prop_cloud1	CONTAINER
connection-status	CONTAINER
vdu-instance-timeout	UINT64	VDU instantiation timeout

JSON Config Sample

[
  {
    "name": "STRING",
    "sdn-account": "STRING",
    "account-type": "aws",
    "mock": {
      "username": "STRING",
      "plugin-name": "rwcal_mock",
      "dynamic-flavor-support": true
    },
    "aws": {
      "key": "STRING",
      "secret": "STRING",
      "region": "STRING",
      "vpcid": "STRING",
      "ssh-key": "STRING",
      "availability-zone": "STRING",
      "default-subnet-id": "STRING",
      "plugin-name": "rwcal_aws",
      "dynamic-flavor-support": true
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "user-domain": "Default",
      "project-domain": "Default",
      "tenant": "STRING",
      "region": "RegionOne",
      "admin": false,
      "mgmt-network": "STRING",
      "plugin-name": "rwcal_openstack",
      "security-groups": [ "STRING", ... ],
      "dynamic-flavor-support": true,
      "floating-ip-pool": "STRING",
      "cert-validate": false
    },
    "openmano": {
      "host": "localhost",
      "port": 9090,
      "tenant-id": "STRING",
      "plugin-name": "rwcal_openmano"
    },
    "vsphere": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwcal-python",
      "dynamic-flavor-support": false
    },
    "cloudsim": {
      "plugin-name": "rwcal_cloudsim",
      "dynamic-flavor-support": true
    },
    "cloudsim_proxy": {
      "host": "localhost",
      "plugin-name": "rwcal_cloudsimproxy",
      "dynamic-flavor-support": true
    },
    "openvim": {
      "host": "STRING",
      "port": 9080,
      "tenant-name": "STRING",
      "mgmt-network": "STRING",
      "plugin-name": "rwcal_openmano_vimconnector",
      "dynamic-flavor-support": true,
      "image-management": { ... }
    },
    "prop_cloud1": {
      "host": "STRING",
      "username": "STRING",
      "password": "STRING",
      "mgmt-network": "STRING",
      "public-ip-pool": "STRING",
      "wan-interface": "STRING",
      "firewall": "STRING",
      "plugin-name": "rwcal_brocade",
      "dynamic-flavor-support": true
    },
    "vdu-instance-timeout": 300
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "sdn-account": "STRING",
    "account-type": "aws",
    "mock": {
      "username": "STRING",
      "plugin-name": "rwcal_mock",
      "dynamic-flavor-support": true
    },
    "aws": {
      "key": "STRING",
      "secret": "STRING",
      "region": "STRING",
      "vpcid": "STRING",
      "ssh-key": "STRING",
      "availability-zone": "STRING",
      "default-subnet-id": "STRING",
      "plugin-name": "rwcal_aws",
      "dynamic-flavor-support": true
    },
    "openstack": {
      "key": "STRING",
      "secret": "STRING",
      "auth_url": "STRING",
      "user-domain": "Default",
      "project-domain": "Default",
      "tenant": "STRING",
      "region": "RegionOne",
      "admin": false,
      "mgmt-network": "STRING",
      "plugin-name": "rwcal_openstack",
      "security-groups": [ "STRING", ... ],
      "dynamic-flavor-support": true,
      "floating-ip-pool": "STRING",
      "cert-validate": false
    },
    "openmano": {
      "host": "localhost",
      "port": 9090,
      "tenant-id": "STRING",
      "plugin-name": "rwcal_openmano"
    },
    "vsphere": {
      "username": "STRING",
      "password": "STRING",
      "url": "STRING",
      "plugin-name": "rwcal-python",
      "dynamic-flavor-support": false
    },
    "cloudsim": {
      "plugin-name": "rwcal_cloudsim",
      "dynamic-flavor-support": true
    },
    "cloudsim_proxy": {
      "host": "localhost",
      "plugin-name": "rwcal_cloudsimproxy",
      "dynamic-flavor-support": true
    },
    "openvim": {
      "host": "STRING",
      "port": 9080,
      "tenant-name": "STRING",
      "mgmt-network": "STRING",
      "plugin-name": "rwcal_openmano_vimconnector",
      "dynamic-flavor-support": true,
      "image-management": { ... }
    },
    "prop_cloud1": {
      "host": "STRING",
      "username": "STRING",
      "password": "STRING",
      "mgmt-network": "STRING",
      "public-ip-pool": "STRING",
      "wan-interface": "STRING",
      "firewall": "STRING",
      "plugin-name": "rwcal_brocade",
      "dynamic-flavor-support": true
    },
    "connection-status": {
      "status": "unknown",
      "details": "STRING"
    },
    "vdu-instance-timeout": 300
  }, {
    ...
  }
]

XML Config Sample

<rw-cloud:account xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:name>STRING</rw-cloud:name>
  <rw-cloud:sdn-account>STRING</rw-cloud:sdn-account>
  <rw-cloud:account-type>aws</rw-cloud:account-type>
  <rw-cloud:mock>
    <rw-cloud:username>STRING</rw-cloud:username>
    <rw-cloud:plugin-name>rwcal_mock</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:mock>
  <rw-cloud:aws>
    <rw-cloud:key>STRING</rw-cloud:key>
    <rw-cloud:secret>STRING</rw-cloud:secret>
    <rw-cloud:region>STRING</rw-cloud:region>
    <rw-cloud:vpcid>STRING</rw-cloud:vpcid>
    <rw-cloud:ssh-key>STRING</rw-cloud:ssh-key>
    <rw-cloud:availability-zone>STRING</rw-cloud:availability-zone>
    <rw-cloud:default-subnet-id>STRING</rw-cloud:default-subnet-id>
    <rw-cloud:plugin-name>rwcal_aws</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:aws>
  <rw-cloud:openstack>
    <rw-cloud:key>STRING</rw-cloud:key>
    <rw-cloud:secret>STRING</rw-cloud:secret>
    <rw-cloud:auth_url>STRING</rw-cloud:auth_url>
    <rw-cloud:user-domain>Default</rw-cloud:user-domain>
    <rw-cloud:project-domain>Default</rw-cloud:project-domain>
    <rw-cloud:tenant>STRING</rw-cloud:tenant>
    <rw-cloud:region>RegionOne</rw-cloud:region>
    <rw-cloud:admin>false</rw-cloud:admin>
    <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
    <rw-cloud:plugin-name>rwcal_openstack</rw-cloud:plugin-name>
    <rw-cloud:security-groups>STRING</rw-cloud:security-groups>
    <rw-cloud:security-groups>...</rw-cloud:security-groups>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
    <rw-cloud:floating-ip-pool>STRING</rw-cloud:floating-ip-pool>
    <rw-cloud:cert-validate>false</rw-cloud:cert-validate>
  </rw-cloud:openstack>
  <rw-cloud:openmano>
    <rw-cloud:host>localhost</rw-cloud:host>
    <rw-cloud:port>9090</rw-cloud:port>
    <rw-cloud:tenant-id>STRING</rw-cloud:tenant-id>
    <rw-cloud:plugin-name>rwcal_openmano</rw-cloud:plugin-name>
  </rw-cloud:openmano>
  <rw-cloud:vsphere>
    <rw-cloud:username>STRING</rw-cloud:username>
    <rw-cloud:password>STRING</rw-cloud:password>
    <rw-cloud:url>STRING</rw-cloud:url>
    <rw-cloud:plugin-name>rwcal-python</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>false</rw-cloud:dynamic-flavor-support>
  </rw-cloud:vsphere>
  <rw-cloud:cloudsim>
    <rw-cloud:plugin-name>rwcal_cloudsim</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:cloudsim>
  <rw-cloud:cloudsim_proxy>
    <rw-cloud:host>localhost</rw-cloud:host>
    <rw-cloud:plugin-name>rwcal_cloudsimproxy</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:cloudsim_proxy>
  <rw-cloud:openvim>
    <rw-cloud:host>STRING</rw-cloud:host>
    <rw-cloud:port>9080</rw-cloud:port>
    <rw-cloud:tenant-name>STRING</rw-cloud:tenant-name>
    <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
    <rw-cloud:plugin-name>rwcal_openmano_vimconnector</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
    <rw-cloud:image-management>...</rw-cloud:image-management>
  </rw-cloud:openvim>
  <rw-cloud:prop_cloud1>
    <rw-cloud:host>STRING</rw-cloud:host>
    <rw-cloud:username>STRING</rw-cloud:username>
    <rw-cloud:password>STRING</rw-cloud:password>
    <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
    <rw-cloud:public-ip-pool>STRING</rw-cloud:public-ip-pool>
    <rw-cloud:wan-interface>STRING</rw-cloud:wan-interface>
    <rw-cloud:firewall>STRING</rw-cloud:firewall>
    <rw-cloud:plugin-name>rwcal_brocade</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:prop_cloud1>
  <rw-cloud:vdu-instance-timeout>300</rw-cloud:vdu-instance-timeout>
</rw-cloud:account>

XML Sample

<rw-cloud:account xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:name>STRING</rw-cloud:name>
  <rw-cloud:sdn-account>STRING</rw-cloud:sdn-account>
  <rw-cloud:account-type>aws</rw-cloud:account-type>
  <rw-cloud:mock>
    <rw-cloud:username>STRING</rw-cloud:username>
    <rw-cloud:plugin-name>rwcal_mock</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:mock>
  <rw-cloud:aws>
    <rw-cloud:key>STRING</rw-cloud:key>
    <rw-cloud:secret>STRING</rw-cloud:secret>
    <rw-cloud:region>STRING</rw-cloud:region>
    <rw-cloud:vpcid>STRING</rw-cloud:vpcid>
    <rw-cloud:ssh-key>STRING</rw-cloud:ssh-key>
    <rw-cloud:availability-zone>STRING</rw-cloud:availability-zone>
    <rw-cloud:default-subnet-id>STRING</rw-cloud:default-subnet-id>
    <rw-cloud:plugin-name>rwcal_aws</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:aws>
  <rw-cloud:openstack>
    <rw-cloud:key>STRING</rw-cloud:key>
    <rw-cloud:secret>STRING</rw-cloud:secret>
    <rw-cloud:auth_url>STRING</rw-cloud:auth_url>
    <rw-cloud:user-domain>Default</rw-cloud:user-domain>
    <rw-cloud:project-domain>Default</rw-cloud:project-domain>
    <rw-cloud:tenant>STRING</rw-cloud:tenant>
    <rw-cloud:region>RegionOne</rw-cloud:region>
    <rw-cloud:admin>false</rw-cloud:admin>
    <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
    <rw-cloud:plugin-name>rwcal_openstack</rw-cloud:plugin-name>
    <rw-cloud:security-groups>STRING</rw-cloud:security-groups>
    <rw-cloud:security-groups>...</rw-cloud:security-groups>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
    <rw-cloud:floating-ip-pool>STRING</rw-cloud:floating-ip-pool>
    <rw-cloud:cert-validate>false</rw-cloud:cert-validate>
  </rw-cloud:openstack>
  <rw-cloud:openmano>
    <rw-cloud:host>localhost</rw-cloud:host>
    <rw-cloud:port>9090</rw-cloud:port>
    <rw-cloud:tenant-id>STRING</rw-cloud:tenant-id>
    <rw-cloud:plugin-name>rwcal_openmano</rw-cloud:plugin-name>
  </rw-cloud:openmano>
  <rw-cloud:vsphere>
    <rw-cloud:username>STRING</rw-cloud:username>
    <rw-cloud:password>STRING</rw-cloud:password>
    <rw-cloud:url>STRING</rw-cloud:url>
    <rw-cloud:plugin-name>rwcal-python</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>false</rw-cloud:dynamic-flavor-support>
  </rw-cloud:vsphere>
  <rw-cloud:cloudsim>
    <rw-cloud:plugin-name>rwcal_cloudsim</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:cloudsim>
  <rw-cloud:cloudsim_proxy>
    <rw-cloud:host>localhost</rw-cloud:host>
    <rw-cloud:plugin-name>rwcal_cloudsimproxy</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:cloudsim_proxy>
  <rw-cloud:openvim>
    <rw-cloud:host>STRING</rw-cloud:host>
    <rw-cloud:port>9080</rw-cloud:port>
    <rw-cloud:tenant-name>STRING</rw-cloud:tenant-name>
    <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
    <rw-cloud:plugin-name>rwcal_openmano_vimconnector</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
    <rw-cloud:image-management>...</rw-cloud:image-management>
  </rw-cloud:openvim>
  <rw-cloud:prop_cloud1>
    <rw-cloud:host>STRING</rw-cloud:host>
    <rw-cloud:username>STRING</rw-cloud:username>
    <rw-cloud:password>STRING</rw-cloud:password>
    <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
    <rw-cloud:public-ip-pool>STRING</rw-cloud:public-ip-pool>
    <rw-cloud:wan-interface>STRING</rw-cloud:wan-interface>
    <rw-cloud:firewall>STRING</rw-cloud:firewall>
    <rw-cloud:plugin-name>rwcal_brocade</rw-cloud:plugin-name>
    <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  </rw-cloud:prop_cloud1>
  <rw-cloud:connection-status>
    <rw-cloud:status>unknown</rw-cloud:status>
    <rw-cloud:details>STRING</rw-cloud:details>
  </rw-cloud:connection-status>
  <rw-cloud:vdu-instance-timeout>300</rw-cloud:vdu-instance-timeout>
</rw-cloud:account>

rw-cloud:mock

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:mock

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:mock

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/mock

Fields

Name	Type	Description
username	STRING
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "username": "STRING",
  "plugin-name": "rwcal_mock",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "username": "STRING",
  "plugin-name": "rwcal_mock",
  "dynamic-flavor-support": true
}

XML Config Sample

<rw-cloud:mock xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:username>STRING</rw-cloud:username>
  <rw-cloud:plugin-name>rwcal_mock</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:mock>

XML Sample

<rw-cloud:mock xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:username>STRING</rw-cloud:username>
  <rw-cloud:plugin-name>rwcal_mock</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:mock>

rw-cloud:aws

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:aws

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:aws

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/aws

Fields

Name	Type	Description
key	STRING
secret	STRING
region	STRING
vpcid	STRING	VPC ID to use to instantiate EC2 instances
ssh-key	STRING	Key pair name to connect to EC2 instance
availability-zone	STRING	Availability zone where EC2 instance should be started
default-subnet-id	STRING	Default subnet ID to create network interface at instance creation time
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "key": "STRING",
  "secret": "STRING",
  "region": "STRING",
  "vpcid": "STRING",
  "ssh-key": "STRING",
  "availability-zone": "STRING",
  "default-subnet-id": "STRING",
  "plugin-name": "rwcal_aws",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "key": "STRING",
  "secret": "STRING",
  "region": "STRING",
  "vpcid": "STRING",
  "ssh-key": "STRING",
  "availability-zone": "STRING",
  "default-subnet-id": "STRING",
  "plugin-name": "rwcal_aws",
  "dynamic-flavor-support": true
}

XML Config Sample

<rw-cloud:aws xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:key>STRING</rw-cloud:key>
  <rw-cloud:secret>STRING</rw-cloud:secret>
  <rw-cloud:region>STRING</rw-cloud:region>
  <rw-cloud:vpcid>STRING</rw-cloud:vpcid>
  <rw-cloud:ssh-key>STRING</rw-cloud:ssh-key>
  <rw-cloud:availability-zone>STRING</rw-cloud:availability-zone>
  <rw-cloud:default-subnet-id>STRING</rw-cloud:default-subnet-id>
  <rw-cloud:plugin-name>rwcal_aws</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:aws>

XML Sample

<rw-cloud:aws xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:key>STRING</rw-cloud:key>
  <rw-cloud:secret>STRING</rw-cloud:secret>
  <rw-cloud:region>STRING</rw-cloud:region>
  <rw-cloud:vpcid>STRING</rw-cloud:vpcid>
  <rw-cloud:ssh-key>STRING</rw-cloud:ssh-key>
  <rw-cloud:availability-zone>STRING</rw-cloud:availability-zone>
  <rw-cloud:default-subnet-id>STRING</rw-cloud:default-subnet-id>
  <rw-cloud:plugin-name>rwcal_aws</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:aws>

rw-cloud:openstack

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:openstack

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openstack

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/openstack

Fields

Name	Type	Description
key	STRING
secret	STRING
auth_url	STRING
user-domain	STRING	Domain of the OpenStack user
project-domain	STRING	Domain of the OpenStack project
tenant	STRING
region	STRING
admin	BOOLEAN
mgmt-network	STRING
plugin-name	STRING
security-groups	LEAF_LIST	Names of the security groups for the VM
dynamic-flavor-support	BOOLEAN
floating-ip-pool	STRING	Name of floating IP pool to use for floating IP address assignement
cert-validate	BOOLEAN	Certificate validatation policy in case of SSL/TLS connection

JSON Config Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "user-domain": "Default",
  "project-domain": "Default",
  "tenant": "STRING",
  "region": "RegionOne",
  "admin": false,
  "mgmt-network": "STRING",
  "plugin-name": "rwcal_openstack",
  "security-groups": [ "STRING", ... ],
  "dynamic-flavor-support": true,
  "floating-ip-pool": "STRING",
  "cert-validate": false
}

JSON Sample

{
  "key": "STRING",
  "secret": "STRING",
  "auth_url": "STRING",
  "user-domain": "Default",
  "project-domain": "Default",
  "tenant": "STRING",
  "region": "RegionOne",
  "admin": false,
  "mgmt-network": "STRING",
  "plugin-name": "rwcal_openstack",
  "security-groups": [ "STRING", ... ],
  "dynamic-flavor-support": true,
  "floating-ip-pool": "STRING",
  "cert-validate": false
}

XML Config Sample

<rw-cloud:openstack xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:key>STRING</rw-cloud:key>
  <rw-cloud:secret>STRING</rw-cloud:secret>
  <rw-cloud:auth_url>STRING</rw-cloud:auth_url>
  <rw-cloud:user-domain>Default</rw-cloud:user-domain>
  <rw-cloud:project-domain>Default</rw-cloud:project-domain>
  <rw-cloud:tenant>STRING</rw-cloud:tenant>
  <rw-cloud:region>RegionOne</rw-cloud:region>
  <rw-cloud:admin>false</rw-cloud:admin>
  <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
  <rw-cloud:plugin-name>rwcal_openstack</rw-cloud:plugin-name>
  <rw-cloud:security-groups>STRING</rw-cloud:security-groups>
  <rw-cloud:security-groups>...</rw-cloud:security-groups>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  <rw-cloud:floating-ip-pool>STRING</rw-cloud:floating-ip-pool>
  <rw-cloud:cert-validate>false</rw-cloud:cert-validate>
</rw-cloud:openstack>

XML Sample

<rw-cloud:openstack xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:key>STRING</rw-cloud:key>
  <rw-cloud:secret>STRING</rw-cloud:secret>
  <rw-cloud:auth_url>STRING</rw-cloud:auth_url>
  <rw-cloud:user-domain>Default</rw-cloud:user-domain>
  <rw-cloud:project-domain>Default</rw-cloud:project-domain>
  <rw-cloud:tenant>STRING</rw-cloud:tenant>
  <rw-cloud:region>RegionOne</rw-cloud:region>
  <rw-cloud:admin>false</rw-cloud:admin>
  <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
  <rw-cloud:plugin-name>rwcal_openstack</rw-cloud:plugin-name>
  <rw-cloud:security-groups>STRING</rw-cloud:security-groups>
  <rw-cloud:security-groups>...</rw-cloud:security-groups>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  <rw-cloud:floating-ip-pool>STRING</rw-cloud:floating-ip-pool>
  <rw-cloud:cert-validate>false</rw-cloud:cert-validate>
</rw-cloud:openstack>

rw-cloud:security-groups

Names of the security groups for the VM

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:openstack/rw-cloud:security-groups

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openstack/rw-cloud:security-groups

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/openstack/security-groups

JSON Config Sample

[ "STRING", ... ]

JSON Sample

[ "STRING", ... ]

XML Config Sample

<rw-cloud:security-groups xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">STRING</rw-cloud:security-groups>
<rw-cloud:security-groups xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">...</rw-cloud:security-groups>

XML Sample

<rw-cloud:security-groups xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">STRING</rw-cloud:security-groups>
<rw-cloud:security-groups xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">...</rw-cloud:security-groups>

rw-cloud:openmano

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:openmano

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openmano

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/openmano

Fields

Name	Type	Description
host	STRING
port	UINT16
tenant-id	STRING
plugin-name	STRING

JSON Config Sample

{
  "host": "localhost",
  "port": 9090,
  "tenant-id": "STRING",
  "plugin-name": "rwcal_openmano"
}

JSON Sample

{
  "host": "localhost",
  "port": 9090,
  "tenant-id": "STRING",
  "plugin-name": "rwcal_openmano"
}

XML Config Sample

<rw-cloud:openmano xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:host>localhost</rw-cloud:host>
  <rw-cloud:port>9090</rw-cloud:port>
  <rw-cloud:tenant-id>STRING</rw-cloud:tenant-id>
  <rw-cloud:plugin-name>rwcal_openmano</rw-cloud:plugin-name>
</rw-cloud:openmano>

XML Sample

<rw-cloud:openmano xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:host>localhost</rw-cloud:host>
  <rw-cloud:port>9090</rw-cloud:port>
  <rw-cloud:tenant-id>STRING</rw-cloud:tenant-id>
  <rw-cloud:plugin-name>rwcal_openmano</rw-cloud:plugin-name>
</rw-cloud:openmano>

rw-cloud:vsphere

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:vsphere

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:vsphere

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/vsphere

Fields

Name	Type	Description
username	STRING
password	STRING
url	STRING
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwcal-python",
  "dynamic-flavor-support": false
}

JSON Sample

{
  "username": "STRING",
  "password": "STRING",
  "url": "STRING",
  "plugin-name": "rwcal-python",
  "dynamic-flavor-support": false
}

XML Config Sample

<rw-cloud:vsphere xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:username>STRING</rw-cloud:username>
  <rw-cloud:password>STRING</rw-cloud:password>
  <rw-cloud:url>STRING</rw-cloud:url>
  <rw-cloud:plugin-name>rwcal-python</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>false</rw-cloud:dynamic-flavor-support>
</rw-cloud:vsphere>

XML Sample

<rw-cloud:vsphere xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:username>STRING</rw-cloud:username>
  <rw-cloud:password>STRING</rw-cloud:password>
  <rw-cloud:url>STRING</rw-cloud:url>
  <rw-cloud:plugin-name>rwcal-python</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>false</rw-cloud:dynamic-flavor-support>
</rw-cloud:vsphere>

rw-cloud:cloudsim

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:cloudsim

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:cloudsim

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/cloudsim

Fields

Name	Type	Description
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "plugin-name": "rwcal_cloudsim",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "plugin-name": "rwcal_cloudsim",
  "dynamic-flavor-support": true
}

XML Config Sample

<rw-cloud:cloudsim xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:plugin-name>rwcal_cloudsim</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:cloudsim>

XML Sample

<rw-cloud:cloudsim xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:plugin-name>rwcal_cloudsim</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:cloudsim>

rw-cloud:cloudsim_proxy

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:cloudsim_proxy

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:cloudsim_proxy

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/cloudsim_proxy

Fields

Name	Type	Description
host	STRING
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "host": "localhost",
  "plugin-name": "rwcal_cloudsimproxy",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "host": "localhost",
  "plugin-name": "rwcal_cloudsimproxy",
  "dynamic-flavor-support": true
}

XML Config Sample

<rw-cloud:cloudsim_proxy xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:host>localhost</rw-cloud:host>
  <rw-cloud:plugin-name>rwcal_cloudsimproxy</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:cloudsim_proxy>

XML Sample

<rw-cloud:cloudsim_proxy xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:host>localhost</rw-cloud:host>
  <rw-cloud:plugin-name>rwcal_cloudsimproxy</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:cloudsim_proxy>

rw-cloud:openvim

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:openvim

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openvim

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/openvim

Fields

Name	Type	Description
host	STRING
port	UINT16
tenant-name	STRING	Mandatory parameter to indicate openvim tenant name
mgmt-network	STRING
plugin-name	STRING
dynamic-flavor-support	BOOLEAN
image-management	CONTAINER	Information required for OpenVim image upload operation

JSON Config Sample

{
  "host": "STRING",
  "port": 9080,
  "tenant-name": "STRING",
  "mgmt-network": "STRING",
  "plugin-name": "rwcal_openmano_vimconnector",
  "dynamic-flavor-support": true,
  "image-management": {
    "username": "STRING",
    "password": "STRING",
    "image-directory-path": "/opt/VNF/images"
  }
}

JSON Sample

{
  "host": "STRING",
  "port": 9080,
  "tenant-name": "STRING",
  "mgmt-network": "STRING",
  "plugin-name": "rwcal_openmano_vimconnector",
  "dynamic-flavor-support": true,
  "image-management": {
    "username": "STRING",
    "password": "STRING",
    "image-directory-path": "/opt/VNF/images"
  }
}

XML Config Sample

<rw-cloud:openvim xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:host>STRING</rw-cloud:host>
  <rw-cloud:port>9080</rw-cloud:port>
  <rw-cloud:tenant-name>STRING</rw-cloud:tenant-name>
  <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
  <rw-cloud:plugin-name>rwcal_openmano_vimconnector</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  <rw-cloud:image-management>
    <rw-cloud:username>STRING</rw-cloud:username>
    <rw-cloud:password>STRING</rw-cloud:password>
    <rw-cloud:image-directory-path>/opt/VNF/images</rw-cloud:image-directory-path>
  </rw-cloud:image-management>
</rw-cloud:openvim>

XML Sample

<rw-cloud:openvim xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:host>STRING</rw-cloud:host>
  <rw-cloud:port>9080</rw-cloud:port>
  <rw-cloud:tenant-name>STRING</rw-cloud:tenant-name>
  <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
  <rw-cloud:plugin-name>rwcal_openmano_vimconnector</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
  <rw-cloud:image-management>
    <rw-cloud:username>STRING</rw-cloud:username>
    <rw-cloud:password>STRING</rw-cloud:password>
    <rw-cloud:image-directory-path>/opt/VNF/images</rw-cloud:image-directory-path>
  </rw-cloud:image-management>
</rw-cloud:openvim>

rw-cloud:image-management

Information required for OpenVim image upload operation

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:openvim/rw-cloud:image-management

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:openvim/rw-cloud:image-management

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/openvim/image-management

Fields

Name	Type	Description
username	STRING	Username for host access
password	STRING	Password for host access
image-directory-path	STRING	Name of the directory on the host where image needs to be copied

JSON Config Sample

{
  "username": "STRING",
  "password": "STRING",
  "image-directory-path": "/opt/VNF/images"
}

JSON Sample

{
  "username": "STRING",
  "password": "STRING",
  "image-directory-path": "/opt/VNF/images"
}

XML Config Sample

<rw-cloud:image-management xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:username>STRING</rw-cloud:username>
  <rw-cloud:password>STRING</rw-cloud:password>
  <rw-cloud:image-directory-path>/opt/VNF/images</rw-cloud:image-directory-path>
</rw-cloud:image-management>

XML Sample

<rw-cloud:image-management xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:username>STRING</rw-cloud:username>
  <rw-cloud:password>STRING</rw-cloud:password>
  <rw-cloud:image-directory-path>/opt/VNF/images</rw-cloud:image-directory-path>
</rw-cloud:image-management>

rw-cloud:prop_cloud1

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:prop_cloud1

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:prop_cloud1

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/prop_cloud1

Fields

Name	Type	Description
host	STRING	This is a single-host cloud. IP address of host
username	STRING	Username to access host
password	STRING	Password for user
mgmt-network	STRING	Name of bridge used for management access to VMs on cloud
public-ip-pool	STRING	Public IP pool for VMs
wan-interface	STRING	WAN interface name
firewall	STRING	Firewall services
plugin-name	STRING
dynamic-flavor-support	BOOLEAN

JSON Config Sample

{
  "host": "STRING",
  "username": "STRING",
  "password": "STRING",
  "mgmt-network": "STRING",
  "public-ip-pool": "STRING",
  "wan-interface": "STRING",
  "firewall": "STRING",
  "plugin-name": "rwcal_brocade",
  "dynamic-flavor-support": true
}

JSON Sample

{
  "host": "STRING",
  "username": "STRING",
  "password": "STRING",
  "mgmt-network": "STRING",
  "public-ip-pool": "STRING",
  "wan-interface": "STRING",
  "firewall": "STRING",
  "plugin-name": "rwcal_brocade",
  "dynamic-flavor-support": true
}

XML Config Sample

<rw-cloud:prop_cloud1 xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:host>STRING</rw-cloud:host>
  <rw-cloud:username>STRING</rw-cloud:username>
  <rw-cloud:password>STRING</rw-cloud:password>
  <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
  <rw-cloud:public-ip-pool>STRING</rw-cloud:public-ip-pool>
  <rw-cloud:wan-interface>STRING</rw-cloud:wan-interface>
  <rw-cloud:firewall>STRING</rw-cloud:firewall>
  <rw-cloud:plugin-name>rwcal_brocade</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:prop_cloud1>

XML Sample

<rw-cloud:prop_cloud1 xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:host>STRING</rw-cloud:host>
  <rw-cloud:username>STRING</rw-cloud:username>
  <rw-cloud:password>STRING</rw-cloud:password>
  <rw-cloud:mgmt-network>STRING</rw-cloud:mgmt-network>
  <rw-cloud:public-ip-pool>STRING</rw-cloud:public-ip-pool>
  <rw-cloud:wan-interface>STRING</rw-cloud:wan-interface>
  <rw-cloud:firewall>STRING</rw-cloud:firewall>
  <rw-cloud:plugin-name>rwcal_brocade</rw-cloud:plugin-name>
  <rw-cloud:dynamic-flavor-support>true</rw-cloud:dynamic-flavor-support>
</rw-cloud:prop_cloud1>

rw-cloud:connection-status

Key Identifiers:

XPath Path

/rw-project:project/rw-cloud:cloud/rw-cloud:account/rw-cloud:connection-status

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-cloud:cloud/rw-cloud:account[rw-cloud:name='STRING']/rw-cloud:connection-status

RW.REST URI Path

/rw-project:project/STRING/rw-cloud:cloud/account/STRING/connection-status

Fields

Name	Type	Description
status	ENUM
details	STRING

JSON Sample

{
  "status": "unknown",
  "details": "STRING"
}

XML Sample

<rw-cloud:connection-status xmlns:rw-cloud="http://riftio.com/ns/riftware-1.0/rw-cloud">
  <rw-cloud:status>unknown</rw-cloud:status>
  <rw-cloud:details>STRING</rw-cloud:details>
</rw-cloud:connection-status>

vlr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwVlr_Vlr_t_schema
Global Schema Pointer	rw_ypbc_RwVlr_Vlr_g_schema

rw-vlr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwVlr_RwVlr_t_schema
Global Schema Pointer	rw_ypbc_RwVlr_RwVlr_g_schema