User documentation for yang module rw-conman.yang

module rw-conman                                                             1
  rw-conman data                                                           1.1
    container rw-conman:cm-config                                        1.1.1
      container rw-conman:ro-endpoint                                  1.1.1.1
      list rw-conman:nsr                                               1.1.1.2
    container rw-conman:cm-state                                         1.1.2
      list rw-conman:cm-nsr                                            1.1.2.1
        list rw-conman:cm-vnfr                                       1.1.2.1.1
          container rw-conman:mgmt-interface                       1.1.2.1.1.1
          list rw-conman:connection-point                          1.1.2.1.1.2


1  module rw-conman

1.1  rw-conman data

1.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
  JSON Config Sample
    {
      "ro-endpoint": {
        "ro-ip-address": "127.0.0.1",
        "ro-port": 2022,
        "ro-username": "admin",
        "ro-password": "admin"
      },
      "nsr": [
        {
          "id": "STRING"
        }, {
          ...
        }
      ]
    }
  JSON Sample
    {
      "ro-endpoint": {
        "ro-ip-address": "127.0.0.1",
        "ro-port": 2022,
        "ro-username": "admin",
        "ro-password": "admin"
      },
      "nsr": [
        {
          "id": "STRING"
        }, {
          ...
        }
      ]
    }
  XML Config Sample
    <rw-conman:cm-config xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:ro-endpoint>
        <rw-conman:ro-ip-address>127.0.0.1</rw-conman:ro-ip-address>
        <rw-conman:ro-port>2022</rw-conman:ro-port>
        <rw-conman:ro-username>admin</rw-conman:ro-username>
        <rw-conman:ro-password>admin</rw-conman:ro-password>
      </rw-conman:ro-endpoint>
      <rw-conman:nsr>
        <rw-conman:id>STRING</rw-conman:id>
      </rw-conman:nsr>
    </rw-conman:cm-config>
  XML Sample
    <rw-conman:cm-config xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:ro-endpoint>
        <rw-conman:ro-ip-address>127.0.0.1</rw-conman:ro-ip-address>
        <rw-conman:ro-port>2022</rw-conman:ro-port>
        <rw-conman:ro-username>admin</rw-conman:ro-username>
        <rw-conman:ro-password>admin</rw-conman:ro-password>
      </rw-conman:ro-endpoint>
      <rw-conman:nsr>
        <rw-conman:id>STRING</rw-conman:id>
      </rw-conman:nsr>
    </rw-conman:cm-config>

1.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
  JSON Config Sample
    {
      "ro-ip-address": "127.0.0.1",
      "ro-port": 2022,
      "ro-username": "admin",
      "ro-password": "admin"
    }
  JSON Sample
    {
      "ro-ip-address": "127.0.0.1",
      "ro-port": 2022,
      "ro-username": "admin",
      "ro-password": "admin"
    }
  XML Config Sample
    <rw-conman:ro-endpoint xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:ro-ip-address>127.0.0.1</rw-conman:ro-ip-address>
      <rw-conman:ro-port>2022</rw-conman:ro-port>
      <rw-conman:ro-username>admin</rw-conman:ro-username>
      <rw-conman:ro-password>admin</rw-conman:ro-password>
    </rw-conman:ro-endpoint>
  XML Sample
    <rw-conman:ro-endpoint xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:ro-ip-address>127.0.0.1</rw-conman:ro-ip-address>
      <rw-conman:ro-port>2022</rw-conman:ro-port>
      <rw-conman:ro-username>admin</rw-conman:ro-username>
      <rw-conman:ro-password>admin</rw-conman:ro-password>
    </rw-conman:ro-endpoint>

1.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
  JSON Config Sample
    [
      {
        "id": "STRING"
      }, {
        ...
      }
    ]
  JSON Sample
    [
      {
        "id": "STRING"
      }, {
        ...
      }
    ]
  XML Config Sample
    <rw-conman:nsr xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:id>STRING</rw-conman:id>
    </rw-conman:nsr>
  XML Sample
    <rw-conman:nsr xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:id>STRING</rw-conman:id>
    </rw-conman:nsr>

