User documentation for yang module vld.yang

module vld                                                                   1
  vld data                                                                 1.1
    container vld:vld-catalog                                            1.1.1
      list vld:vld                                                     1.1.1.1
        list vld:vnfd-connection-point-ref                           1.1.1.1.1
        container vld:provider-network                               1.1.1.1.2


1  module vld

1.1  vld data

1.1.1  container vld:vld-catalog
  XPath Path
    /vld:vld-catalog
  XPath Keyed Path
    /vld:vld-catalog
  RW.REST URI Path
    /vld:vld-catalog
  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>

1.1.1.1  list vld:vld
  Leaves
    name: id, type: STRING, description: Identifier for the VLD.
    name: name, type: STRING, description: Virtual Link Descriptor (VLD) name.
    name: short-name, type: STRING, description: Short name for VLD for UI
    name: vendor, type: STRING, description: Provider of the VLD.
    name: description, type: STRING, description: Description of the VLD.
    name: version, type: STRING, description: Version of the VLD
    name: type, type: ENUM
    name: root-bandwidth, type: UINT64, description: For ELAN this is the aggregate bandwidth.
    name: leaf-bandwidth, type: UINT64, description: For ELAN this is the bandwidth of branches.
  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
  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>

1.1.1.1.1  list vld:vnfd-connection-point-ref
  Description
    A list of references to connection points.
  Leaves
    name: vnfd-ref, type: LEAFREF, description: A reference to a vnfd
    name: member-vnf-index-ref, type: UINT64, description: 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.
    name: vnfd-connection-point-ref, type: LEAFREF, description: A reference to a connection point name in a vnfd
  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
  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>

1.1.1.1.2  container vld:provider-network
  Description
    Container for the provider network.
  Leaves
    name: physical-network, type: STRING, description: Name of the physical network on which the provider
    network is built.
    name: overlay-type, type: ENUM, description: 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
    name: segmentation_id, type: UINT32, description: ID of segregated virtual networks
  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
  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>

