rw-conman - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwConman_RwConman_t_schema
Global Schema Pointer	rw_ypbc_RwConman_RwConman_g_schema

rw-conman data

rw-conman:cm-config

Service Orchestrator specific configuration

Key Identifiers:

XPath Path	/rw-conman:cm-config
XPath Keyed Path	/rw-conman:cm-config
RW.REST URI Path	/rw-conman:cm-config

Fields

Name	Type	Description
ro-endpoint	CONTAINER	Resource Orchestrator endpoint ip address
nsr	LIST

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>

rw-conman:ro-endpoint

Resource Orchestrator endpoint ip address

Key Identifiers:

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

Fields

Name	Type	Description
ro-ip-address	UNION	IP Address
ro-port	UINT16	Port Number
ro-username	STRING	RO endpoint username
ro-password	STRING	RO endpoint password

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>

rw-conman:nsr

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING	Indicates NSR bringup complete, now initiate configuration of the NSR

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>

rw-conman:cm-state

CM NS & VNF states

Key Identifiers:

XPath Path	/rw-conman:cm-state
XPath Keyed Path	/rw-conman:cm-state
RW.REST URI Path	/rw-conman:cm-state

Fields

Name	Type	Description
states	STRING	CM various states
cm-nsr	LIST	List of NS Records

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>

rw-conman:cm-nsr

List of NS Records

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING
name	STRING	NSR name.
state	ENUM	State of NSR
state-details	STRING	Details of the state of NSR, in case of errors
cm-vnfr	LIST	List of VNF Records within NS Record

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>

rw-conman:cm-vnfr

List of VNF Records within NS Record

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING
name	STRING	VNFR name.
state	ENUM	Last known state of this VNFR
mgmt-interface	CONTAINER
cfg-type	STRING
cfg-location	STRING
connection-point	LIST

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>

rw-conman:mgmt-interface

Key Identifiers:

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

Fields

Name	Type	Description
ip-address	UNION
port	UINT16

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>

rw-conman:connection-point

Key Identifiers:

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

Fields

Name	Type	Description
name	STRING	Connection Point name
ip-address	UNION	IP address assigned to this connection point

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>