Programmer's API documentation for yang module rw-vlr.yang



Schema Globals                                                               1

module vlr                                                                   2
  vlr data                                                                 2.1
    container vlr:vlr-catalog                                            2.1.1
      list vlr:vlr                                                     2.1.1.1
        container vlr:provider-network                               2.1.1.1.1
        container vlr:ip-profile-params                              2.1.1.1.2
          list vlr:dns-server                                      2.1.1.1.2.1
          container vlr:dhcp-params                                2.1.1.1.2.2
module rw-vlr                                                                3


1  Schema Globals
  Global Schema Type
    rw_ypbc_RwVlr_t_schema
  Global Schema Pointer
    rw_ypbc_RwVlr_g_schema
2  module vlr

2.1  vlr data

2.1.1  container vlr:vlr-catalog
  XPath Path
    /vlr:vlr-catalog
  XPath Keyed Path
    /vlr:vlr-catalog
  RW.REST URI Path
    /vlr:vlr-catalog
  RW Keyspec XPath Path
    D,/vlr:vlr-catalog
  RW Keyspec XPath Keyed Path
    D,/vlr:vlr-catalog
  Protobuf Type
    .rw_vlr.YangData.Vlr.VlrCatalog
  Python Proto-GI Type
    RwVlrYang.YangData_Vlr_VlrCatalog
  C Protobuf-C Struct Type
    RwVlr__YangData__Vlr__VlrCatalog
  C RWPB Identifiers
    RwVlr_Vlr_data_VlrCatalog
  YPBC Base Identifier
    rw_ypbc_RwVlr_Vlr_data_VlrCatalog

2.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.

    name: cloud-account, type: LEAFREF, description: The cloud account to use when requesting resources for
    this vlr
    name: om-datacenter, type: STRING, description: 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.
    name: network_pool, type: STRING, description: The network pool the resource was allocated from.
    name: assigned-subnet, type: STRING, description: Subnet added for the VL
    name: operational-status-details, type: STRING, description: The error message in case of a failed VLR operational status
  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
  RW Keyspec XPath Path
    D,/vlr:vlr-catalog/vlr:vlr
  RW Keyspec XPath Keyed Path
    D,/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']
  Protobuf Type
    .rw_vlr.YangData.Vlr.VlrCatalog.Vlr
  Python Proto-GI Type
    RwVlrYang.YangData_Vlr_VlrCatalog_Vlr
  C Protobuf-C Struct Type
    RwVlr__YangData__Vlr__VlrCatalog__Vlr
  C RWPB Identifiers
    RwVlr_Vlr_data_VlrCatalog_Vlr
  YPBC Base Identifier
    rw_ypbc_RwVlr_Vlr_data_VlrCatalog_Vlr

2.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
  RW Keyspec XPath Path
    D,/vlr:vlr-catalog/vlr:vlr/vlr:provider-network
  RW Keyspec XPath Keyed Path
    D,/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:provider-network
  Protobuf Type
    .vlr.YangData.Vlr.VlrCatalog.Vlr.ProviderNetwork
  Python Proto-GI Type
    VlrYang.YangData_Vlr_VlrCatalog_Vlr_ProviderNetwork
  C Protobuf-C Struct Type
    Vlr__YangData__Vlr__VlrCatalog__Vlr__ProviderNetwork
  C RWPB Identifiers
    Vlr_Vlr_data_VlrCatalog_Vlr_ProviderNetwork
  YPBC Base Identifier
    rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr_ProviderNetwork

2.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
  RW Keyspec XPath Path
    D,/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params
  RW Keyspec XPath Keyed Path
    D,/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params
  Protobuf Type
    .vlr.YangData.Vlr.VlrCatalog.Vlr.IpProfileParams
  Python Proto-GI Type
    VlrYang.YangData_Vlr_VlrCatalog_Vlr_IpProfileParams
  C Protobuf-C Struct Type
    Vlr__YangData__Vlr__VlrCatalog__Vlr__IpProfileParams
  C RWPB Identifiers
    Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams
  YPBC Base Identifier
    rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams

2.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
  RW Keyspec XPath Path
    D,/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dns-server
  RW Keyspec XPath Keyed Path
    D,/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dns-server[vlr:address='UNION_VALUE']
  Protobuf Type
    .vlr.YangData.Vlr.VlrCatalog.Vlr.IpProfileParams.DnsServer
  Python Proto-GI Type
    VlrYang.YangData_Vlr_VlrCatalog_Vlr_IpProfileParams_DnsServer
  C Protobuf-C Struct Type
    Vlr__YangData__Vlr__VlrCatalog__Vlr__IpProfileParams__DnsServer
  C RWPB Identifiers
    Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams_DnsServer
  YPBC Base Identifier
    rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams_DnsServer

2.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
  RW Keyspec XPath Path
    D,/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dhcp-params
  RW Keyspec XPath Keyed Path
    D,/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dhcp-params
  Protobuf Type
    .vlr.YangData.Vlr.VlrCatalog.Vlr.IpProfileParams.DhcpParams
  Python Proto-GI Type
    VlrYang.YangData_Vlr_VlrCatalog_Vlr_IpProfileParams_DhcpParams
  C Protobuf-C Struct Type
    Vlr__YangData__Vlr__VlrCatalog__Vlr__IpProfileParams__DhcpParams
  C RWPB Identifiers
    Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams_DhcpParams
  YPBC Base Identifier
    rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams_DhcpParams

3  module rw-vlr

