Programmer's API documentation for yang module vlr.yang



Schema Globals                                                               1

module rw-project                                                            2
  rw-project data                                                          2.1
    list rw-project:project                                              2.1.1
      container rw-project:project-config                              2.1.1.1
        list rw-project:user                                         2.1.1.1.1
          list rw-project:role                                     2.1.1.1.1.1
      container rw-project:project-state                               2.1.1.2
        list rw-project:user                                         2.1.1.2.1
          list rw-project:role                                     2.1.1.2.1.1
        list rw-project:role                                         2.1.1.2.2
      container vlr:vlr-catalog                                        2.1.1.3
        list vlr:vlr                                                 2.1.1.3.1
          container vlr:provider-network                           2.1.1.3.1.1
          container vlr:ip-profile-params                          2.1.1.3.1.2
            list vlr:dns-server                                  2.1.1.3.1.2.1
            container vlr:dhcp-params                            2.1.1.3.1.2.2
module vlr                                                                   3


1  Schema Globals
  Global Schema Type
    rw_ypbc_Vlr_t_schema
  Global Schema Pointer
    rw_ypbc_Vlr_g_schema
2  module rw-project

2.1  rw-project data
  Description
    This yang module defines project-based tenancy for RIFT.ware.
    Authorization for project access is defined in terms of RIFT.ware's
    Role-Based Access Control (RBAC) model.

2.1.1  list rw-project:project
  Description
    Configuration and state for individual projects.  RIFT.ware
    applications and projects are expected to augment this list in
    order to add configuration for projects that is specific to the
    product or application.  As such, this list contains minimal
    data defined in this yang module.

    When augmenting this element, other yang modules should prefer to
    define containers with the same name as the augmenting module.
    (Augmenting RIFT.ware modules should prefer to augment without
    the rw prefix [for new features], or should prefer to augment the
    augmented container of an existing augment, to ease future
    adoption and/or standardization.)
  Leaves
    name: name, type: STRING, description: Name of the project.
    name: description, type: STRING, description: Information about project
  XPath Path
    /rw-project:project
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']
  RW.REST URI Path
    /rw-project:project/STRING
  RW Keyspec XPath Path
    C,/rw-project:project
  RW Keyspec XPath Keyed Path
    C,/rw-project:project[rw-project:name='STRING']
  RW Keyspec XPath Path
    D,/rw-project:project
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']
  Protobuf Type
    .vlr.YangData.RwProject.Project
  Python Proto-GI Type
    VlrYang.YangData_RwProject_Project
  C Protobuf-C Struct Type
    Vlr__YangData__RwProject__Project
  C RWPB Identifiers
    Vlr_RwProject_data_Project
  YPBC Base Identifier
    rw_ypbc_Vlr_RwProject_data_Project

2.1.1.1  container rw-project:project-config
  Description
    General Project configuration supported by all products.
  XPath Path
    /rw-project:project/rw-project:project-config
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/rw-project:project-config
  RW.REST URI Path
    /rw-project:project/STRING/project-config
  RW Keyspec XPath Path
    C,/rw-project:project/rw-project:project-config
  RW Keyspec XPath Keyed Path
    C,/rw-project:project[rw-project:name='STRING']/rw-project:project-config
  Protobuf Type
    .rw_project.YangData.RwProject.Project.ProjectConfig
  Python Proto-GI Type
    RwProjectYang.YangData_RwProject_Project_ProjectConfig
  C Protobuf-C Struct Type
    RwProject__YangData__RwProject__Project__ProjectConfig
  C RWPB Identifiers
    RwProject_RwProject_data_Project_ProjectConfig
  YPBC Base Identifier
    rw_ypbc_RwProject_RwProject_data_Project_ProjectConfig

