vlr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwVlr_Vlr_t_schema
Global Schema Pointer	rw_ypbc_RwVlr_Vlr_g_schema

vlr data

vlr:vlr-catalog

Key Identifiers:

XPath Path	/vlr:vlr-catalog
XPath Keyed Path	/vlr:vlr-catalog
RW.REST URI Path	/vlr:vlr-catalog

Fields

Name	Type	Description
vlr	LIST

JSON Sample

{
  "vlr": [
    {
      "id": "STRING",
      "name": "STRING",
      "nsr-id-ref": "STRING",
      "vld-ref": "STRING",
      "res-id": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "type": "ELAN",
      "root-bandwidth": 0,
      "leaf-bandwidth": 0,
      "create-time": 0,
      "uptime": 0,
      "network-id": "STRING",
      "vim-network-name": "STRING",
      "provider-network": { ... },
      "ip-profile-params": { ... },
      "status": "LINK_UP",
      "operational-status": "init",
      "rw-vlr:cloud-account": "LEAFREF_VALUE",
      "rw-vlr:om-datacenter": "STRING",
      "rw-vlr:network_pool": "STRING",
      "rw-vlr:assigned-subnet": "STRING",
      "rw-vlr:operational-status-details": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vlr:vlr-catalog xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <vlr:vlr>
    <vlr:id>STRING</vlr:id>
    <vlr:name>STRING</vlr:name>
    <vlr:nsr-id-ref>STRING</vlr:nsr-id-ref>
    <vlr:vld-ref>STRING</vlr:vld-ref>
    <vlr:res-id>STRING</vlr:res-id>
    <vlr:short-name>STRING</vlr:short-name>
    <vlr:vendor>STRING</vlr:vendor>
    <vlr:description>STRING</vlr:description>
    <vlr:version>STRING</vlr:version>
    <vlr:type>ELAN</vlr:type>
    <vlr:root-bandwidth>0</vlr:root-bandwidth>
    <vlr:leaf-bandwidth>0</vlr:leaf-bandwidth>
    <vlr:create-time>0</vlr:create-time>
    <vlr:uptime>0</vlr:uptime>
    <vlr:network-id>STRING</vlr:network-id>
    <vlr:vim-network-name>STRING</vlr:vim-network-name>
    <vlr:provider-network>...</vlr:provider-network>
    <vlr:ip-profile-params>...</vlr:ip-profile-params>
    <vlr:status>LINK_UP</vlr:status>
    <vlr:operational-status>init</vlr:operational-status>
    <rw-vlr:cloud-account xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">LEAFREF_VALUE</rw-vlr:cloud-account>
    <rw-vlr:om-datacenter xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:om-datacenter>
    <rw-vlr:network_pool xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:network_pool>
    <rw-vlr:assigned-subnet xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:assigned-subnet>
    <rw-vlr:operational-status-details xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:operational-status-details>
  </vlr:vlr>
</vlr:vlr-catalog>

vlr:vlr

Key Identifiers:

XPath Path	/vlr:vlr-catalog/vlr:vlr
XPath Keyed Path	/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']
RW.REST URI Path	/vlr:vlr-catalog/vlr/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VLR.
name	STRING	VLR name.
nsr-id-ref	STRING	NS instance identifier. This is a leafref /nsr:ns-instance-config/nsr:nsr/nsr:id
vld-ref	STRING	Reference to VLD /nsr:ns-instance-config/nsr:nsr[nsr:id=../nsr-id-ref]/nsd/vld:vld/vld:id
res-id	STRING	Identifier for resmgr id mapping
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Provider of the VLR.
description	STRING	Description of the VLR.
version	STRING	Version of the VLR
type	ENUM
root-bandwidth	UINT64	For ELAN this is the aggregate bandwidth.
leaf-bandwidth	UINT64	For ELAN this is the bandwidth of branches.
create-time	UINT32	Creation timestamp of this Virtual Link. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
uptime	UINT32	Active period of this Virtual Link. Uptime is expressed in seconds
network-id	STRING	Identifier for the allocated network resource.
vim-network-name	STRING	Name of network in VIM account. This is used to indicate pre-provisioned network name in cloud account.
provider-network	CONTAINER	Container for the provider network.
ip-profile-params	CONTAINER
status	ENUM	Status of the virtual link record.
operational-status	ENUM	The operational status of the Virtual Link init : The VL is in init stat. vl-alloc-pending : The VL alloc is pending in VIM running : The VL is up and running in VM vl-terminate-pending : The VL is being terminated in VIM. terminated : The VL is terminated in the VM. failed : The VL instantiation failed in VIM.
cloud-account	LEAFREF	The cloud account to use when requesting resources for this vlr
om-datacenter	STRING	Openmano datacenter name to use when instantiating the network service. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.
network_pool	STRING	The network pool the resource was allocated from.
assigned-subnet	STRING	Subnet added for the VL
operational-status-details	STRING	The error message in case of a failed VLR operational status

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "nsr-id-ref": "STRING",
    "vld-ref": "STRING",
    "res-id": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "create-time": 0,
    "uptime": 0,
    "network-id": "STRING",
    "vim-network-name": "STRING",
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "segmentation_id": 0
    },
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    },
    "status": "LINK_UP",
    "operational-status": "init",
    "rw-vlr:cloud-account": "LEAFREF_VALUE",
    "rw-vlr:om-datacenter": "STRING",
    "rw-vlr:network_pool": "STRING",
    "rw-vlr:assigned-subnet": "STRING",
    "rw-vlr:operational-status-details": "STRING"
  }, {
    ...
  }
]

