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



Schema Globals                                                               1

module rw-conman                                                             2
  rw-conman data                                                           2.1
    container rw-conman:cm-config                                        2.1.1
      container rw-conman:ro-endpoint                                  2.1.1.1
      list rw-conman:nsr                                               2.1.1.2
    container rw-conman:cm-state                                         2.1.2
      list rw-conman:cm-nsr                                            2.1.2.1
        list rw-conman:cm-vnfr                                       2.1.2.1.1
          container rw-conman:mgmt-interface                       2.1.2.1.1.1
          list rw-conman:connection-point                          2.1.2.1.1.2


1  Schema Globals
  Global Schema Type
    rw_ypbc_RwConman_t_schema
  Global Schema Pointer
    rw_ypbc_RwConman_g_schema
2  module rw-conman

2.1  rw-conman data

2.1.1  container rw-conman:cm-config
  Description
    Service Orchestrator specific configuration
  XPath Path
    /rw-conman:cm-config
  XPath Keyed Path
    /rw-conman:cm-config
  RW.REST URI Path
    /rw-conman:cm-config
  RW Keyspec XPath Path
    C,/rw-conman:cm-config
  RW Keyspec XPath Keyed Path
    C,/rw-conman:cm-config
  Protobuf Type
    .rw_conman.YangData.RwConman.CmConfig
  Python Proto-GI Type
    RwConmanYang.SoConfig
  C Protobuf-C Struct Type
    RwConman__YangData__RwConman__CmConfig
  C RWPB Identifiers
    RwConman_RwConman_data_CmConfig
    RwConman_data_CmConfig
    RwConman_SoConfig
  YPBC Base Identifier
    rw_ypbc_RwConman_RwConman_data_CmConfig

2.1.1.1  container rw-conman:ro-endpoint
  Description
    Resource Orchestrator endpoint ip address
  Leaves
    name: ro-ip-address, type: UNION, description: IP Address
    name: ro-port, type: UINT16, description: Port Number
    name: ro-username, type: STRING, description: RO endpoint username
    name: ro-password, type: STRING, description: RO endpoint password
  XPath Path
    /rw-conman:cm-config/rw-conman:ro-endpoint
  XPath Keyed Path
    /rw-conman:cm-config/rw-conman:ro-endpoint
  RW.REST URI Path
    /rw-conman:cm-config/ro-endpoint
  RW Keyspec XPath Path
    C,/rw-conman:cm-config/rw-conman:ro-endpoint
  RW Keyspec XPath Keyed Path
    C,/rw-conman:cm-config/rw-conman:ro-endpoint
  Protobuf Type
    .rw_conman.YangData.RwConman.CmConfig.RoEndpoint
  Python Proto-GI Type
    RwConmanYang.RoEndpoint
  C Protobuf-C Struct Type
    RwConman__YangData__RwConman__CmConfig__RoEndpoint
  C RWPB Identifiers
    RwConman_RwConman_data_CmConfig_RoEndpoint
    RwConman_data_CmConfig_RoEndpoint
    RwConman_RoEndpoint
  YPBC Base Identifier
    rw_ypbc_RwConman_RwConman_data_CmConfig_RoEndpoint

2.1.1.2  list rw-conman:nsr
  Leaves
    name: id, type: STRING, description: Indicates NSR bringup complete, now initiate configuration of the NSR
  XPath Path
    /rw-conman:cm-config/rw-conman:nsr
  XPath Keyed Path
    /rw-conman:cm-config/rw-conman:nsr[rw-conman:id='STRING']
  RW.REST URI Path
    /rw-conman:cm-config/nsr/STRING
  RW Keyspec XPath Path
    C,/rw-conman:cm-config/rw-conman:nsr
  RW Keyspec XPath Keyed Path
    C,/rw-conman:cm-config/rw-conman:nsr[rw-conman:id='STRING']
  Protobuf Type
    .rw_conman.YangData.RwConman.CmConfig.Nsr
  Python Proto-GI Type
    RwConmanYang.SoConfig_Nsr
  C Protobuf-C Struct Type
    RwConman__YangData__RwConman__CmConfig__Nsr
  C RWPB Identifiers
    RwConman_RwConman_data_CmConfig_Nsr
    RwConman_data_CmConfig_Nsr
    RwConman_SoConfig_Nsr
  YPBC Base Identifier
    rw_ypbc_RwConman_RwConman_data_CmConfig_Nsr