2.1.1.1.1  list rw-project:user
  Description
    The list of Users who have been assigned Roles within this
    Project.
  Leaves
    name: user-domain, type: LEAFREF, description: The user domain.  This is the source of the user identity.
    Different domains may duplicate a user-name, but such users
    would be considered distinct by RIFT.ware.
    name: user-name, type: LEAFREF, description: The user name.  The syntax of this name depends on the domain.
    For example, if the domain is a login name, it might be limited
    to alphanumeric characters.  However, if the domain is email address,
    the syntax could include additional characters, such as the at(@) sign.
  XPath Path
    /rw-project:project/rw-project:project-config/rw-project:user
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']
  RW.REST URI Path
    /rw-project:project/STRING/project-config/user/STRING,STRING
  RW Keyspec XPath Path
    C,/rw-project:project/rw-project:project-config/rw-project:user
  RW Keyspec XPath Keyed Path
    C,/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']
  Protobuf Type
    .rw_project.YangData.RwProject.Project.ProjectConfig.User
  Python Proto-GI Type
    RwProjectYang.YangData_RwProject_Project_ProjectConfig_User
  C Protobuf-C Struct Type
    RwProject__YangData__RwProject__Project__ProjectConfig__User
  C RWPB Identifiers
    RwProject_RwProject_data_Project_ProjectConfig_User
  YPBC Base Identifier
    rw_ypbc_RwProject_RwProject_data_Project_ProjectConfig_User

2.1.1.1.1.1  list rw-project:role
  Description
    The list of Roles the User has been assigned.
  Leaves
    name: role, type: STRING, description: The Role, independent of Keys.
  XPath Path
    /rw-project:project/rw-project:project-config/rw-project:user/rw-project:role
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING']
  RW.REST URI Path
    /rw-project:project/STRING/project-config/user/STRING,STRING/role/STRING
  RW Keyspec XPath Path
    C,/rw-project:project/rw-project:project-config/rw-project:user/rw-project:role
  RW Keyspec XPath Keyed Path
    C,/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING']
  Protobuf Type
    .rw_project.YangData.RwProject.Project.ProjectConfig.User.Role
  Python Proto-GI Type
    RwProjectYang.YangData_RwProject_Project_ProjectConfig_User_Role
  C Protobuf-C Struct Type
    RwProject__YangData__RwProject__Project__ProjectConfig__User__Role
  C RWPB Identifiers
    RwProject_RwProject_data_Project_ProjectConfig_User_Role
  YPBC Base Identifier
    rw_ypbc_RwProject_RwProject_data_Project_ProjectConfig_User_Role

2.1.1.2  container rw-project:project-state
  Description
    General Project operational state supported by all products.
  XPath Path
    /rw-project:project/rw-project:project-state
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/rw-project:project-state
  RW.REST URI Path
    /rw-project:project/STRING/project-state
  RW Keyspec XPath Path
    D,/rw-project:project/rw-project:project-state
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/rw-project:project-state
  Protobuf Type
    .rw_project.YangData.RwProject.Project.ProjectState
  Python Proto-GI Type
    RwProjectYang.YangData_RwProject_Project_ProjectState
  C Protobuf-C Struct Type
    RwProject__YangData__RwProject__Project__ProjectState
  C RWPB Identifiers
    RwProject_RwProject_data_Project_ProjectState
  YPBC Base Identifier
    rw_ypbc_RwProject_RwProject_data_Project_ProjectState

2.1.1.2.1  list rw-project:user
  Description
    The state of Users who have been assigned Roles within
    this Project.
  Leaves
    name: user-domain, type: STRING, description: The user domain.  This is the source of the user identity.
    Different domains may duplicate a user-name, but such users
    would be considered distinct by RIFT.ware.
    name: user-name, type: STRING, description: The user name.  The syntax of this name depends on the domain.
    For example, if the domain is a login name, it might be limited
    to alphanumeric characters.  However, if the domain is some
    kind of email address, the syntax could include assitional
    characters, such as the at sign.
  XPath Path
    /rw-project:project/rw-project:project-state/rw-project:user
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']
  RW.REST URI Path
    /rw-project:project/STRING/project-state/user/STRING,STRING
  RW Keyspec XPath Path
    D,/rw-project:project/rw-project:project-state/rw-project:user
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']
  Protobuf Type
    .rw_project.YangData.RwProject.Project.ProjectState.User
  Python Proto-GI Type
    RwProjectYang.YangData_RwProject_Project_ProjectState_User
  C Protobuf-C Struct Type
    RwProject__YangData__RwProject__Project__ProjectState__User
  C RWPB Identifiers
    RwProject_RwProject_data_Project_ProjectState_User
  YPBC Base Identifier
    rw_ypbc_RwProject_RwProject_data_Project_ProjectState_User