XML Sample

<vlr:vlr xmlns:vlr="urn:ietf:params:xml:ns:yang:nfvo:vlr">
  <vlr:id>STRING</vlr:id>
  <vlr:name>STRING</vlr:name>
  <vlr:nsr-id-ref>STRING</vlr:nsr-id-ref>
  <vlr:vld-ref>STRING</vlr:vld-ref>
  <vlr:res-id>STRING</vlr:res-id>
  <vlr:short-name>STRING</vlr:short-name>
  <vlr:vendor>STRING</vlr:vendor>
  <vlr:description>STRING</vlr:description>
  <vlr:version>STRING</vlr:version>
  <vlr:type>ELAN</vlr:type>
  <vlr:root-bandwidth>0</vlr:root-bandwidth>
  <vlr:leaf-bandwidth>0</vlr:leaf-bandwidth>
  <vlr:create-time>0</vlr:create-time>
  <vlr:uptime>0</vlr:uptime>
  <vlr:network-id>STRING</vlr:network-id>
  <vlr:vim-network-name>STRING</vlr:vim-network-name>
  <vlr:provider-network>
    <vlr:physical-network>STRING</vlr:physical-network>
    <vlr:overlay-type>LOCAL</vlr:overlay-type>
    <vlr:segmentation_id>0</vlr:segmentation_id>
  </vlr:provider-network>
  <vlr:ip-profile-params>
    <vlr:ip-version>ipv4</vlr:ip-version>
    <vlr:subnet-address>UNION_VALUE</vlr:subnet-address>
    <vlr:gateway-address>UNION_VALUE</vlr:gateway-address>
    <vlr:security-group>STRING</vlr:security-group>
    <vlr:dns-server>...</vlr:dns-server>
    <vlr:dhcp-params>...</vlr:dhcp-params>
    <vlr:subnet-prefix-pool>STRING</vlr:subnet-prefix-pool>
  </vlr:ip-profile-params>
  <vlr:status>LINK_UP</vlr:status>
  <vlr:operational-status>init</vlr:operational-status>
  <rw-vlr:cloud-account xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">LEAFREF_VALUE</rw-vlr:cloud-account>
  <rw-vlr:om-datacenter xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:om-datacenter>
  <rw-vlr:network_pool xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:network_pool>
  <rw-vlr:assigned-subnet xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:assigned-subnet>
  <rw-vlr:operational-status-details xmlns:rw-vlr="http://riftio.com/ns/riftware-1.0/rw-vlr">STRING</rw-vlr:operational-status-details>
</vlr:vlr>

vlr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path	/vlr:vlr-catalog/vlr:vlr/vlr:provider-network
XPath Keyed Path	/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:provider-network
RW.REST URI Path	/vlr:vlr-catalog/vlr/STRING/provider-network

Fields

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

JSON Sample

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

XML Sample

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

vlr:ip-profile-params

Key Identifiers:

XPath Path	/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params
XPath Keyed Path	/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params
RW.REST URI Path	/vlr:vlr-catalog/vlr/STRING/ip-profile-params

Fields

Name	Type	Description
ip-version	ENUM
subnet-address	UNION	Subnet IP prefix associated with IP Profile
gateway-address	UNION	IP Address of the default gateway associated with IP Profile
security-group	STRING	Name of the security group
dns-server	LIST
dhcp-params	CONTAINER
subnet-prefix-pool	STRING	VIM Specific reference to pre-created subnet prefix

JSON Sample

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

XML Sample

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

vlr:dns-server

Key Identifiers:

XPath Path

/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dns-server

XPath Keyed Path

/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dns-server[vlr:address='UNION_VALUE']

RW.REST URI Path

/vlr:vlr-catalog/vlr/STRING/ip-profile-params/dns-server/UNION_VALUE

Fields

Name	Type	Description
address	UNION	List of DNS Servers associated with IP Profile

JSON Sample

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

XML Sample

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

vlr:dhcp-params

Key Identifiers:

XPath Path	/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dhcp-params
XPath Keyed Path	/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dhcp-params
RW.REST URI Path	/vlr:vlr-catalog/vlr/STRING/ip-profile-params/dhcp-params

Fields

Name	Type	Description
enabled	BOOLEAN	This flag indicates if DHCP is enabled or not
start-address	UNION	Start IP address of the IP-Address range associated with DHCP domain
count	UINT32	Size of the DHCP pool associated with DHCP domain

JSON Sample

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

XML Sample

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

rw-vlr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwVlr_RwVlr_t_schema
Global Schema Pointer	rw_ypbc_RwVlr_RwVlr_g_schema