Programmer's API documentation for yang module vld.yang



Schema Globals                                                               1

module vld                                                                   2
  vld data                                                                 2.1
    container vld:vld-catalog                                            2.1.1
      list vld:vld                                                     2.1.1.1
        list vld:vnfd-connection-point-ref                           2.1.1.1.1
        container vld:provider-network                               2.1.1.1.2


1  Schema Globals
  Global Schema Type
    rw_ypbc_Vld_t_schema
  Global Schema Pointer
    rw_ypbc_Vld_g_schema
2  module vld

2.1  vld data

2.1.1  container vld:vld-catalog
  XPath Path
    /vld:vld-catalog
  XPath Keyed Path
    /vld:vld-catalog
  RW.REST URI Path
    /vld:vld-catalog
  RW Keyspec XPath Path
    C,/vld:vld-catalog
  RW Keyspec XPath Keyed Path
    C,/vld:vld-catalog
  Protobuf Type
    .vld.YangData.Vld.VldCatalog
  Python Proto-GI Type
    VldYang.YangData_Vld_VldCatalog
  C Protobuf-C Struct Type
    Vld__YangData__Vld__VldCatalog
  C RWPB Identifiers
    Vld_Vld_data_VldCatalog
    Vld_data_VldCatalog
  YPBC Base Identifier
    rw_ypbc_Vld_Vld_data_VldCatalog

2.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
  RW Keyspec XPath Path
    C,/vld:vld-catalog/vld:vld
  RW Keyspec XPath Keyed Path
    C,/vld:vld-catalog/vld:vld[vld:id='STRING']
  Protobuf Type
    .vld.YangData.Vld.VldCatalog.Vld
  Python Proto-GI Type
    VldYang.YangData_Vld_VldCatalog_Vld
  C Protobuf-C Struct Type
    Vld__YangData__Vld__VldCatalog__Vld
  C RWPB Identifiers
    Vld_Vld_data_VldCatalog_Vld
    Vld_data_VldCatalog_Vld
  YPBC Base Identifier
    rw_ypbc_Vld_Vld_data_VldCatalog_Vld

2.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
  RW Keyspec XPath Path
    C,/vld:vld-catalog/vld:vld/vld:vnfd-connection-point-ref
  RW Keyspec XPath Keyed Path
    C,/vld:vld-catalog/vld:vld[vld:id='STRING']/vld:vnfd-connection-point-ref[vld:vnfd-ref='STRING'][vld:member-vnf-index-ref='0']
  Protobuf Type
    .vld.YangData.Vld.VldCatalog.Vld.VnfdConnectionPointRef
  Python Proto-GI Type
    VldYang.YangData_Vld_VldCatalog_Vld_VnfdConnectionPointRef
  C Protobuf-C Struct Type
    Vld__YangData__Vld__VldCatalog__Vld__VnfdConnectionPointRef
  C RWPB Identifiers
    Vld_Vld_data_VldCatalog_Vld_VnfdConnectionPointRef
    Vld_data_VldCatalog_Vld_VnfdConnectionPointRef
  YPBC Base Identifier
    rw_ypbc_Vld_Vld_data_VldCatalog_Vld_VnfdConnectionPointRef

2.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
  RW Keyspec XPath Path
    C,/vld:vld-catalog/vld:vld/vld:provider-network
  RW Keyspec XPath Keyed Path
    C,/vld:vld-catalog/vld:vld[vld:id='STRING']/vld:provider-network
  Protobuf Type
    .vld.YangData.Vld.VldCatalog.Vld.ProviderNetwork
  Python Proto-GI Type
    VldYang.YangData_Vld_VldCatalog_Vld_ProviderNetwork
  C Protobuf-C Struct Type
    Vld__YangData__Vld__VldCatalog__Vld__ProviderNetwork
  C RWPB Identifiers
    Vld_Vld_data_VldCatalog_Vld_ProviderNetwork
    Vld_data_VldCatalog_Vld_ProviderNetwork
  YPBC Base Identifier
    rw_ypbc_Vld_Vld_data_VldCatalog_Vld_ProviderNetwork

