User documentation for yang module vlr.yang

module vlr                                                                   1
  vlr data                                                                 1.1
    container vlr:vlr-catalog                                            1.1.1
      list vlr:vlr                                                     1.1.1.1
        container vlr:provider-network                               1.1.1.1.1
        container vlr:ip-profile-params                              1.1.1.1.2
          list vlr:dns-server                                      1.1.1.1.2.1
          container vlr:dhcp-params                                1.1.1.1.2.2


1  module vlr

1.1  vlr data

1.1.1  container vlr:vlr-catalog
  XPath Path
    /vlr:vlr-catalog
  XPath Keyed Path
    /vlr:vlr-catalog
  RW.REST URI Path
    /vlr:vlr-catalog
  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"
        }, {
          ...
        }
      ]
    }
  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>
      </vlr:vlr>
    </vlr:vlr-catalog>

1.1.1.1  list vlr:vlr
  Leaves
    name: id, type: STRING, description: Identifier for the VLR.
    name: name, type: STRING, description: VLR name.
    name: nsr-id-ref, type: STRING, description: NS instance identifier.
    This is a leafref /nsr:ns-instance-config/nsr:nsr/nsr:id
    name: vld-ref, type: STRING, description: Reference to VLD
    /nsr:ns-instance-config/nsr:nsr[nsr:id=../nsr-id-ref]/nsd/vld:vld/vld:id
    name: res-id, type: STRING, description: Identifier for resmgr id mapping
    name: short-name, type: STRING, description: Short name to appear as label in the UI
    name: vendor, type: STRING, description: Provider of the VLR.
    name: description, type: STRING, description: Description of the VLR.
    name: version, type: STRING, description: Version of the VLR
    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.
    name: create-time, type: UINT32, description: Creation timestamp of this Virtual Link.
    The timestamp is expressed as seconds
    since unix epoch - 1970-01-01T00:00:00Z
    name: uptime, type: UINT32, description: Active period of this Virtual Link.
    Uptime is expressed in seconds
    name: network-id, type: STRING, description: Identifier for the allocated network resource.
    name: vim-network-name, type: STRING, description: Name of network in VIM account. This is used to indicate
    pre-provisioned network name in cloud account.
    name: status, type: ENUM, description: Status of the virtual link record.
    name: operational-status, type: ENUM, description: 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.
  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
  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"
      }, {
        ...
      }
    ]
  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>
    </vlr:vlr>

1.1.1.1.1  container vlr: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
    /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
  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>

1.1.1.1.2  container vlr:ip-profile-params
  Leaves
    name: ip-version, type: ENUM
    name: subnet-address, type: UNION, description: Subnet IP prefix associated with IP Profile
    name: gateway-address, type: UNION, description: IP Address of the default gateway associated with IP Profile
    name: security-group, type: STRING, description: Name of the security group
    name: subnet-prefix-pool, type: STRING, description: VIM Specific reference to pre-created subnet prefix
  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
  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>

1.1.1.1.2.1  list vlr:dns-server
  Leaves
    name: address, type: UNION, description: List of DNS Servers associated with IP Profile
  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
  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>

1.1.1.1.2.2  container vlr:dhcp-params
  Leaves
    name: enabled, type: BOOLEAN, description: This flag indicates if DHCP is enabled or not
    name: start-address, type: UNION, description: Start IP address of the IP-Address range associated with DHCP domain
    name: count, type: UINT32, description: Size of the DHCP pool associated with DHCP domain
  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
  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>