2.1.2  container rw-conman:cm-state
  Description
    CM NS & VNF states
  Leaves
    name: states, type: STRING, description: CM various states
  XPath Path
    /rw-conman:cm-state
  XPath Keyed Path
    /rw-conman:cm-state
  RW.REST URI Path
    /rw-conman:cm-state
  RW Keyspec XPath Path
    D,/rw-conman:cm-state
  RW Keyspec XPath Keyed Path
    D,/rw-conman:cm-state
  Protobuf Type
    .rw_conman.YangData.RwConman.CmState
  Python Proto-GI Type
    RwConmanYang.CmOpdata
  C Protobuf-C Struct Type
    RwConman__YangData__RwConman__CmState
  C RWPB Identifiers
    RwConman_RwConman_data_CmState
    RwConman_data_CmState
    RwConman_CmOpdata
  YPBC Base Identifier
    rw_ypbc_RwConman_RwConman_data_CmState

2.1.2.1  list rw-conman:cm-nsr
  Description
    List of NS Records
  Leaves
    name: id, type: STRING
    name: name, type: STRING, description: NSR name.
    name: state, type: ENUM, description: State of NSR
    name: state-details, type: STRING, description: Details of the state of NSR, in case of errors
  XPath Path
    /rw-conman:cm-state/rw-conman:cm-nsr
  XPath Keyed Path
    /rw-conman:cm-state/rw-conman:cm-nsr[rw-conman:id='STRING']
  RW.REST URI Path
    /rw-conman:cm-state/cm-nsr/STRING
  RW Keyspec XPath Path
    D,/rw-conman:cm-state/rw-conman:cm-nsr
  RW Keyspec XPath Keyed Path
    D,/rw-conman:cm-state/rw-conman:cm-nsr[rw-conman:id='STRING']
  Protobuf Type
    .rw_conman.YangData.RwConman.CmState.CmNsr
  Python Proto-GI Type
    RwConmanYang.CmOpdata_CmNsr
  C Protobuf-C Struct Type
    RwConman__YangData__RwConman__CmState__CmNsr
  C RWPB Identifiers
    RwConman_RwConman_data_CmState_CmNsr
    RwConman_data_CmState_CmNsr
    RwConman_CmOpdata_CmNsr
  YPBC Base Identifier
    rw_ypbc_RwConman_RwConman_data_CmState_CmNsr

2.1.2.1.1  list rw-conman:cm-vnfr
  Description
    List of VNF Records within NS Record
  Leaves
    name: id, type: STRING
    name: name, type: STRING, description: VNFR name.
    name: state, type: ENUM, description: Last known state of this VNFR
    name: cfg-type, type: STRING
    name: cfg-location, type: STRING
  XPath Path
    /rw-conman:cm-state/rw-conman:cm-nsr/rw-conman:cm-vnfr
  XPath Keyed Path
    /rw-conman:cm-state/rw-conman:cm-nsr[rw-conman:id='STRING']/rw-conman:cm-vnfr[rw-conman:id='STRING']
  RW.REST URI Path
    /rw-conman:cm-state/cm-nsr/STRING/cm-vnfr/STRING
  RW Keyspec XPath Path
    D,/rw-conman:cm-state/rw-conman:cm-nsr/rw-conman:cm-vnfr
  RW Keyspec XPath Keyed Path
    D,/rw-conman:cm-state/rw-conman:cm-nsr[rw-conman:id='STRING']/rw-conman:cm-vnfr[rw-conman:id='STRING']
  Protobuf Type
    .rw_conman.YangData.RwConman.CmState.CmNsr.CmVnfr
  Python Proto-GI Type
    RwConmanYang.CmOpdata_CmNsr_CmVnfr
  C Protobuf-C Struct Type
    RwConman__YangData__RwConman__CmState__CmNsr__CmVnfr
  C RWPB Identifiers
    RwConman_RwConman_data_CmState_CmNsr_CmVnfr
    RwConman_data_CmState_CmNsr_CmVnfr
    RwConman_CmOpdata_CmNsr_CmVnfr
  YPBC Base Identifier
    rw_ypbc_RwConman_RwConman_data_CmState_CmNsr_CmVnfr

