rw-resource-mgr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwResourceMgr_RwResourceMgr_t_schema
Global Schema Pointer	rw_ypbc_RwResourceMgr_RwResourceMgr_g_schema

rw-resource-mgr data

rw-resource-mgr:resource-mgr-config

Data model for configuration of resource-mgr

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-mgr-config
XPath Keyed Path	/rw-resource-mgr:resource-mgr-config
RW.REST URI Path	/rw-resource-mgr:resource-mgr-config

Fields

Name	Type	Description
management-domain	CONTAINER
resource-pools	CONTAINER	Resource Pool configuration

JSON Config Sample

{
  "management-domain": {
    "name": "STRING"
  },
  "resource-pools": {
    "cloud-account": [ { ... }, { ... } ]
  }
}

JSON Sample

{
  "management-domain": {
    "name": "STRING"
  },
  "resource-pools": {
    "cloud-account": [ { ... }, { ... } ]
  }
}

XML Config Sample

<rw-resource-mgr:resource-mgr-config xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:management-domain>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  </rw-resource-mgr:management-domain>
  <rw-resource-mgr:resource-pools>
    <rw-resource-mgr:cloud-account>...</rw-resource-mgr:cloud-account>
  </rw-resource-mgr:resource-pools>
</rw-resource-mgr:resource-mgr-config>

XML Sample

<rw-resource-mgr:resource-mgr-config xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:management-domain>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  </rw-resource-mgr:management-domain>
  <rw-resource-mgr:resource-pools>
    <rw-resource-mgr:cloud-account>...</rw-resource-mgr:cloud-account>
  </rw-resource-mgr:resource-pools>
</rw-resource-mgr:resource-mgr-config>

rw-resource-mgr:management-domain

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-mgr-config/rw-resource-mgr:management-domain
XPath Keyed Path	/rw-resource-mgr:resource-mgr-config/rw-resource-mgr:management-domain
RW.REST URI Path	/rw-resource-mgr:resource-mgr-config/management-domain

Fields

Name	Type	Description
name	STRING	The management domain name this launchpad is associated with.

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<rw-resource-mgr:management-domain xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
</rw-resource-mgr:management-domain>

XML Sample

<rw-resource-mgr:management-domain xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
</rw-resource-mgr:management-domain>

rw-resource-mgr:resource-pools

Resource Pool configuration

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-mgr-config/rw-resource-mgr:resource-pools
XPath Keyed Path	/rw-resource-mgr:resource-mgr-config/rw-resource-mgr:resource-pools
RW.REST URI Path	/rw-resource-mgr:resource-mgr-config/resource-pools

Fields

Name	Type	Description
cloud-account	LIST

JSON Config Sample