2.1.1.2.1.1  list rw-project:role
  Description
    The state of the Roles the User has been assigned.
  Leaves
    name: role, type: STRING, description: The Role, independent of Keys.
    name: state, type: STRING, description: The assignment of a User to a Role may be an asynchronous
    operation.  This value indicates whether the Role
    assignment is active.  If the value is 'active', then the
    assignment is complete and active.  Any other value
    indicates that Role assignment is in a transitional or
    failed state, as described in the value.
  XPath Path
    /rw-project:project/rw-project:project-state/rw-project:user/rw-project:role
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING']
  RW.REST URI Path
    /rw-project:project/STRING/project-state/user/STRING,STRING/role/STRING
  RW Keyspec XPath Path
    D,/rw-project:project/rw-project:project-state/rw-project:user/rw-project:role
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING']
  Protobuf Type
    .rw_project.YangData.RwProject.Project.ProjectState.User.Role
  Python Proto-GI Type
    RwProjectYang.YangData_RwProject_Project_ProjectState_User_Role
  C Protobuf-C Struct Type
    RwProject__YangData__RwProject__Project__ProjectState__User__Role
  C RWPB Identifiers
    RwProject_RwProject_data_Project_ProjectState_User_Role
  YPBC Base Identifier
    rw_ypbc_RwProject_RwProject_data_Project_ProjectState_User_Role

2.1.1.2.2  list rw-project:role
  Description
    The set of Roles that may be configured into
    /rw-project:project/rw-project:config/rw-project:user/
    rw-project:role.
  Leaves
    name: role, type: STRING, description: The Role, independent of Keys.
    name: description, type: STRING, description: A description of the Role.
  XPath Path
    /rw-project:project/rw-project:project-state/rw-project:role
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:role[rw-project:role='STRING']
  RW.REST URI Path
    /rw-project:project/STRING/project-state/role/STRING
  RW Keyspec XPath Path
    D,/rw-project:project/rw-project:project-state/rw-project:role
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:role[rw-project:role='STRING']
  Protobuf Type
    .rw_project.YangData.RwProject.Project.ProjectState.Role
  Python Proto-GI Type
    RwProjectYang.YangData_RwProject_Project_ProjectState_Role
  C Protobuf-C Struct Type
    RwProject__YangData__RwProject__Project__ProjectState__Role
  C RWPB Identifiers
    RwProject_RwProject_data_Project_ProjectState_Role
  YPBC Base Identifier
    rw_ypbc_RwProject_RwProject_data_Project_ProjectState_Role

2.1.1.3  container vlr:vlr-catalog
  XPath Path
    /rw-project:project/vlr:vlr-catalog
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog
  RW.REST URI Path
    /rw-project:project/STRING/vlr:vlr-catalog
  RW Keyspec XPath Path
    D,/rw-project:project/vlr:vlr-catalog
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog
  Protobuf Type
    .vlr.YangData.RwProject.Project.VlrCatalog
  Python Proto-GI Type
    VlrYang.YangData_RwProject_Project_VlrCatalog
  C Protobuf-C Struct Type
    Vlr__YangData__RwProject__Project__VlrCatalog
  C RWPB Identifiers
    Vlr_RwProject_data_Project_VlrCatalog
  YPBC Base Identifier
    rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog

