Programmer's API documentation for yang module pnfd.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 pnfd:pnfd-catalog                                      2.1.1.3
        list pnfd:pnfd                                               2.1.1.3.1
          list pnfd:connection-point                               2.1.1.3.1.1
module pnfd                                                                  3


1  Schema Globals
  Global Schema Type
    rw_ypbc_Pnfd_t_schema
  Global Schema Pointer
    rw_ypbc_Pnfd_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
    .pnfd.YangData.RwProject.Project
  Python Proto-GI Type
    PnfdYang.YangData_RwProject_Project
  C Protobuf-C Struct Type
    Pnfd__YangData__RwProject__Project
  C RWPB Identifiers
    Pnfd_RwProject_data_Project
  YPBC Base Identifier
    rw_ypbc_Pnfd_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 pnfd:pnfd-catalog
  XPath Path
    /rw-project:project/pnfd:pnfd-catalog
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/pnfd:pnfd-catalog
  RW.REST URI Path
    /rw-project:project/STRING/pnfd:pnfd-catalog
  RW Keyspec XPath Path
    C,/rw-project:project/pnfd:pnfd-catalog
  RW Keyspec XPath Keyed Path
    C,/rw-project:project[rw-project:name='STRING']/pnfd:pnfd-catalog
  Protobuf Type
    .pnfd.YangData.RwProject.Project.PnfdCatalog
  Python Proto-GI Type
    PnfdYang.YangData_RwProject_Project_PnfdCatalog
  C Protobuf-C Struct Type
    Pnfd__YangData__RwProject__Project__PnfdCatalog
  C RWPB Identifiers
    Pnfd_RwProject_data_Project_PnfdCatalog
  YPBC Base Identifier
    rw_ypbc_Pnfd_RwProject_data_Project_PnfdCatalog

2.1.1.3.1  list pnfd:pnfd
  Leaves
    name: id, type: STRING, description: Identifier for the PNFD.
    name: name, type: STRING, description: PNFD name.
    name: short-name, type: STRING, description: Short name to appear as label in the UI
    name: vendor, type: STRING, description: Vendor of the PNFD.
    name: description, type: STRING, description: Description of the PNFD.
    name: version, type: STRING, description: Version of the PNFD
  XPath Path
    /rw-project:project/pnfd:pnfd-catalog/pnfd:pnfd
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/pnfd:pnfd-catalog/pnfd:pnfd[pnfd:id='STRING']
  RW.REST URI Path
    /rw-project:project/STRING/pnfd:pnfd-catalog/pnfd/STRING
  RW Keyspec XPath Path
    C,/rw-project:project/pnfd:pnfd-catalog/pnfd:pnfd
  RW Keyspec XPath Keyed Path
    C,/rw-project:project[rw-project:name='STRING']/pnfd:pnfd-catalog/pnfd:pnfd[pnfd:id='STRING']
  Protobuf Type
    .pnfd.YangData.RwProject.Project.PnfdCatalog.Pnfd
  Python Proto-GI Type
    PnfdYang.YangData_RwProject_Project_PnfdCatalog_Pnfd
  C Protobuf-C Struct Type
    Pnfd__YangData__RwProject__Project__PnfdCatalog__Pnfd
  C RWPB Identifiers
    Pnfd_RwProject_data_Project_PnfdCatalog_Pnfd
  YPBC Base Identifier
    rw_ypbc_Pnfd_RwProject_data_Project_PnfdCatalog_Pnfd

2.1.1.3.1.1  list pnfd:connection-point
  Description
    List for external connection points. Each PNF has one or more external
    connection points.
  Leaves
    name: id, type: UINT64, description: Identifier for the external connection points
    name: cp-type, type: ENUM, description: Type of the connection point.
  XPath Path
    /rw-project:project/pnfd:pnfd-catalog/pnfd:pnfd/pnfd:connection-point
  XPath Keyed Path
    /rw-project:project[rw-project:name='STRING']/pnfd:pnfd-catalog/pnfd:pnfd[pnfd:id='STRING']/pnfd:connection-point[pnfd:id='0']
  RW.REST URI Path
    /rw-project:project/STRING/pnfd:pnfd-catalog/pnfd/STRING/connection-point/0
  RW Keyspec XPath Path
    C,/rw-project:project/pnfd:pnfd-catalog/pnfd:pnfd/pnfd:connection-point
  RW Keyspec XPath Keyed Path
    C,/rw-project:project[rw-project:name='STRING']/pnfd:pnfd-catalog/pnfd:pnfd[pnfd:id='STRING']/pnfd:connection-point[pnfd:id='0']
  Protobuf Type
    .pnfd.YangData.RwProject.Project.PnfdCatalog.Pnfd.ConnectionPoint
  Python Proto-GI Type
    PnfdYang.YangData_RwProject_Project_PnfdCatalog_Pnfd_ConnectionPoint
  C Protobuf-C Struct Type
    Pnfd__YangData__RwProject__Project__PnfdCatalog__Pnfd__ConnectionPoint
  C RWPB Identifiers
    Pnfd_RwProject_data_Project_PnfdCatalog_Pnfd_ConnectionPoint
  YPBC Base Identifier
    rw_ypbc_Pnfd_RwProject_data_Project_PnfdCatalog_Pnfd_ConnectionPoint

3  module pnfd