1.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
  JSON Sample
    {
      "states": "STRING",
      "cm-nsr": [
        {
          "id": "STRING",
          "name": "STRING",
          "state": "init",
          "state-details": "STRING",
          "cm-vnfr": [ { ... }, { ... } ]
        }, {
          ...
        }
      ]
    }
  XML Sample
    <rw-conman:cm-state xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:states>STRING</rw-conman:states>
      <rw-conman:cm-nsr>
        <rw-conman:id>STRING</rw-conman:id>
        <rw-conman:name>STRING</rw-conman:name>
        <rw-conman:state>init</rw-conman:state>
        <rw-conman:state-details>STRING</rw-conman:state-details>
        <rw-conman:cm-vnfr>...</rw-conman:cm-vnfr>
      </rw-conman:cm-nsr>
    </rw-conman:cm-state>

1.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
  JSON Sample
    [
      {
        "id": "STRING",
        "name": "STRING",
        "state": "init",
        "state-details": "STRING",
        "cm-vnfr": [
          {
            "id": "STRING",
            "name": "STRING",
            "state": "init",
            "mgmt-interface": { ... },
            "cfg-type": "STRING",
            "cfg-location": "STRING",
            "connection-point": [ { ... }, { ... } ]
          }, {
            ...
          }
        ]
      }, {
        ...
      }
    ]
  XML Sample
    <rw-conman:cm-nsr xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:id>STRING</rw-conman:id>
      <rw-conman:name>STRING</rw-conman:name>
      <rw-conman:state>init</rw-conman:state>
      <rw-conman:state-details>STRING</rw-conman:state-details>
      <rw-conman:cm-vnfr>
        <rw-conman:id>STRING</rw-conman:id>
        <rw-conman:name>STRING</rw-conman:name>
        <rw-conman:state>init</rw-conman:state>
        <rw-conman:mgmt-interface>...</rw-conman:mgmt-interface>
        <rw-conman:cfg-type>STRING</rw-conman:cfg-type>
        <rw-conman:cfg-location>STRING</rw-conman:cfg-location>
        <rw-conman:connection-point>...</rw-conman:connection-point>
      </rw-conman:cm-vnfr>
    </rw-conman:cm-nsr>

1.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
  JSON Sample
    [
      {
        "id": "STRING",
        "name": "STRING",
        "state": "init",
        "mgmt-interface": {
          "ip-address": "UNION_VALUE",
          "port": 0
        },
        "cfg-type": "STRING",
        "cfg-location": "STRING",
        "connection-point": [
          {
            "name": "STRING",
            "ip-address": "UNION_VALUE"
          }, {
            ...
          }
        ]
      }, {
        ...
      }
    ]
  XML Sample
    <rw-conman:cm-vnfr xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:id>STRING</rw-conman:id>
      <rw-conman:name>STRING</rw-conman:name>
      <rw-conman:state>init</rw-conman:state>
      <rw-conman:mgmt-interface>
        <rw-conman:ip-address>UNION_VALUE</rw-conman:ip-address>
        <rw-conman:port>0</rw-conman:port>
      </rw-conman:mgmt-interface>
      <rw-conman:cfg-type>STRING</rw-conman:cfg-type>
      <rw-conman:cfg-location>STRING</rw-conman:cfg-location>
      <rw-conman:connection-point>
        <rw-conman:name>STRING</rw-conman:name>
        <rw-conman:ip-address>UNION_VALUE</rw-conman:ip-address>
      </rw-conman:connection-point>
    </rw-conman:cm-vnfr>

1.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
  JSON Sample
    {
      "ip-address": "UNION_VALUE",
      "port": 0
    }
  XML Sample
    <rw-conman:mgmt-interface xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:ip-address>UNION_VALUE</rw-conman:ip-address>
      <rw-conman:port>0</rw-conman:port>
    </rw-conman:mgmt-interface>

1.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
  JSON Sample
    [
      {
        "name": "STRING",
        "ip-address": "UNION_VALUE"
      }, {
        ...
      }
    ]
  XML Sample
    <rw-conman:connection-point xmlns:rw-conman="http://riftio.com/ns/riftware-1.0/rw-conman">
      <rw-conman:name>STRING</rw-conman:name>
      <rw-conman:ip-address>UNION_VALUE</rw-conman:ip-address>
    </rw-conman:connection-point>