2.1.1.3.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 /rw-project:project/nsr:ns-instance-config/nsr:nsr/nsr:id
    name: vld-ref, type: STRING, description: Reference to VLD
    /rw-project:project/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
    /rw-project:project/vlr:vlr-catalog/vlr:vlr
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']
  RW.REST URI Path
    /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING
  RW Keyspec XPath Path
    D,/rw-project:project/vlr:vlr-catalog/vlr:vlr
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']
  Protobuf Type
    .vlr.YangData.RwProject.Project.VlrCatalog.Vlr
  Python Proto-GI Type
    VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr
  C Protobuf-C Struct Type
    Vlr__YangData__RwProject__Project__VlrCatalog__Vlr
  C RWPB Identifiers
    Vlr_RwProject_data_Project_VlrCatalog_Vlr
  YPBC Base Identifier
    rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr

2.1.1.3.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: segmentation_id, type: UINT32, description: ID of segregated virtual networks
  XPath Path
    /rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:provider-network
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:provider-network
  RW.REST URI Path
    /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/provider-network
  RW Keyspec XPath Path
    D,/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:provider-network
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:provider-network
  Protobuf Type
    .vlr.YangData.RwProject.Project.VlrCatalog.Vlr.ProviderNetwork
  Python Proto-GI Type
    VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr_ProviderNetwork
  C Protobuf-C Struct Type
    Vlr__YangData__RwProject__Project__VlrCatalog__Vlr__ProviderNetwork
  C RWPB Identifiers
    Vlr_RwProject_data_Project_VlrCatalog_Vlr_ProviderNetwork
  YPBC Base Identifier
    rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr_ProviderNetwork

2.1.1.3.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
    /rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params
  RW.REST URI Path
    /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/ip-profile-params
  RW Keyspec XPath Path
    D,/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params
  Protobuf Type
    .vlr.YangData.RwProject.Project.VlrCatalog.Vlr.IpProfileParams
  Python Proto-GI Type
    VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr_IpProfileParams
  C Protobuf-C Struct Type
    Vlr__YangData__RwProject__Project__VlrCatalog__Vlr__IpProfileParams
  C RWPB Identifiers
    Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams
  YPBC Base Identifier
    rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams

2.1.1.3.1.2.1  list vlr:dns-server
  Leaves
    name: address, type: UNION, description: List of DNS Servers associated with IP Profile
  XPath Path
    /rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dns-server
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dns-server[vlr:address='UNION_VALUE']
  RW.REST URI Path
    /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/ip-profile-params/dns-server/UNION_VALUE
  RW Keyspec XPath Path
    D,/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dns-server
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dns-server[vlr:address='UNION_VALUE']
  Protobuf Type
    .vlr.YangData.RwProject.Project.VlrCatalog.Vlr.IpProfileParams.DnsServer
  Python Proto-GI Type
    VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr_IpProfileParams_DnsServer
  C Protobuf-C Struct Type
    Vlr__YangData__RwProject__Project__VlrCatalog__Vlr__IpProfileParams__DnsServer
  C RWPB Identifiers
    Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams_DnsServer
  YPBC Base Identifier
    rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams_DnsServer

2.1.1.3.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
    /rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dhcp-params
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dhcp-params
  RW.REST URI Path
    /rw-project:project/STRING/vlr:vlr-catalog/vlr/STRING/ip-profile-params/dhcp-params
  RW Keyspec XPath Path
    D,/rw-project:project/vlr:vlr-catalog/vlr:vlr/vlr:ip-profile-params/vlr:dhcp-params
  RW Keyspec XPath Keyed Path
    D,/rw-project:project[rw-project:name='STRING']/vlr:vlr-catalog/vlr:vlr[vlr:id='STRING']/vlr:ip-profile-params/vlr:dhcp-params
  Protobuf Type
    .vlr.YangData.RwProject.Project.VlrCatalog.Vlr.IpProfileParams.DhcpParams
  Python Proto-GI Type
    VlrYang.YangData_RwProject_Project_VlrCatalog_Vlr_IpProfileParams_DhcpParams
  C Protobuf-C Struct Type
    Vlr__YangData__RwProject__Project__VlrCatalog__Vlr__IpProfileParams__DhcpParams
  C RWPB Identifiers
    Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams_DhcpParams
  YPBC Base Identifier
    rw_ypbc_Vlr_RwProject_data_Project_VlrCatalog_Vlr_IpProfileParams_DhcpParams

3  module vlr