{
  "cloud-account": [
    {
      "name": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "cloud-account": [
    {
      "name": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<rw-resource-mgr:resource-pools xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:cloud-account>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  </rw-resource-mgr:cloud-account>
</rw-resource-mgr:resource-pools>

XML Sample

<rw-resource-mgr:resource-pools xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:cloud-account>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  </rw-resource-mgr:cloud-account>
</rw-resource-mgr:resource-pools>

rw-resource-mgr:cloud-account

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-config/rw-resource-mgr:resource-pools/rw-resource-mgr:cloud-account

XPath Keyed Path

/rw-resource-mgr:resource-mgr-config/rw-resource-mgr:resource-pools/rw-resource-mgr:cloud-account[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-config/resource-pools/cloud-account/STRING

Fields

Name	Type	Description
name	LEAFREF	Resource pool for the configured cloud account

JSON Config Sample

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

JSON Sample

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

XML Config Sample

<rw-resource-mgr:cloud-account xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
</rw-resource-mgr:cloud-account>

XML Sample

<rw-resource-mgr:cloud-account xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
</rw-resource-mgr:cloud-account>

rw-resource-mgr:resource-mgmt

Resource management

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-mgmt
XPath Keyed Path	/rw-resource-mgr:resource-mgmt
RW.REST URI Path	/rw-resource-mgr:resource-mgmt

Fields

Name	Type	Description
vdu-event	CONTAINER	Events for VDU Management
vlink-event	CONTAINER	Events for Virtual Link management

JSON Sample

{
  "vdu-event": {
    "vdu-event-data": [ { ... }, { ... } ]
  },
  "vlink-event": {
    "vlink-event-data": [ { ... }, { ... } ]
  }
}

XML Sample

<rw-resource-mgr:resource-mgmt xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:vdu-event>
    <rw-resource-mgr:vdu-event-data>...</rw-resource-mgr:vdu-event-data>
  </rw-resource-mgr:vdu-event>
  <rw-resource-mgr:vlink-event>
    <rw-resource-mgr:vlink-event-data>...</rw-resource-mgr:vlink-event-data>
  </rw-resource-mgr:vlink-event>
</rw-resource-mgr:resource-mgmt>

rw-resource-mgr:vdu-event

Events for VDU Management

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event
XPath Keyed Path	/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event
RW.REST URI Path	/rw-resource-mgr:resource-mgmt/vdu-event

Fields

Name	Type	Description
vdu-event-data	LIST

JSON Sample

{
  "vdu-event-data": [
    {
      "event-id": "STRING",
      "cloud-account": "STRING",
      "request-info": { ... },
      "resource-info": { ... }
    }, {
      ...
    }
  ]
}

XML Sample

<rw-resource-mgr:vdu-event xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:vdu-event-data>
    <rw-resource-mgr:event-id>STRING</rw-resource-mgr:event-id>
    <rw-resource-mgr:cloud-account>STRING</rw-resource-mgr:cloud-account>
    <rw-resource-mgr:request-info>...</rw-resource-mgr:request-info>
    <rw-resource-mgr:resource-info>...</rw-resource-mgr:resource-info>
  </rw-resource-mgr:vdu-event-data>
</rw-resource-mgr:vdu-event>

rw-resource-mgr:vdu-event-data

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING

Fields

Name	Type	Description
event-id	STRING	Identifier associated with the VDU transaction
cloud-account	LEAFREF	The cloud account to use for this resource request
request-info	CONTAINER	Information about required resource
resource-info	CONTAINER	Information about allocated resource

JSON Sample

[
  {
    "event-id": "STRING",
    "cloud-account": "STRING",
    "request-info": {
      "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": [ { ... }, { ... } ]
    },
    "resource-info": {
      "pool-name": "STRING",
      "resource-state": "inactive",
      "resource-errors": "STRING",
      "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

<rw-resource-mgr:vdu-event-data xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:event-id>STRING</rw-resource-mgr:event-id>
  <rw-resource-mgr:cloud-account>STRING</rw-resource-mgr:cloud-account>
  <rw-resource-mgr:request-info>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:mgmt-vpci>STRING</rw-resource-mgr:mgmt-vpci>
    <rw-resource-mgr:vm-flavor>...</rw-resource-mgr:vm-flavor>
    <rw-resource-mgr:guest-epa>...</rw-resource-mgr:guest-epa>
    <rw-resource-mgr:vswitch-epa>...</rw-resource-mgr:vswitch-epa>
    <rw-resource-mgr:hypervisor-epa>...</rw-resource-mgr:hypervisor-epa>
    <rw-resource-mgr:host-epa>...</rw-resource-mgr:host-epa>
    <rw-resource-mgr:node-id>STRING</rw-resource-mgr:node-id>
    <rw-resource-mgr:flavor-id>STRING</rw-resource-mgr:flavor-id>
    <rw-resource-mgr:image-id>STRING</rw-resource-mgr:image-id>
    <rw-resource-mgr:image-name>STRING</rw-resource-mgr:image-name>
    <rw-resource-mgr:image-checksum>STRING</rw-resource-mgr:image-checksum>
    <rw-resource-mgr:cloud-type>aws</rw-resource-mgr:cloud-type>
    <rw-resource-mgr:availability-zone>...</rw-resource-mgr:availability-zone>
    <rw-resource-mgr:server-group>...</rw-resource-mgr:server-group>
    <rw-resource-mgr:host-aggregate>...</rw-resource-mgr:host-aggregate>
    <rw-resource-mgr:aws-construct/>
    <rw-resource-mgr:openmano-construct/>
    <rw-resource-mgr:vsphere-construct/>
    <rw-resource-mgr:mock-construct/>
    <rw-resource-mgr:cloudsim-construct/>
    <rw-resource-mgr:connection-points>...</rw-resource-mgr:connection-points>
    <rw-resource-mgr:mgmt-network>STRING</rw-resource-mgr:mgmt-network>
    <rw-resource-mgr:allocate-public-address>false</rw-resource-mgr:allocate-public-address>
    <rw-resource-mgr:vdu-init>...</rw-resource-mgr:vdu-init>
    <rw-resource-mgr:supplemental-boot-data>...</rw-resource-mgr:supplemental-boot-data>
    <rw-resource-mgr:volumes>...</rw-resource-mgr:volumes>
  </rw-resource-mgr:request-info>
  <rw-resource-mgr:resource-info>
    <rw-resource-mgr:pool-name>STRING</rw-resource-mgr:pool-name>
    <rw-resource-mgr:resource-state>inactive</rw-resource-mgr:resource-state>
    <rw-resource-mgr:resource-errors>STRING</rw-resource-mgr:resource-errors>
    <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:flavor-id>STRING</rw-resource-mgr:flavor-id>
    <rw-resource-mgr:image-id>STRING</rw-resource-mgr:image-id>
    <rw-resource-mgr:node-id>STRING</rw-resource-mgr:node-id>
    <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
    <rw-resource-mgr:management-ip>STRING</rw-resource-mgr:management-ip>
    <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
    <rw-resource-mgr:vm-flavor>...</rw-resource-mgr:vm-flavor>
    <rw-resource-mgr:guest-epa>...</rw-resource-mgr:guest-epa>
    <rw-resource-mgr:vswitch-epa>...</rw-resource-mgr:vswitch-epa>
    <rw-resource-mgr:hypervisor-epa>...</rw-resource-mgr:hypervisor-epa>
    <rw-resource-mgr:host-epa>...</rw-resource-mgr:host-epa>
    <rw-resource-mgr:cloud-type>aws</rw-resource-mgr:cloud-type>
    <rw-resource-mgr:availability-zone>...</rw-resource-mgr:availability-zone>
    <rw-resource-mgr:server-group>...</rw-resource-mgr:server-group>
    <rw-resource-mgr:host-aggregate>...</rw-resource-mgr:host-aggregate>
    <rw-resource-mgr:aws-construct/>
    <rw-resource-mgr:openmano-construct/>
    <rw-resource-mgr:vsphere-construct/>
    <rw-resource-mgr:mock-construct/>
    <rw-resource-mgr:cloudsim-construct/>
    <rw-resource-mgr:connection-points>...</rw-resource-mgr:connection-points>
    <rw-resource-mgr:console-url>STRING</rw-resource-mgr:console-url>
    <rw-resource-mgr:supplemental-boot-data>...</rw-resource-mgr:supplemental-boot-data>
    <rw-resource-mgr:volumes>...</rw-resource-mgr:volumes>
  </rw-resource-mgr:resource-info>
</rw-resource-mgr:vdu-event-data>

rw-resource-mgr:request-info

Information about required resource

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info

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 Sample

{
  "name": "STRING",
  "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": [ { ... }, { ... } ]
  },
  "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,
      "type": "VIRTIO"
    }, {
      ...
    }
  ],
  "mgmt-network": "STRING",
  "allocate-public-address": false,
  "vdu-init": {
    "userdata": "STRING"
  },
  "supplemental-boot-data": {
    "config-file": [ { ... }, { ... } ],
    "boot-data-drive": false
  },
  "volumes": [
    {
      "name": "STRING",
      "description": "STRING",
      "size": 0,
      "ephemeral": [null],
      "image": "STRING",
      "image-checksum": "STRING",
      "device-bus": "ide",
      "device-type": "disk"
    }, {
      ...
    }
  ]
}

XML Sample

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

rw-resource-mgr:vm-flavor

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:vm-flavor

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:vm-flavor

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:guest-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:pcie-device

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:pcie-device[rw-resource-mgr:device-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr: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-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:node

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:vcpu

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:vcpu[rw-resource-mgr:id='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:paired-threads

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:paired-threads

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:paired-threads

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:paired-thread-ids

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

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:paired-threads/rw-resource-mgr:paired-thread-ids

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:paired-threads/rw-resource-mgr:paired-thread-ids[rw-resource-mgr:thread-a='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:vswitch-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:vswitch-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:vswitch-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:hypervisor-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:hypervisor-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:hypervisor-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:host-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:host-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:host-epa/rw-resource-mgr:cpu-feature

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:host-epa/rw-resource-mgr:cpu-feature[rw-resource-mgr:feature='PREFER_AES']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

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

XML Sample

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

rw-resource-mgr:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:host-epa/rw-resource-mgr:om-cpu-feature

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:host-epa/rw-resource-mgr:om-cpu-feature[rw-resource-mgr:feature='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

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

XML Sample

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

rw-resource-mgr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:availability-zone

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:availability-zone

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

rw-resource-mgr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:server-group

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:server-group

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

rw-resource-mgr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:host-aggregate

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:host-aggregate[rw-resource-mgr:metadata-key='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:connection-points

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:connection-points

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:connection-points[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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
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.

JSON Sample

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

XML Sample

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

rw-resource-mgr:vdu-init

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:vdu-init

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:vdu-init

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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 Sample

{
  "userdata": "STRING"
}

XML Sample

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

rw-resource-mgr:supplemental-boot-data

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:supplemental-boot-data

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:supplemental-boot-data

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/supplemental-boot-data

Fields

Name	Type	Description
config-file	LIST	List of configuration files to be written on an additional drive
boot-data-drive	BOOLEAN	Some VIMs implement additional drives to host config-files or meta-data

JSON Sample

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

XML Sample

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

rw-resource-mgr:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:supplemental-boot-data/rw-resource-mgr:config-file

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:supplemental-boot-data/rw-resource-mgr:config-file[rw-resource-mgr:source='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/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

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

rw-resource-mgr:volumes

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:request-info/rw-resource-mgr:volumes

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:volumes[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/request-info/volumes/STRING

Fields

Name	Type	Description
name	STRING	Name of the disk-volumes, e.g. vda, vdb etc
description	STRING	Description for Volume
size	UINT64	Size of disk in GB
ephemeral	EMPTY
image	STRING	Image name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here.
image-checksum	STRING	Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL.
device-bus	ENUM	Type of disk-bus on which this disk is exposed to guest
device-type	ENUM	The type of device as exposed to guest

JSON Sample

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

XML Sample

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

rw-resource-mgr:resource-info

Information about allocated resource

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info

Fields

Name	Type	Description
pool-name	STRING
resource-state	ENUM
resource-errors	STRING	Error message details in case of failed resource state
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

{
  "pool-name": "STRING",
  "resource-state": "inactive",
  "resource-errors": "STRING",
  "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": "STRING",
      "public-ip": "STRING",
      "mac-addr": "STRING"
    }, {
      ...
    }
  ],
  "console-url": "STRING",
  "supplemental-boot-data": {
    "config-file": [ { ... }, { ... } ],
    "boot-data-drive": false
  },
  "volumes": [
    {
      "name": "STRING",
      "volume-id": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

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

rw-resource-mgr:vm-flavor

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:vm-flavor

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:vm-flavor

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:guest-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:pcie-device

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:pcie-device[rw-resource-mgr:device-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:numa-node-policy

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:node

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:vcpu

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:vcpu[rw-resource-mgr:id='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:paired-threads

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:paired-threads

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:paired-threads

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:paired-thread-ids

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

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:paired-threads/rw-resource-mgr:paired-thread-ids

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:paired-threads/rw-resource-mgr:paired-thread-ids[rw-resource-mgr:thread-a='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:vswitch-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:vswitch-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:vswitch-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:hypervisor-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:hypervisor-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:hypervisor-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:host-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:host-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:host-epa/rw-resource-mgr:cpu-feature

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:host-epa/rw-resource-mgr:cpu-feature[rw-resource-mgr:feature='PREFER_AES']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

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

XML Sample

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

rw-resource-mgr:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:host-epa/rw-resource-mgr:om-cpu-feature

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:host-epa/rw-resource-mgr:om-cpu-feature[rw-resource-mgr:feature='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

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

XML Sample

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

rw-resource-mgr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:availability-zone

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:availability-zone

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

rw-resource-mgr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:server-group

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:server-group

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

rw-resource-mgr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:host-aggregate

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:host-aggregate[rw-resource-mgr:metadata-key='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:connection-points

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:connection-points

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:connection-points[rw-resource-mgr:connection-point-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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	STRING
public-ip	STRING
mac-addr	STRING

JSON Sample

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

XML Sample

<rw-resource-mgr:connection-points xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
  <rw-resource-mgr:state>active</rw-resource-mgr:state>
  <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
  <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
  <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
</rw-resource-mgr:connection-points>

rw-resource-mgr:supplemental-boot-data

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:supplemental-boot-data

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:supplemental-boot-data

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/supplemental-boot-data

Fields

Name	Type	Description
config-file	LIST	List of configuration files to be written on an additional drive
boot-data-drive	BOOLEAN	Some VIMs implement additional drives to host config-files or meta-data

JSON Sample

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

XML Sample

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

rw-resource-mgr:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:supplemental-boot-data/rw-resource-mgr:config-file

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:supplemental-boot-data/rw-resource-mgr:config-file[rw-resource-mgr:source='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

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

rw-resource-mgr:volumes

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:volumes

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vdu-event/rw-resource-mgr:vdu-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:volumes[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vdu-event/vdu-event-data/STRING/resource-info/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

JSON Sample

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

XML Sample

<rw-resource-mgr:volumes xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:volume-id>STRING</rw-resource-mgr:volume-id>
</rw-resource-mgr:volumes>

rw-resource-mgr:vlink-event

Events for Virtual Link management

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event
XPath Keyed Path	/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event
RW.REST URI Path	/rw-resource-mgr:resource-mgmt/vlink-event

Fields

Name	Type	Description
vlink-event-data	LIST

JSON Sample

{
  "vlink-event-data": [
    {
      "event-id": "STRING",
      "cloud-account": "STRING",
      "request-info": { ... },
      "resource-info": { ... }
    }, {
      ...
    }
  ]
}

XML Sample

<rw-resource-mgr:vlink-event xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:vlink-event-data>
    <rw-resource-mgr:event-id>STRING</rw-resource-mgr:event-id>
    <rw-resource-mgr:cloud-account>STRING</rw-resource-mgr:cloud-account>
    <rw-resource-mgr:request-info>...</rw-resource-mgr:request-info>
    <rw-resource-mgr:resource-info>...</rw-resource-mgr:resource-info>
  </rw-resource-mgr:vlink-event-data>
</rw-resource-mgr:vlink-event>

rw-resource-mgr:vlink-event-data

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING

Fields

Name	Type	Description
event-id	STRING	Identifier associated with the Virtual Link transaction
cloud-account	LEAFREF	The cloud account to use for this resource request
request-info	CONTAINER	Information about required resource
resource-info	CONTAINER

JSON Sample

[
  {
    "event-id": "STRING",
    "cloud-account": "STRING",
    "request-info": {
      "name": "STRING",
      "subnet": "STRING",
      "associate-public-ip": false,
      "vim-network-name": "STRING",
      "provider-network": { ... },
      "ip-profile-params": { ... }
    },
    "resource-info": {
      "pool-name": "STRING",
      "resource-state": "inactive",
      "resource-errors": "STRING",
      "name": "STRING",
      "state": "unknown",
      "virtual-link-id": "STRING",
      "connection-points": [ { ... }, { ... } ],
      "subnet": "STRING",
      "provider-network": { ... }
    }
  }, {
    ...
  }
]

XML Sample

<rw-resource-mgr:vlink-event-data xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:event-id>STRING</rw-resource-mgr:event-id>
  <rw-resource-mgr:cloud-account>STRING</rw-resource-mgr:cloud-account>
  <rw-resource-mgr:request-info>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:subnet>STRING</rw-resource-mgr:subnet>
    <rw-resource-mgr:associate-public-ip>false</rw-resource-mgr:associate-public-ip>
    <rw-resource-mgr:vim-network-name>STRING</rw-resource-mgr:vim-network-name>
    <rw-resource-mgr:provider-network>...</rw-resource-mgr:provider-network>
    <rw-resource-mgr:ip-profile-params>...</rw-resource-mgr:ip-profile-params>
  </rw-resource-mgr:request-info>
  <rw-resource-mgr:resource-info>
    <rw-resource-mgr:pool-name>STRING</rw-resource-mgr:pool-name>
    <rw-resource-mgr:resource-state>inactive</rw-resource-mgr:resource-state>
    <rw-resource-mgr:resource-errors>STRING</rw-resource-mgr:resource-errors>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
    <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
    <rw-resource-mgr:connection-points>...</rw-resource-mgr:connection-points>
    <rw-resource-mgr:subnet>STRING</rw-resource-mgr:subnet>
    <rw-resource-mgr:provider-network>...</rw-resource-mgr:provider-network>
  </rw-resource-mgr:resource-info>
</rw-resource-mgr:vlink-event-data>

rw-resource-mgr:request-info

Information about required resource

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data/rw-resource-mgr:request-info

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING/request-info

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.
provider-network	CONTAINER	Container for the provider network.
ip-profile-params	CONTAINER

JSON Sample

{
  "name": "STRING",
  "subnet": "STRING",
  "associate-public-ip": false,
  "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"
  }
}

XML Sample

<rw-resource-mgr:request-info xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:subnet>STRING</rw-resource-mgr:subnet>
  <rw-resource-mgr:associate-public-ip>false</rw-resource-mgr:associate-public-ip>
  <rw-resource-mgr:vim-network-name>STRING</rw-resource-mgr:vim-network-name>
  <rw-resource-mgr:provider-network>
    <rw-resource-mgr:physical-network>STRING</rw-resource-mgr:physical-network>
    <rw-resource-mgr:overlay-type>LOCAL</rw-resource-mgr:overlay-type>
    <rw-resource-mgr:segmentation_id>0</rw-resource-mgr:segmentation_id>
  </rw-resource-mgr:provider-network>
  <rw-resource-mgr:ip-profile-params>
    <rw-resource-mgr:ip-version>ipv4</rw-resource-mgr:ip-version>
    <rw-resource-mgr:subnet-address>UNION_VALUE</rw-resource-mgr:subnet-address>
    <rw-resource-mgr:gateway-address>UNION_VALUE</rw-resource-mgr:gateway-address>
    <rw-resource-mgr:security-group>STRING</rw-resource-mgr:security-group>
    <rw-resource-mgr:dns-server>...</rw-resource-mgr:dns-server>
    <rw-resource-mgr:dhcp-params>...</rw-resource-mgr:dhcp-params>
    <rw-resource-mgr:subnet-prefix-pool>STRING</rw-resource-mgr:subnet-prefix-pool>
  </rw-resource-mgr:ip-profile-params>
</rw-resource-mgr:request-info>

rw-resource-mgr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data/rw-resource-mgr:request-info/rw-resource-mgr:provider-network

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:provider-network

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING/request-info/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
segmentation_id	UINT32	ID of segregated virtual networks

JSON Sample

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

XML Sample

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

rw-resource-mgr:ip-profile-params

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data/rw-resource-mgr:request-info/rw-resource-mgr:ip-profile-params

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:ip-profile-params

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING/request-info/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

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

rw-resource-mgr:dns-server

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data/rw-resource-mgr:request-info/rw-resource-mgr:ip-profile-params/rw-resource-mgr:dns-server

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:ip-profile-params/rw-resource-mgr:dns-server[rw-resource-mgr:address='UNION_VALUE']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING/request-info/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

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

rw-resource-mgr:dhcp-params

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data/rw-resource-mgr:request-info/rw-resource-mgr:ip-profile-params/rw-resource-mgr:dhcp-params

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:request-info/rw-resource-mgr:ip-profile-params/rw-resource-mgr:dhcp-params

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING/request-info/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

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

rw-resource-mgr:resource-info

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data/rw-resource-mgr:resource-info

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING/resource-info

Fields

Name	Type	Description
pool-name	STRING
resource-state	ENUM
resource-errors	STRING	Error message details in case of failed resource state
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
subnet	STRING
provider-network	CONTAINER	Container for the provider network.

JSON Sample

{
  "pool-name": "STRING",
  "resource-state": "inactive",
  "resource-errors": "STRING",
  "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": "STRING",
      "public-ip": "STRING",
      "mac-addr": "STRING"
    }, {
      ...
    }
  ],
  "subnet": "STRING",
  "provider-network": {
    "physical-network": "STRING",
    "overlay-type": "LOCAL",
    "segmentation_id": 0
  }
}

XML Sample

<rw-resource-mgr:resource-info xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:pool-name>STRING</rw-resource-mgr:pool-name>
  <rw-resource-mgr:resource-state>inactive</rw-resource-mgr:resource-state>
  <rw-resource-mgr:resource-errors>STRING</rw-resource-mgr:resource-errors>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:connection-points>
    <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
    <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
    <rw-resource-mgr:state>active</rw-resource-mgr:state>
    <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
    <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
    <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
  </rw-resource-mgr:connection-points>
  <rw-resource-mgr:subnet>STRING</rw-resource-mgr:subnet>
  <rw-resource-mgr:provider-network>
    <rw-resource-mgr:physical-network>STRING</rw-resource-mgr:physical-network>
    <rw-resource-mgr:overlay-type>LOCAL</rw-resource-mgr:overlay-type>
    <rw-resource-mgr:segmentation_id>0</rw-resource-mgr:segmentation_id>
  </rw-resource-mgr:provider-network>
</rw-resource-mgr:resource-info>

rw-resource-mgr:connection-points

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:connection-points

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:connection-points[rw-resource-mgr:connection-point-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING/resource-info/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	STRING
public-ip	STRING
mac-addr	STRING

JSON Sample

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

XML Sample

<rw-resource-mgr:connection-points xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
  <rw-resource-mgr:state>active</rw-resource-mgr:state>
  <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
  <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
  <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
</rw-resource-mgr:connection-points>

rw-resource-mgr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data/rw-resource-mgr:resource-info/rw-resource-mgr:provider-network

XPath Keyed Path

/rw-resource-mgr:resource-mgmt/rw-resource-mgr:vlink-event/rw-resource-mgr:vlink-event-data[rw-resource-mgr:event-id='STRING']/rw-resource-mgr:resource-info/rw-resource-mgr:provider-network

RW.REST URI Path

/rw-resource-mgr:resource-mgmt/vlink-event/vlink-event-data/STRING/resource-info/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
segmentation_id	UINT32	ID of segregated virtual networks

JSON Sample

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

XML Sample

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

rw-resource-mgr:resource-pool-records

Resource Pool Records

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-pool-records
XPath Keyed Path	/rw-resource-mgr:resource-pool-records
RW.REST URI Path	/rw-resource-mgr:resource-pool-records

Fields

Name	Type	Description
cloud-account	LIST

JSON Sample

{
  "cloud-account": [
    {
      "name": "STRING",
      "records": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<rw-resource-mgr:resource-pool-records xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:cloud-account>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:records>...</rw-resource-mgr:records>
  </rw-resource-mgr:cloud-account>
</rw-resource-mgr:resource-pool-records>

rw-resource-mgr:cloud-account

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-pool-records/rw-resource-mgr:cloud-account

XPath Keyed Path

/rw-resource-mgr:resource-pool-records/rw-resource-mgr:cloud-account[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-pool-records/cloud-account/STRING

Fields

Name	Type	Description
name	LEAFREF	The configured cloud account's pool records.
records	LIST

JSON Sample

[
  {
    "name": "STRING",
    "records": [
      {
        "name": "STRING",
        "resource-type": "compute",
        "pool-type": "static",
        "max-size": 0,
        "pool-status": "unknown",
        "total-resources": 0,
        "free-resources": 0,
        "allocated-resources": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rw-resource-mgr:cloud-account xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:records>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:resource-type>compute</rw-resource-mgr:resource-type>
    <rw-resource-mgr:pool-type>static</rw-resource-mgr:pool-type>
    <rw-resource-mgr:max-size>0</rw-resource-mgr:max-size>
    <rw-resource-mgr:pool-status>unknown</rw-resource-mgr:pool-status>
    <rw-resource-mgr:total-resources>0</rw-resource-mgr:total-resources>
    <rw-resource-mgr:free-resources>0</rw-resource-mgr:free-resources>
    <rw-resource-mgr:allocated-resources>0</rw-resource-mgr:allocated-resources>
  </rw-resource-mgr:records>
</rw-resource-mgr:cloud-account>

rw-resource-mgr:records

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-pool-records/rw-resource-mgr:cloud-account/rw-resource-mgr:records

XPath Keyed Path

/rw-resource-mgr:resource-pool-records/rw-resource-mgr:cloud-account[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-pool-records/cloud-account/STRING/records/STRING

Fields

Name	Type	Description
name	STRING	Name of the resource pool
resource-type	ENUM	Type of resource
pool-type	ENUM	Type of pool
max-size	UINT32	Maximum size to which a dynamic resource pool can grow
pool-status	ENUM
total-resources	UINT32
free-resources	UINT32
allocated-resources	UINT32

JSON Sample

[
  {
    "name": "STRING",
    "resource-type": "compute",
    "pool-type": "static",
    "max-size": 0,
    "pool-status": "unknown",
    "total-resources": 0,
    "free-resources": 0,
    "allocated-resources": 0
  }, {
    ...
  }
]

XML Sample

<rw-resource-mgr:records xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:resource-type>compute</rw-resource-mgr:resource-type>
  <rw-resource-mgr:pool-type>static</rw-resource-mgr:pool-type>
  <rw-resource-mgr:max-size>0</rw-resource-mgr:max-size>
  <rw-resource-mgr:pool-status>unknown</rw-resource-mgr:pool-status>
  <rw-resource-mgr:total-resources>0</rw-resource-mgr:total-resources>
  <rw-resource-mgr:free-resources>0</rw-resource-mgr:free-resources>
  <rw-resource-mgr:allocated-resources>0</rw-resource-mgr:allocated-resources>
</rw-resource-mgr:records>

rw-resource-mgr:resource-mgr-data

Resource Manager operational data

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-mgr-data
XPath Keyed Path	/rw-resource-mgr:resource-mgr-data
RW.REST URI Path	/rw-resource-mgr:resource-mgr-data

Fields

Name	Type	Description
pool-record	CONTAINER	Resource Pool record

JSON Sample

{
  "pool-record": {
    "cloud": [ { ... }, { ... } ]
  }
}

XML Sample

<rw-resource-mgr:resource-mgr-data xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:pool-record>
    <rw-resource-mgr:cloud>...</rw-resource-mgr:cloud>
  </rw-resource-mgr:pool-record>
</rw-resource-mgr:resource-mgr-data>

rw-resource-mgr:pool-record

Resource Pool record

Key Identifiers:

XPath Path	/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record
XPath Keyed Path	/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record
RW.REST URI Path	/rw-resource-mgr:resource-mgr-data/pool-record

Fields

Name	Type	Description
cloud	LIST

JSON Sample

{
  "cloud": [
    {
      "name": "STRING",
      "records": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<rw-resource-mgr:pool-record xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:cloud>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:records>...</rw-resource-mgr:records>
  </rw-resource-mgr:cloud>
</rw-resource-mgr:pool-record>

rw-resource-mgr:cloud

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING

Fields

Name	Type	Description
name	LEAFREF	The configured cloud account's pool records.
records	LIST

JSON Sample

[
  {
    "name": "STRING",
    "records": [
      {
        "name": "STRING",
        "resource-type": "compute",
        "pool-type": "static",
        "max-size": 0,
        "free-vdu-list": [ { ... }, { ... } ],
        "in-use-vdu-list": [ { ... }, { ... } ],
        "free-vlink-list": [ { ... }, { ... } ],
        "in-use-vlink-list": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rw-resource-mgr:cloud xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:records>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:resource-type>compute</rw-resource-mgr:resource-type>
    <rw-resource-mgr:pool-type>static</rw-resource-mgr:pool-type>
    <rw-resource-mgr:max-size>0</rw-resource-mgr:max-size>
    <rw-resource-mgr:free-vdu-list>...</rw-resource-mgr:free-vdu-list>
    <rw-resource-mgr:in-use-vdu-list>...</rw-resource-mgr:in-use-vdu-list>
    <rw-resource-mgr:free-vlink-list>...</rw-resource-mgr:free-vlink-list>
    <rw-resource-mgr:in-use-vlink-list>...</rw-resource-mgr:in-use-vlink-list>
  </rw-resource-mgr:records>
</rw-resource-mgr:cloud>

rw-resource-mgr:records

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING

Fields

Name	Type	Description
name	STRING	Name of the resource pool
resource-type	ENUM	Type of resource
pool-type	ENUM	Type of pool
max-size	UINT32	Maximum size to which a dynamic resource pool can grow
free-vdu-list	LIST
in-use-vdu-list	LIST
free-vlink-list	LIST
in-use-vlink-list	LIST

JSON Sample

[
  {
    "name": "STRING",
    "resource-type": "compute",
    "pool-type": "static",
    "max-size": 0,
    "free-vdu-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": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "in-use-vdu-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": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "free-vlink-list": [
      {
        "name": "STRING",
        "state": "unknown",
        "virtual-link-id": "STRING",
        "connection-points": [ { ... }, { ... } ],
        "subnet": "STRING",
        "provider-network": { ... }
      }, {
        ...
      }
    ],
    "in-use-vlink-list": [
      {
        "name": "STRING",
        "state": "unknown",
        "virtual-link-id": "STRING",
        "connection-points": [ { ... }, { ... } ],
        "subnet": "STRING",
        "provider-network": { ... }
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rw-resource-mgr:records xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:resource-type>compute</rw-resource-mgr:resource-type>
  <rw-resource-mgr:pool-type>static</rw-resource-mgr:pool-type>
  <rw-resource-mgr:max-size>0</rw-resource-mgr:max-size>
  <rw-resource-mgr:free-vdu-list>
    <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:flavor-id>STRING</rw-resource-mgr:flavor-id>
    <rw-resource-mgr:image-id>STRING</rw-resource-mgr:image-id>
    <rw-resource-mgr:node-id>STRING</rw-resource-mgr:node-id>
    <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
    <rw-resource-mgr:management-ip>STRING</rw-resource-mgr:management-ip>
    <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
    <rw-resource-mgr:vm-flavor>...</rw-resource-mgr:vm-flavor>
    <rw-resource-mgr:guest-epa>...</rw-resource-mgr:guest-epa>
    <rw-resource-mgr:vswitch-epa>...</rw-resource-mgr:vswitch-epa>
    <rw-resource-mgr:hypervisor-epa>...</rw-resource-mgr:hypervisor-epa>
    <rw-resource-mgr:host-epa>...</rw-resource-mgr:host-epa>
    <rw-resource-mgr:cloud-type>aws</rw-resource-mgr:cloud-type>
    <rw-resource-mgr:availability-zone>...</rw-resource-mgr:availability-zone>
    <rw-resource-mgr:server-group>...</rw-resource-mgr:server-group>
    <rw-resource-mgr:host-aggregate>...</rw-resource-mgr:host-aggregate>
    <rw-resource-mgr:aws-construct/>
    <rw-resource-mgr:openmano-construct/>
    <rw-resource-mgr:vsphere-construct/>
    <rw-resource-mgr:mock-construct/>
    <rw-resource-mgr:cloudsim-construct/>
    <rw-resource-mgr:connection-points>...</rw-resource-mgr:connection-points>
    <rw-resource-mgr:console-url>STRING</rw-resource-mgr:console-url>
    <rw-resource-mgr:supplemental-boot-data>...</rw-resource-mgr:supplemental-boot-data>
    <rw-resource-mgr:volumes>...</rw-resource-mgr:volumes>
  </rw-resource-mgr:free-vdu-list>
  <rw-resource-mgr:in-use-vdu-list>
    <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:flavor-id>STRING</rw-resource-mgr:flavor-id>
    <rw-resource-mgr:image-id>STRING</rw-resource-mgr:image-id>
    <rw-resource-mgr:node-id>STRING</rw-resource-mgr:node-id>
    <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
    <rw-resource-mgr:management-ip>STRING</rw-resource-mgr:management-ip>
    <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
    <rw-resource-mgr:vm-flavor>...</rw-resource-mgr:vm-flavor>
    <rw-resource-mgr:guest-epa>...</rw-resource-mgr:guest-epa>
    <rw-resource-mgr:vswitch-epa>...</rw-resource-mgr:vswitch-epa>
    <rw-resource-mgr:hypervisor-epa>...</rw-resource-mgr:hypervisor-epa>
    <rw-resource-mgr:host-epa>...</rw-resource-mgr:host-epa>
    <rw-resource-mgr:cloud-type>aws</rw-resource-mgr:cloud-type>
    <rw-resource-mgr:availability-zone>...</rw-resource-mgr:availability-zone>
    <rw-resource-mgr:server-group>...</rw-resource-mgr:server-group>
    <rw-resource-mgr:host-aggregate>...</rw-resource-mgr:host-aggregate>
    <rw-resource-mgr:aws-construct/>
    <rw-resource-mgr:openmano-construct/>
    <rw-resource-mgr:vsphere-construct/>
    <rw-resource-mgr:mock-construct/>
    <rw-resource-mgr:cloudsim-construct/>
    <rw-resource-mgr:connection-points>...</rw-resource-mgr:connection-points>
    <rw-resource-mgr:console-url>STRING</rw-resource-mgr:console-url>
    <rw-resource-mgr:supplemental-boot-data>...</rw-resource-mgr:supplemental-boot-data>
    <rw-resource-mgr:volumes>...</rw-resource-mgr:volumes>
  </rw-resource-mgr:in-use-vdu-list>
  <rw-resource-mgr:free-vlink-list>
    <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
    <rw-resource-mgr:connection-points>...</rw-resource-mgr:connection-points>
    <rw-resource-mgr:subnet>STRING</rw-resource-mgr:subnet>
    <rw-resource-mgr:provider-network>...</rw-resource-mgr:provider-network>
  </rw-resource-mgr:free-vlink-list>
  <rw-resource-mgr:in-use-vlink-list>
    <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
    <rw-resource-mgr:connection-points>...</rw-resource-mgr:connection-points>
    <rw-resource-mgr:subnet>STRING</rw-resource-mgr:subnet>
    <rw-resource-mgr:provider-network>...</rw-resource-mgr:provider-network>
  </rw-resource-mgr:in-use-vlink-list>
</rw-resource-mgr:records>

rw-resource-mgr:free-vdu-list

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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": "STRING",
        "public-ip": "STRING",
        "mac-addr": "STRING"
      }, {
        ...
      }
    ],
    "console-url": "STRING",
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false
    },
    "volumes": [
      {
        "name": "STRING",
        "volume-id": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

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

rw-resource-mgr:vm-flavor

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:vm-flavor

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:vm-flavor

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:guest-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:guest-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:pcie-device

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:pcie-device[rw-resource-mgr:device-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:numa-node-policy

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:node

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:vcpu

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:vcpu[rw-resource-mgr:id='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:paired-threads

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:paired-threads

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:paired-threads

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:paired-thread-ids

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

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:paired-threads/rw-resource-mgr:paired-thread-ids

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:paired-threads/rw-resource-mgr:paired-thread-ids[rw-resource-mgr:thread-a='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:vswitch-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:vswitch-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:vswitch-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:hypervisor-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:hypervisor-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:hypervisor-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:host-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:host-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:host-epa/rw-resource-mgr:cpu-feature

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:host-epa/rw-resource-mgr:cpu-feature[rw-resource-mgr:feature='PREFER_AES']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-list/STRING/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

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

XML Sample

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

rw-resource-mgr:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:host-epa/rw-resource-mgr:om-cpu-feature

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:host-epa/rw-resource-mgr:om-cpu-feature[rw-resource-mgr:feature='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-list/STRING/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

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

XML Sample

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

rw-resource-mgr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:availability-zone

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:availability-zone

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-list/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

rw-resource-mgr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:server-group

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:server-group

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-list/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

rw-resource-mgr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:host-aggregate

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:host-aggregate[rw-resource-mgr:metadata-key='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:connection-points

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:connection-points

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:connection-points[rw-resource-mgr:connection-point-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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	STRING
public-ip	STRING
mac-addr	STRING

JSON Sample

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

XML Sample

<rw-resource-mgr:connection-points xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
  <rw-resource-mgr:state>active</rw-resource-mgr:state>
  <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
  <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
  <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
</rw-resource-mgr:connection-points>

rw-resource-mgr:supplemental-boot-data

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:supplemental-boot-data

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:supplemental-boot-data

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

JSON Sample

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

XML Sample

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

rw-resource-mgr:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:supplemental-boot-data/rw-resource-mgr:config-file

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:supplemental-boot-data/rw-resource-mgr:config-file[rw-resource-mgr:source='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

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

rw-resource-mgr:volumes

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vdu-list/rw-resource-mgr:volumes

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:volumes[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vdu-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

JSON Sample

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

XML Sample

<rw-resource-mgr:volumes xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:volume-id>STRING</rw-resource-mgr:volume-id>
</rw-resource-mgr:volumes>

rw-resource-mgr:in-use-vdu-list

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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": "STRING",
        "public-ip": "STRING",
        "mac-addr": "STRING"
      }, {
        ...
      }
    ],
    "console-url": "STRING",
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false
    },
    "volumes": [
      {
        "name": "STRING",
        "volume-id": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

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

rw-resource-mgr:vm-flavor

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:vm-flavor

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:vm-flavor

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:guest-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:guest-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:pcie-device

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:pcie-device[rw-resource-mgr:device-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:numa-node-policy

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:node

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:vcpu

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:vcpu[rw-resource-mgr:id='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:paired-threads

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:paired-threads

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:paired-threads

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:paired-thread-ids

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

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node/rw-resource-mgr:paired-threads/rw-resource-mgr:paired-thread-ids

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:guest-epa/rw-resource-mgr:numa-node-policy/rw-resource-mgr:node[rw-resource-mgr:id='0']/rw-resource-mgr:paired-threads/rw-resource-mgr:paired-thread-ids[rw-resource-mgr:thread-a='0']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:vswitch-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:vswitch-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:vswitch-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:hypervisor-epa

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:hypervisor-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:hypervisor-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:host-epa

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:host-epa

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:host-epa/rw-resource-mgr:cpu-feature

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:host-epa/rw-resource-mgr:cpu-feature[rw-resource-mgr:feature='PREFER_AES']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-list/STRING/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

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

XML Sample

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

rw-resource-mgr:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:host-epa/rw-resource-mgr:om-cpu-feature

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:host-epa/rw-resource-mgr:om-cpu-feature[rw-resource-mgr:feature='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-list/STRING/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

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

XML Sample

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

rw-resource-mgr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:availability-zone

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:availability-zone

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-list/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

rw-resource-mgr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:server-group

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:server-group

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-list/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

rw-resource-mgr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:host-aggregate

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:host-aggregate[rw-resource-mgr:metadata-key='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:connection-points

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:connection-points

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:connection-points[rw-resource-mgr:connection-point-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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	STRING
public-ip	STRING
mac-addr	STRING

JSON Sample

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

XML Sample

<rw-resource-mgr:connection-points xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
  <rw-resource-mgr:state>active</rw-resource-mgr:state>
  <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
  <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
  <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
</rw-resource-mgr:connection-points>

rw-resource-mgr:supplemental-boot-data

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:supplemental-boot-data

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:supplemental-boot-data

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

JSON Sample

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

XML Sample

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

rw-resource-mgr:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:supplemental-boot-data/rw-resource-mgr:config-file

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:supplemental-boot-data/rw-resource-mgr:config-file[rw-resource-mgr:source='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

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

rw-resource-mgr:volumes

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vdu-list/rw-resource-mgr:volumes

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vdu-list[rw-resource-mgr:vdu-id='STRING']/rw-resource-mgr:volumes[rw-resource-mgr:name='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vdu-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

JSON Sample

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

XML Sample

<rw-resource-mgr:volumes xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:volume-id>STRING</rw-resource-mgr:volume-id>
</rw-resource-mgr:volumes>

rw-resource-mgr:free-vlink-list

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vlink-list

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vlink-list[rw-resource-mgr:virtual-link-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vlink-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
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": "STRING",
        "public-ip": "STRING",
        "mac-addr": "STRING"
      }, {
        ...
      }
    ],
    "subnet": "STRING",
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "segmentation_id": 0
    }
  }, {
    ...
  }
]

XML Sample

<rw-resource-mgr:free-vlink-list xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
  <rw-resource-mgr:connection-points>
    <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
    <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
    <rw-resource-mgr:state>active</rw-resource-mgr:state>
    <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
    <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
    <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
  </rw-resource-mgr:connection-points>
  <rw-resource-mgr:subnet>STRING</rw-resource-mgr:subnet>
  <rw-resource-mgr:provider-network>
    <rw-resource-mgr:physical-network>STRING</rw-resource-mgr:physical-network>
    <rw-resource-mgr:overlay-type>LOCAL</rw-resource-mgr:overlay-type>
    <rw-resource-mgr:segmentation_id>0</rw-resource-mgr:segmentation_id>
  </rw-resource-mgr:provider-network>
</rw-resource-mgr:free-vlink-list>

rw-resource-mgr:connection-points

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vlink-list/rw-resource-mgr:connection-points

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vlink-list[rw-resource-mgr:virtual-link-id='STRING']/rw-resource-mgr:connection-points[rw-resource-mgr:connection-point-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vlink-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	STRING
public-ip	STRING
mac-addr	STRING

JSON Sample

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

XML Sample

<rw-resource-mgr:connection-points xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
  <rw-resource-mgr:state>active</rw-resource-mgr:state>
  <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
  <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
  <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
</rw-resource-mgr:connection-points>

rw-resource-mgr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:free-vlink-list/rw-resource-mgr:provider-network

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:free-vlink-list[rw-resource-mgr:virtual-link-id='STRING']/rw-resource-mgr:provider-network

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/free-vlink-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
segmentation_id	UINT32	ID of segregated virtual networks

JSON Sample

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

XML Sample

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

rw-resource-mgr:in-use-vlink-list

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vlink-list

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vlink-list[rw-resource-mgr:virtual-link-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vlink-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
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": "STRING",
        "public-ip": "STRING",
        "mac-addr": "STRING"
      }, {
        ...
      }
    ],
    "subnet": "STRING",
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "segmentation_id": 0
    }
  }, {
    ...
  }
]

XML Sample

<rw-resource-mgr:in-use-vlink-list xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:state>unknown</rw-resource-mgr:state>
  <rw-resource-mgr:connection-points>
    <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
    <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
    <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
    <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
    <rw-resource-mgr:state>active</rw-resource-mgr:state>
    <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
    <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
    <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
  </rw-resource-mgr:connection-points>
  <rw-resource-mgr:subnet>STRING</rw-resource-mgr:subnet>
  <rw-resource-mgr:provider-network>
    <rw-resource-mgr:physical-network>STRING</rw-resource-mgr:physical-network>
    <rw-resource-mgr:overlay-type>LOCAL</rw-resource-mgr:overlay-type>
    <rw-resource-mgr:segmentation_id>0</rw-resource-mgr:segmentation_id>
  </rw-resource-mgr:provider-network>
</rw-resource-mgr:in-use-vlink-list>

rw-resource-mgr:connection-points

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vlink-list/rw-resource-mgr:connection-points

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vlink-list[rw-resource-mgr:virtual-link-id='STRING']/rw-resource-mgr:connection-points[rw-resource-mgr:connection-point-id='STRING']

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vlink-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	STRING
public-ip	STRING
mac-addr	STRING

JSON Sample

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

XML Sample

<rw-resource-mgr:connection-points xmlns:rw-resource-mgr="http://riftio.com/ns/riftware-1.0/rw-resource-mgr">
  <rw-resource-mgr:connection-point-id>STRING</rw-resource-mgr:connection-point-id>
  <rw-resource-mgr:name>STRING</rw-resource-mgr:name>
  <rw-resource-mgr:virtual-link-id>STRING</rw-resource-mgr:virtual-link-id>
  <rw-resource-mgr:vdu-id>STRING</rw-resource-mgr:vdu-id>
  <rw-resource-mgr:state>active</rw-resource-mgr:state>
  <rw-resource-mgr:ip-address>STRING</rw-resource-mgr:ip-address>
  <rw-resource-mgr:public-ip>STRING</rw-resource-mgr:public-ip>
  <rw-resource-mgr:mac-addr>STRING</rw-resource-mgr:mac-addr>
</rw-resource-mgr:connection-points>

rw-resource-mgr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud/rw-resource-mgr:records/rw-resource-mgr:in-use-vlink-list/rw-resource-mgr:provider-network

XPath Keyed Path

/rw-resource-mgr:resource-mgr-data/rw-resource-mgr:pool-record/rw-resource-mgr:cloud[rw-resource-mgr:name='STRING']/rw-resource-mgr:records[rw-resource-mgr:name='STRING']/rw-resource-mgr:in-use-vlink-list[rw-resource-mgr:virtual-link-id='STRING']/rw-resource-mgr:provider-network

RW.REST URI Path

/rw-resource-mgr:resource-mgr-data/pool-record/cloud/STRING/records/STRING/in-use-vlink-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
segmentation_id	UINT32	ID of segregated virtual networks

JSON Sample

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

XML Sample

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