vlr - Programmers API Reference
Schema Globals
| Global Schema Type | rw_ypbc_Vlr_Vlr_t_schema |
| Global Schema Pointer | rw_ypbc_Vlr_Vlr_g_schema |
vlr data
vlr:vlr-catalog
Key Identifiers:| 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 | .vlr.YangData.Vlr.VlrCatalog |
| Python Proto-GI Type | VlrYang.YangData_Vlr_VlrCatalog |
| C Protobuf-C Struct Type | Vlr__YangData__Vlr__VlrCatalog |
| C RWPB Identifiers | Vlr_Vlr_data_VlrCatalog Vlr_data_VlrCatalog |
| YPBC Base Identifier | rw_ypbc_Vlr_Vlr_data_VlrCatalog |
Fields
| Name | Type | Description |
|---|---|---|
| vlr | LIST |
vlr:vlr
Key Identifiers:| 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 | .vlr.YangData.Vlr.VlrCatalog.Vlr |
| Python Proto-GI Type | VlrYang.YangData_Vlr_VlrCatalog_Vlr |
| C Protobuf-C Struct Type | Vlr__YangData__Vlr__VlrCatalog__Vlr |
| C RWPB Identifiers | Vlr_Vlr_data_VlrCatalog_Vlr Vlr_data_VlrCatalog_Vlr |
| YPBC Base Identifier | rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr |
Fields
| Name | Type | Description |
|---|---|---|
| id | STRING | Identifier for the VLR. |
| name | STRING | VLR name. |
| nsr-id-ref | STRING | NS instance identifier. This is a leafref /nsr:ns-instance-config/nsr:nsr/nsr:id |
| vld-ref | STRING | Reference to VLD /nsr:ns-instance-config/nsr:nsr[nsr:id=../nsr-id-ref]/nsd/vld:vld/vld:id |
| res-id | STRING | Identifier for resmgr id mapping |
| short-name | STRING | Short name to appear as label in the UI |
| vendor | STRING | Provider of the VLR. |
| description | STRING | Description of the VLR. |
| version | STRING | Version of the VLR |
| type | ENUM | |
| root-bandwidth | UINT64 | For ELAN this is the aggregate bandwidth. |
| leaf-bandwidth | UINT64 | For ELAN this is the bandwidth of branches. |
| create-time | UINT32 | Creation timestamp of this Virtual Link. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z |
| uptime | UINT32 | Active period of this Virtual Link. Uptime is expressed in seconds |
| network-id | STRING | Identifier for the allocated network resource. |
| vim-network-name | STRING | Name of network in VIM account. This is used to indicate pre-provisioned network name in cloud account. |
| provider-network | CONTAINER | Container for the provider network. |
| ip-profile-params | CONTAINER | |
| status | ENUM | Status of the virtual link record. |
| operational-status | ENUM | 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. |
vlr:provider-network
Container for the provider network.
Key Identifiers:| 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 Vlr_data_VlrCatalog_Vlr_ProviderNetwork |
| YPBC Base Identifier | rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr_ProviderNetwork |
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 |
vlr:ip-profile-params
Key Identifiers:| 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 Vlr_data_VlrCatalog_Vlr_IpProfileParams |
| YPBC Base Identifier | rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams |
Fields
| Name | Type | Description |
|---|---|---|
| ip-version | ENUM | |
| subnet-address | UNION | Subnet IP prefix associated with IP Profile |
| gateway-address | UNION | IP Address of the default gateway associated with IP Profile |
| security-group | STRING | Name of the security group |
| dns-server | LIST | |
| dhcp-params | CONTAINER | |
| subnet-prefix-pool | STRING | VIM Specific reference to pre-created subnet prefix |
vlr:dns-server
Key Identifiers:| 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 Vlr_data_VlrCatalog_Vlr_IpProfileParams_DnsServer |
| YPBC Base Identifier | rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams_DnsServer |
Fields
| Name | Type | Description |
|---|---|---|
| address | UNION | List of DNS Servers associated with IP Profile |
vlr:dhcp-params
Key Identifiers:| 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 Vlr_data_VlrCatalog_Vlr_IpProfileParams_DhcpParams |
| YPBC Base Identifier | rw_ypbc_Vlr_Vlr_data_VlrCatalog_Vlr_IpProfileParams_DhcpParams |
Fields
| Name | Type | Description |
|---|---|---|
| enabled | BOOLEAN | This flag indicates if DHCP is enabled or not |
| start-address | UNION | Start IP address of the IP-Address range associated with DHCP domain |
| count | UINT32 | Size of the DHCP pool associated with DHCP domain |