vld - User documentation

Schema Globals

Global Schema Type	rw_ypbc_Vld_Vld_t_schema
Global Schema Pointer	rw_ypbc_Vld_Vld_g_schema

vld data

vld:vld-catalog

Key Identifiers:

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

Fields

Name	Type	Description
vld	LIST

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

vld:vld

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING	Identifier for the VLD.
name	STRING	Virtual Link Descriptor (VLD) name.
short-name	STRING	Short name for VLD for UI
vendor	STRING	Provider of the VLD.
description	STRING	Description of the VLD.
version	STRING	Version of the VLD
type	ENUM
root-bandwidth	UINT64	For ELAN this is the aggregate bandwidth.
leaf-bandwidth	UINT64	For ELAN this is the bandwidth of branches.
vnfd-connection-point-ref	LIST	A list of references to connection points.
provider-network	CONTAINER	Container for the provider network.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

vld:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

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

XPath Keyed Path

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

RW.REST URI Path

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

Fields

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

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

vld:provider-network

Container for the provider network.

Key Identifiers:

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

Fields

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

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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