User documentation for yang module pnfd.yang

module pnfd                                                                  1
  pnfd data                                                                1.1
    container pnfd:pnfd-catalog                                          1.1.1
      list pnfd:pnfd                                                   1.1.1.1
        list pnfd:connection-point                                   1.1.1.1.1


1  module pnfd

1.1  pnfd data

1.1.1  container pnfd:pnfd-catalog
  XPath Path
    /pnfd:pnfd-catalog
  XPath Keyed Path
    /pnfd:pnfd-catalog
  RW.REST URI Path
    /pnfd:pnfd-catalog
  JSON Config Sample
    {
      "pnfd": [
        {
          "id": "STRING",
          "name": "STRING",
          "short-name": "STRING",
          "vendor": "STRING",
          "description": "STRING",
          "version": "STRING",
          "connection-point": [ { ... }, { ... } ]
        }, {
          ...
        }
      ]
    }
  JSON Sample
    {
      "pnfd": [
        {
          "id": "STRING",
          "name": "STRING",
          "short-name": "STRING",
          "vendor": "STRING",
          "description": "STRING",
          "version": "STRING",
          "connection-point": [ { ... }, { ... } ]
        }, {
          ...
        }
      ]
    }
  XML Config Sample
    <pnfd:pnfd-catalog xmlns:pnfd="urn:ietf:params:xml:ns:yang:nfvo:pnfd">
      <pnfd:pnfd>
        <pnfd:id>STRING</pnfd:id>
        <pnfd:name>STRING</pnfd:name>
        <pnfd:short-name>STRING</pnfd:short-name>
        <pnfd:vendor>STRING</pnfd:vendor>
        <pnfd:description>STRING</pnfd:description>
        <pnfd:version>STRING</pnfd:version>
        <pnfd:connection-point>...</pnfd:connection-point>
      </pnfd:pnfd>
    </pnfd:pnfd-catalog>
  XML Sample
    <pnfd:pnfd-catalog xmlns:pnfd="urn:ietf:params:xml:ns:yang:nfvo:pnfd">
      <pnfd:pnfd>
        <pnfd:id>STRING</pnfd:id>
        <pnfd:name>STRING</pnfd:name>
        <pnfd:short-name>STRING</pnfd:short-name>
        <pnfd:vendor>STRING</pnfd:vendor>
        <pnfd:description>STRING</pnfd:description>
        <pnfd:version>STRING</pnfd:version>
        <pnfd:connection-point>...</pnfd:connection-point>
      </pnfd:pnfd>
    </pnfd:pnfd-catalog>

1.1.1.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
    /pnfd:pnfd-catalog/pnfd:pnfd
  XPath Keyed Path
    /pnfd:pnfd-catalog/pnfd:pnfd[pnfd:id='STRING']
  RW.REST URI Path
    /pnfd:pnfd-catalog/pnfd/STRING
  JSON Config Sample
    [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "connection-point": [
          {
            "id": 0,
            "cp-type": "VPORT"
          }, {
            ...
          }
        ]
      }, {
        ...
      }
    ]
  JSON Sample
    [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "connection-point": [
          {
            "id": 0,
            "cp-type": "VPORT"
          }, {
            ...
          }
        ]
      }, {
        ...
      }
    ]
  XML Config Sample
    <pnfd:pnfd xmlns:pnfd="urn:ietf:params:xml:ns:yang:nfvo:pnfd">
      <pnfd:id>STRING</pnfd:id>
      <pnfd:name>STRING</pnfd:name>
      <pnfd:short-name>STRING</pnfd:short-name>
      <pnfd:vendor>STRING</pnfd:vendor>
      <pnfd:description>STRING</pnfd:description>
      <pnfd:version>STRING</pnfd:version>
      <pnfd:connection-point>
        <pnfd:id>0</pnfd:id>
        <pnfd:cp-type>VPORT</pnfd:cp-type>
      </pnfd:connection-point>
    </pnfd:pnfd>
  XML Sample
    <pnfd:pnfd xmlns:pnfd="urn:ietf:params:xml:ns:yang:nfvo:pnfd">
      <pnfd:id>STRING</pnfd:id>
      <pnfd:name>STRING</pnfd:name>
      <pnfd:short-name>STRING</pnfd:short-name>
      <pnfd:vendor>STRING</pnfd:vendor>
      <pnfd:description>STRING</pnfd:description>
      <pnfd:version>STRING</pnfd:version>
      <pnfd:connection-point>
        <pnfd:id>0</pnfd:id>
        <pnfd:cp-type>VPORT</pnfd:cp-type>
      </pnfd:connection-point>
    </pnfd:pnfd>

1.1.1.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
    /pnfd:pnfd-catalog/pnfd:pnfd/pnfd:connection-point
  XPath Keyed Path
    /pnfd:pnfd-catalog/pnfd:pnfd[pnfd:id='STRING']/pnfd:connection-point[pnfd:id='0']
  RW.REST URI Path
    /pnfd:pnfd-catalog/pnfd/STRING/connection-point/0
  JSON Config Sample
    [
      {
        "id": 0,
        "cp-type": "VPORT"
      }, {
        ...
      }
    ]
  JSON Sample
    [
      {
        "id": 0,
        "cp-type": "VPORT"
      }, {
        ...
      }
    ]
  XML Config Sample
    <pnfd:connection-point xmlns:pnfd="urn:ietf:params:xml:ns:yang:nfvo:pnfd">
      <pnfd:id>0</pnfd:id>
      <pnfd:cp-type>VPORT</pnfd:cp-type>
    </pnfd:connection-point>
  XML Sample
    <pnfd:connection-point xmlns:pnfd="urn:ietf:params:xml:ns:yang:nfvo:pnfd">
      <pnfd:id>0</pnfd:id>
      <pnfd:cp-type>VPORT</pnfd:cp-type>
    </pnfd:connection-point>