2.1.2.1.1.1  container rw-conman:mgmt-interface
  Leaves
    name: ip-address, type: UNION
    name: port, type: UINT16
  XPath Path
    /rw-conman:cm-state/rw-conman:cm-nsr/rw-conman:cm-vnfr/rw-conman:mgmt-interface
  XPath Keyed Path
    /rw-conman:cm-state/rw-conman:cm-nsr[rw-conman:id='STRING']/rw-conman:cm-vnfr[rw-conman:id='STRING']/rw-conman:mgmt-interface
  RW.REST URI Path
    /rw-conman:cm-state/cm-nsr/STRING/cm-vnfr/STRING/mgmt-interface
  RW Keyspec XPath Path
    D,/rw-conman:cm-state/rw-conman:cm-nsr/rw-conman:cm-vnfr/rw-conman:mgmt-interface
  RW Keyspec XPath Keyed Path
    D,/rw-conman:cm-state/rw-conman:cm-nsr[rw-conman:id='STRING']/rw-conman:cm-vnfr[rw-conman:id='STRING']/rw-conman:mgmt-interface
  Protobuf Type
    .rw_conman.YangData.RwConman.CmState.CmNsr.CmVnfr.MgmtInterface
  Python Proto-GI Type
    RwConmanYang.CmOpdata_CmNsr_CmVnfr_MgmtInterface
  C Protobuf-C Struct Type
    RwConman__YangData__RwConman__CmState__CmNsr__CmVnfr__MgmtInterface
  C RWPB Identifiers
    RwConman_RwConman_data_CmState_CmNsr_CmVnfr_MgmtInterface
    RwConman_data_CmState_CmNsr_CmVnfr_MgmtInterface
    RwConman_CmOpdata_CmNsr_CmVnfr_MgmtInterface
  YPBC Base Identifier
    rw_ypbc_RwConman_RwConman_data_CmState_CmNsr_CmVnfr_MgmtInterface

2.1.2.1.1.2  list rw-conman:connection-point
  Leaves
    name: name, type: STRING, description: Connection Point name
    name: ip-address, type: UNION, description: IP address assigned to this connection point
  XPath Path
    /rw-conman:cm-state/rw-conman:cm-nsr/rw-conman:cm-vnfr/rw-conman:connection-point
  XPath Keyed Path
    /rw-conman:cm-state/rw-conman:cm-nsr[rw-conman:id='STRING']/rw-conman:cm-vnfr[rw-conman:id='STRING']/rw-conman:connection-point[rw-conman:name='STRING']
  RW.REST URI Path
    /rw-conman:cm-state/cm-nsr/STRING/cm-vnfr/STRING/connection-point/STRING
  RW Keyspec XPath Path
    D,/rw-conman:cm-state/rw-conman:cm-nsr/rw-conman:cm-vnfr/rw-conman:connection-point
  RW Keyspec XPath Keyed Path
    D,/rw-conman:cm-state/rw-conman:cm-nsr[rw-conman:id='STRING']/rw-conman:cm-vnfr[rw-conman:id='STRING']/rw-conman:connection-point[rw-conman:name='STRING']
  Protobuf Type
    .rw_conman.YangData.RwConman.CmState.CmNsr.CmVnfr.ConnectionPoint
  Python Proto-GI Type
    RwConmanYang.CmOpdata_CmNsr_CmVnfr_ConnectionPoint
  C Protobuf-C Struct Type
    RwConman__YangData__RwConman__CmState__CmNsr__CmVnfr__ConnectionPoint
  C RWPB Identifiers
    RwConman_RwConman_data_CmState_CmNsr_CmVnfr_ConnectionPoint
    RwConman_data_CmState_CmNsr_CmVnfr_ConnectionPoint
    RwConman_CmOpdata_CmNsr_CmVnfr_ConnectionPoint
  YPBC Base Identifier
    rw_ypbc_RwConman_RwConman_data_CmState_CmNsr_CmVnfr_ConnectionPoint

