User documentation for yang module lpmocklet.yang

module lpmocklet                                                             1
  lpmocklet data                                                           1.1
    container lpmocklet:lpmocklet-action-status                          1.1.1
  lpmocklet rpc input                                                      1.2
    rpc input lpmocklet:set-control-param                                1.2.1
    rpc input lpmocklet:start-vnfr                                       1.2.2
    rpc input lpmocklet:stop-vnfr                                        1.2.3
  lpmocklet rpc output                                                     1.3
    rpc output lpmocklet:set-control-param                               1.3.1
    rpc output lpmocklet:start-vnfr                                      1.3.2
    rpc output lpmocklet:stop-vnfr                                       1.3.3


1  module lpmocklet

1.1  lpmocklet data

1.1.1  container lpmocklet:lpmocklet-action-status
  Leaves
    name: id, type: STRING
    name: object_type, type: STRING
    name: action, type: STRING
    name: status, type: STRING
  XPath Path
    /lpmocklet:lpmocklet-action-status
  XPath Keyed Path
    /lpmocklet:lpmocklet-action-status
  RW.REST URI Path
    /lpmocklet:lpmocklet-action-status
  JSON Sample
    {
      "id": "STRING",
      "object_type": "STRING",
      "action": "STRING",
      "status": "STRING"
    }
  XML Sample
    <lpmocklet:lpmocklet-action-status xmlns:lpmocklet="http://riftio.com/ns/riftware-1.0/lpmocklet">
      <lpmocklet:id>STRING</lpmocklet:id>
      <lpmocklet:object_type>STRING</lpmocklet:object_type>
      <lpmocklet:action>STRING</lpmocklet:action>
      <lpmocklet:status>STRING</lpmocklet:status>
    </lpmocklet:lpmocklet-action-status>

1.2  lpmocklet rpc input

1.2.1  rpc input lpmocklet:set-control-param
  Leaves
    name: id, type: STRING, description: object id
    name: obj-code, type: STRING, description: Type of object: NS, VNF
    name: control-id, type: STRING
    name: value, type: UINT64
  XPath Path
    /lpmocklet:set-control-param
  XPath Keyed Path
    /lpmocklet:set-control-param
  RW.REST URI Path
    /input
  JSON Sample
    {
      "id": "STRING",
      "obj-code": "STRING",
      "control-id": "STRING",
      "value": 0
    }
  XML Sample
    <lpmocklet:input xmlns:lpmocklet="http://riftio.com/ns/riftware-1.0/lpmocklet">
      <lpmocklet:id>STRING</lpmocklet:id>
      <lpmocklet:obj-code>STRING</lpmocklet:obj-code>
      <lpmocklet:control-id>STRING</lpmocklet:control-id>
      <lpmocklet:value>0</lpmocklet:value>
    </lpmocklet:input>

1.2.2  rpc input lpmocklet:start-vnfr
  Leaves
    name: id, type: STRING
  XPath Path
    /lpmocklet:start-vnfr
  XPath Keyed Path
    /lpmocklet:start-vnfr
  RW.REST URI Path
    /input
  JSON Sample
    {
      "id": "STRING"
    }
  XML Sample
    <lpmocklet:input xmlns:lpmocklet="http://riftio.com/ns/riftware-1.0/lpmocklet">
      <lpmocklet:id>STRING</lpmocklet:id>
    </lpmocklet:input>

1.2.3  rpc input lpmocklet:stop-vnfr
  Leaves
    name: id, type: STRING
  XPath Path
    /lpmocklet:stop-vnfr
  XPath Keyed Path
    /lpmocklet:stop-vnfr
  RW.REST URI Path
    /input
  JSON Sample
    {
      "id": "STRING"
    }
  XML Sample
    <lpmocklet:input xmlns:lpmocklet="http://riftio.com/ns/riftware-1.0/lpmocklet">
      <lpmocklet:id>STRING</lpmocklet:id>
    </lpmocklet:input>

1.3  lpmocklet rpc output

1.3.1  rpc output lpmocklet:set-control-param
  XPath Path
    /lpmocklet:set-control-param
  XPath Keyed Path
    /lpmocklet:set-control-param
  RW.REST URI Path
    /output
  JSON Sample
    {
    }
  XML Sample
    <lpmocklet:output xmlns:lpmocklet="http://riftio.com/ns/riftware-1.0/lpmocklet"/>

1.3.2  rpc output lpmocklet:start-vnfr
  Leaves
    name: status, type: STRING, description: status of the start request
  XPath Path
    /lpmocklet:start-vnfr
  XPath Keyed Path
    /lpmocklet:start-vnfr
  RW.REST URI Path
    /output
  JSON Sample
    {
      "status": "STRING"
    }
  XML Sample
    <lpmocklet:output xmlns:lpmocklet="http://riftio.com/ns/riftware-1.0/lpmocklet">
      <lpmocklet:status>STRING</lpmocklet:status>
    </lpmocklet:output>

1.3.3  rpc output lpmocklet:stop-vnfr
  XPath Path
    /lpmocklet:stop-vnfr
  XPath Keyed Path
    /lpmocklet:stop-vnfr
  RW.REST URI Path
    /output
  JSON Sample
    {
    }
  XML Sample
    <lpmocklet:output xmlns:lpmocklet="http://riftio.com/ns/riftware-1.0/lpmocklet"/>

