nsd - User documentation

Schema Globals

Global Schema Type	rw_ypbc_Nsd_Nsd_t_schema
Global Schema Pointer	rw_ypbc_Nsd_Nsd_g_schema

nsd data

nsd:nsd-catalog

Key Identifiers:

XPath Path	/nsd:nsd-catalog
XPath Keyed Path	/nsd:nsd-catalog
RW.REST URI Path	/nsd:nsd-catalog

Fields

Name	Type	Description
nsd	LIST

JSON Config Sample

{
  "nsd": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "connection-point": [ { ... }, { ... } ],
      "scaling-group-descriptor": [ { ... }, { ... } ],
      "vnffgd": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "initial-service-primitive": [ { ... }, { ... } ],
      "terminate-service-primitive": [ { ... }, { ... } ],
      "input-parameter-xpath": [ { ... }, { ... } ],
      "parameter-pool": [ { ... }, { ... } ],
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ],
      "vld": [ { ... }, { ... } ],
      "constituent-vnfd": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ],
      "vnf-dependency": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "service-primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "nsd": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "connection-point": [ { ... }, { ... } ],
      "scaling-group-descriptor": [ { ... }, { ... } ],
      "vnffgd": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "initial-service-primitive": [ { ... }, { ... } ],
      "terminate-service-primitive": [ { ... }, { ... } ],
      "input-parameter-xpath": [ { ... }, { ... } ],
      "parameter-pool": [ { ... }, { ... } ],
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ],
      "vld": [ { ... }, { ... } ],
      "constituent-vnfd": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ],
      "vnf-dependency": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "service-primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<nsd:nsd-catalog xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:nsd>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:short-name>STRING</nsd:short-name>
    <nsd:vendor>STRING</nsd:vendor>
    <nsd:logo>STRING</nsd:logo>
    <nsd:description>STRING</nsd:description>
    <nsd:version>STRING</nsd:version>
    <nsd:connection-point>...</nsd:connection-point>
    <nsd:scaling-group-descriptor>...</nsd:scaling-group-descriptor>
    <nsd:vnffgd>...</nsd:vnffgd>
    <nsd:ip-profiles>...</nsd:ip-profiles>
    <nsd:initial-service-primitive>...</nsd:initial-service-primitive>
    <nsd:terminate-service-primitive>...</nsd:terminate-service-primitive>
    <nsd:input-parameter-xpath>...</nsd:input-parameter-xpath>
    <nsd:parameter-pool>...</nsd:parameter-pool>
    <nsd:key-pair>...</nsd:key-pair>
    <nsd:user>...</nsd:user>
    <nsd:vld>...</nsd:vld>
    <nsd:constituent-vnfd>...</nsd:constituent-vnfd>
    <nsd:placement-groups>...</nsd:placement-groups>
    <nsd:vnf-dependency>...</nsd:vnf-dependency>
    <nsd:monitoring-param>...</nsd:monitoring-param>
    <nsd:service-primitive>...</nsd:service-primitive>
  </nsd:nsd>
</nsd:nsd-catalog>

XML Sample

<nsd:nsd-catalog xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:nsd>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:short-name>STRING</nsd:short-name>
    <nsd:vendor>STRING</nsd:vendor>
    <nsd:logo>STRING</nsd:logo>
    <nsd:description>STRING</nsd:description>
    <nsd:version>STRING</nsd:version>
    <nsd:connection-point>...</nsd:connection-point>
    <nsd:scaling-group-descriptor>...</nsd:scaling-group-descriptor>
    <nsd:vnffgd>...</nsd:vnffgd>
    <nsd:ip-profiles>...</nsd:ip-profiles>
    <nsd:initial-service-primitive>...</nsd:initial-service-primitive>
    <nsd:terminate-service-primitive>...</nsd:terminate-service-primitive>
    <nsd:input-parameter-xpath>...</nsd:input-parameter-xpath>
    <nsd:parameter-pool>...</nsd:parameter-pool>
    <nsd:key-pair>...</nsd:key-pair>
    <nsd:user>...</nsd:user>
    <nsd:vld>...</nsd:vld>
    <nsd:constituent-vnfd>...</nsd:constituent-vnfd>
    <nsd:placement-groups>...</nsd:placement-groups>
    <nsd:vnf-dependency>...</nsd:vnf-dependency>
    <nsd:monitoring-param>...</nsd:monitoring-param>
    <nsd:service-primitive>...</nsd:service-primitive>
  </nsd:nsd>
</nsd:nsd-catalog>

nsd:nsd

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the NSD.
name	STRING	NSD name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Vendor of the NSD.
logo	STRING	File path for the vendor specific logo. For example icons/mylogo.png. The logo should be part of the network service
description	STRING	Description of the NSD.
version	STRING	Version of the NSD
connection-point	LIST	List for external connection points. Each NS has one or more external connection points. As the name implies that external connection points are used for connecting the NS to other NS or to external networks. Each NS exposes these connection points to the orchestrator. The orchestrator can construct network service chains by connecting the connection points between different NS.
scaling-group-descriptor	LIST	scaling group descriptor within this network service. The scaling group defines a group of VNFs, and the ratio of VNFs in the network service that is used as target for scaling action
vnffgd	LIST	List of VNF Forwarding Graph Descriptors (VNFFGD).
ip-profiles	LIST	List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
initial-service-primitive	LIST	Initial set of service primitives for NSD.
terminate-service-primitive	LIST	Set of service primitives during termination for NSD.
input-parameter-xpath	LIST	List of xpaths to parameters inside the NSD the can be customized during the instantiation.
parameter-pool	LIST	Pool of parameter values which must be pulled from during configuration
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation
user	LIST	List of users to be added through cloud-config
vld	LIST
constituent-vnfd	LIST	List of VNFDs that are part of this network service.
placement-groups	LIST	List of placement groups at NS level
vnf-dependency	LIST	List of VNF dependencies.
monitoring-param	LIST
service-primitive	LIST	Network service level service primitives.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "logo": "STRING",
    "description": "STRING",
    "version": "STRING",
    "connection-point": [
      {
        "name": "STRING",
        "type": "VPORT"
      }, {
        ...
      }
    ],
    "scaling-group-descriptor": [
      {
        "name": "STRING",
        "scaling-policy": [ { ... }, { ... } ],
        "vnfd-member": [ { ... }, { ... } ],
        "min-instance-count": 0,
        "max-instance-count": 10,
        "scaling-config-action": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnffgd": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "rsp": [ { ... }, { ... } ],
        "classifier": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "ip-profiles": [
      {
        "name": "STRING",
        "description": "STRING",
        "ip-profile-params": { ... }
      }, {
        ...
      }
    ],
    "initial-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "terminate-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "input-parameter-xpath": [
      {
        "xpath": "STRING",
        "label": "STRING",
        "default-value": "STRING"
      }, {
        ...
      }
    ],
    "parameter-pool": [
      {
        "name": "STRING",
        "range": { ... }
      }, {
        ...
      }
    ],
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "key-pair": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vld": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "type": "ELAN",
        "root-bandwidth": 0,
        "leaf-bandwidth": 0,
        "provider-network": { ... },
        "mgmt-network": false,
        "vim-network-name": "STRING",
        "ip-profile-ref": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "constituent-vnfd": [
      {
        "member-vnf-index": 0,
        "vnfd-id-ref": "STRING",
        "start-by-default": true
      }, {
        ...
      }
    ],
    "placement-groups": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "member-vnfd": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnf-dependency": [
      {
        "vnf-source-ref": "STRING",
        "vnf-depends-on-ref": "STRING"
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING",
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "COUNTER",
        "units": "STRING",
        "aggregation-type": "AVERAGE",
        "vnfd-monitoring-param": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "service-primitive": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "parameter-group": [ { ... }, { ... } ],
        "vnf-primitive-group": [ { ... }, { ... } ],
        "user-defined-script": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "logo": "STRING",
    "description": "STRING",
    "version": "STRING",
    "connection-point": [
      {
        "name": "STRING",
        "type": "VPORT"
      }, {
        ...
      }
    ],
    "scaling-group-descriptor": [
      {
        "name": "STRING",
        "scaling-policy": [ { ... }, { ... } ],
        "vnfd-member": [ { ... }, { ... } ],
        "min-instance-count": 0,
        "max-instance-count": 10,
        "scaling-config-action": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnffgd": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "rsp": [ { ... }, { ... } ],
        "classifier": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "ip-profiles": [
      {
        "name": "STRING",
        "description": "STRING",
        "ip-profile-params": { ... }
      }, {
        ...
      }
    ],
    "initial-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "terminate-service-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "input-parameter-xpath": [
      {
        "xpath": "STRING",
        "label": "STRING",
        "default-value": "STRING"
      }, {
        ...
      }
    ],
    "parameter-pool": [
      {
        "name": "STRING",
        "range": { ... }
      }, {
        ...
      }
    ],
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "key-pair": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vld": [
      {
        "id": "STRING",
        "name": "STRING",
        "short-name": "STRING",
        "vendor": "STRING",
        "description": "STRING",
        "version": "STRING",
        "type": "ELAN",
        "root-bandwidth": 0,
        "leaf-bandwidth": 0,
        "provider-network": { ... },
        "mgmt-network": false,
        "vim-network-name": "STRING",
        "ip-profile-ref": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "constituent-vnfd": [
      {
        "member-vnf-index": 0,
        "vnfd-id-ref": "STRING",
        "start-by-default": true
      }, {
        ...
      }
    ],
    "placement-groups": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "member-vnfd": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnf-dependency": [
      {
        "vnf-source-ref": "STRING",
        "vnf-depends-on-ref": "STRING"
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING",
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "COUNTER",
        "units": "STRING",
        "aggregation-type": "AVERAGE",
        "vnfd-monitoring-param": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "service-primitive": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "parameter-group": [ { ... }, { ... } ],
        "vnf-primitive-group": [ { ... }, { ... } ],
        "user-defined-script": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:nsd xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:short-name>STRING</nsd:short-name>
  <nsd:vendor>STRING</nsd:vendor>
  <nsd:logo>STRING</nsd:logo>
  <nsd:description>STRING</nsd:description>
  <nsd:version>STRING</nsd:version>
  <nsd:connection-point>
    <nsd:name>STRING</nsd:name>
    <nsd:type>VPORT</nsd:type>
  </nsd:connection-point>
  <nsd:scaling-group-descriptor>
    <nsd:name>STRING</nsd:name>
    <nsd:scaling-policy>...</nsd:scaling-policy>
    <nsd:vnfd-member>...</nsd:vnfd-member>
    <nsd:min-instance-count>0</nsd:min-instance-count>
    <nsd:max-instance-count>10</nsd:max-instance-count>
    <nsd:scaling-config-action>...</nsd:scaling-config-action>
  </nsd:scaling-group-descriptor>
  <nsd:vnffgd>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:short-name>STRING</nsd:short-name>
    <nsd:vendor>STRING</nsd:vendor>
    <nsd:description>STRING</nsd:description>
    <nsd:version>STRING</nsd:version>
    <nsd:rsp>...</nsd:rsp>
    <nsd:classifier>...</nsd:classifier>
  </nsd:vnffgd>
  <nsd:ip-profiles>
    <nsd:name>STRING</nsd:name>
    <nsd:description>STRING</nsd:description>
    <nsd:ip-profile-params>...</nsd:ip-profile-params>
  </nsd:ip-profiles>
  <nsd:initial-service-primitive>
    <nsd:seq>0</nsd:seq>
    <nsd:name>STRING</nsd:name>
    <nsd:user-defined-script>STRING</nsd:user-defined-script>
    <nsd:parameter>...</nsd:parameter>
  </nsd:initial-service-primitive>
  <nsd:terminate-service-primitive>
    <nsd:seq>0</nsd:seq>
    <nsd:name>STRING</nsd:name>
    <nsd:user-defined-script>STRING</nsd:user-defined-script>
    <nsd:parameter>...</nsd:parameter>
  </nsd:terminate-service-primitive>
  <nsd:input-parameter-xpath>
    <nsd:xpath>STRING</nsd:xpath>
    <nsd:label>STRING</nsd:label>
    <nsd:default-value>STRING</nsd:default-value>
  </nsd:input-parameter-xpath>
  <nsd:parameter-pool>
    <nsd:name>STRING</nsd:name>
    <nsd:range>...</nsd:range>
  </nsd:parameter-pool>
  <nsd:key-pair>
    <nsd:name>STRING</nsd:name>
    <nsd:key>STRING</nsd:key>
  </nsd:key-pair>
  <nsd:user>
    <nsd:name>STRING</nsd:name>
    <nsd:user-info>STRING</nsd:user-info>
    <nsd:key-pair>...</nsd:key-pair>
  </nsd:user>
  <nsd:vld>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:short-name>STRING</nsd:short-name>
    <nsd:vendor>STRING</nsd:vendor>
    <nsd:description>STRING</nsd:description>
    <nsd:version>STRING</nsd:version>
    <nsd:type>ELAN</nsd:type>
    <nsd:root-bandwidth>0</nsd:root-bandwidth>
    <nsd:leaf-bandwidth>0</nsd:leaf-bandwidth>
    <nsd:provider-network>...</nsd:provider-network>
    <nsd:mgmt-network>false</nsd:mgmt-network>
    <nsd:vim-network-name>STRING</nsd:vim-network-name>
    <nsd:ip-profile-ref>STRING</nsd:ip-profile-ref>
    <nsd:vnfd-connection-point-ref>...</nsd:vnfd-connection-point-ref>
  </nsd:vld>
  <nsd:constituent-vnfd>
    <nsd:member-vnf-index>0</nsd:member-vnf-index>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
    <nsd:start-by-default>true</nsd:start-by-default>
  </nsd:constituent-vnfd>
  <nsd:placement-groups>
    <nsd:name>STRING</nsd:name>
    <nsd:requirement>STRING</nsd:requirement>
    <nsd:strategy>COLOCATION</nsd:strategy>
    <nsd:member-vnfd>...</nsd:member-vnfd>
  </nsd:placement-groups>
  <nsd:vnf-dependency>
    <nsd:vnf-source-ref>STRING</nsd:vnf-source-ref>
    <nsd:vnf-depends-on-ref>STRING</nsd:vnf-depends-on-ref>
  </nsd:vnf-dependency>
  <nsd:monitoring-param>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:value-type>INT</nsd:value-type>
    <nsd:numeric-constraints>...</nsd:numeric-constraints>
    <nsd:text-constraints>...</nsd:text-constraints>
    <nsd:value-integer>0</nsd:value-integer>
    <nsd:value-decimal>0.0</nsd:value-decimal>
    <nsd:value-string>STRING</nsd:value-string>
    <nsd:description>STRING</nsd:description>
    <nsd:group-tag>STRING</nsd:group-tag>
    <nsd:widget-type>COUNTER</nsd:widget-type>
    <nsd:units>STRING</nsd:units>
    <nsd:aggregation-type>AVERAGE</nsd:aggregation-type>
    <nsd:vnfd-monitoring-param>...</nsd:vnfd-monitoring-param>
  </nsd:monitoring-param>
  <nsd:service-primitive>
    <nsd:name>STRING</nsd:name>
    <nsd:parameter>...</nsd:parameter>
    <nsd:parameter-group>...</nsd:parameter-group>
    <nsd:vnf-primitive-group>...</nsd:vnf-primitive-group>
    <nsd:user-defined-script>STRING</nsd:user-defined-script>
  </nsd:service-primitive>
</nsd:nsd>

XML Sample

<nsd:nsd xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:short-name>STRING</nsd:short-name>
  <nsd:vendor>STRING</nsd:vendor>
  <nsd:logo>STRING</nsd:logo>
  <nsd:description>STRING</nsd:description>
  <nsd:version>STRING</nsd:version>
  <nsd:connection-point>
    <nsd:name>STRING</nsd:name>
    <nsd:type>VPORT</nsd:type>
  </nsd:connection-point>
  <nsd:scaling-group-descriptor>
    <nsd:name>STRING</nsd:name>
    <nsd:scaling-policy>...</nsd:scaling-policy>
    <nsd:vnfd-member>...</nsd:vnfd-member>
    <nsd:min-instance-count>0</nsd:min-instance-count>
    <nsd:max-instance-count>10</nsd:max-instance-count>
    <nsd:scaling-config-action>...</nsd:scaling-config-action>
  </nsd:scaling-group-descriptor>
  <nsd:vnffgd>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:short-name>STRING</nsd:short-name>
    <nsd:vendor>STRING</nsd:vendor>
    <nsd:description>STRING</nsd:description>
    <nsd:version>STRING</nsd:version>
    <nsd:rsp>...</nsd:rsp>
    <nsd:classifier>...</nsd:classifier>
  </nsd:vnffgd>
  <nsd:ip-profiles>
    <nsd:name>STRING</nsd:name>
    <nsd:description>STRING</nsd:description>
    <nsd:ip-profile-params>...</nsd:ip-profile-params>
  </nsd:ip-profiles>
  <nsd:initial-service-primitive>
    <nsd:seq>0</nsd:seq>
    <nsd:name>STRING</nsd:name>
    <nsd:user-defined-script>STRING</nsd:user-defined-script>
    <nsd:parameter>...</nsd:parameter>
  </nsd:initial-service-primitive>
  <nsd:terminate-service-primitive>
    <nsd:seq>0</nsd:seq>
    <nsd:name>STRING</nsd:name>
    <nsd:user-defined-script>STRING</nsd:user-defined-script>
    <nsd:parameter>...</nsd:parameter>
  </nsd:terminate-service-primitive>
  <nsd:input-parameter-xpath>
    <nsd:xpath>STRING</nsd:xpath>
    <nsd:label>STRING</nsd:label>
    <nsd:default-value>STRING</nsd:default-value>
  </nsd:input-parameter-xpath>
  <nsd:parameter-pool>
    <nsd:name>STRING</nsd:name>
    <nsd:range>...</nsd:range>
  </nsd:parameter-pool>
  <nsd:key-pair>
    <nsd:name>STRING</nsd:name>
    <nsd:key>STRING</nsd:key>
  </nsd:key-pair>
  <nsd:user>
    <nsd:name>STRING</nsd:name>
    <nsd:user-info>STRING</nsd:user-info>
    <nsd:key-pair>...</nsd:key-pair>
  </nsd:user>
  <nsd:vld>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:short-name>STRING</nsd:short-name>
    <nsd:vendor>STRING</nsd:vendor>
    <nsd:description>STRING</nsd:description>
    <nsd:version>STRING</nsd:version>
    <nsd:type>ELAN</nsd:type>
    <nsd:root-bandwidth>0</nsd:root-bandwidth>
    <nsd:leaf-bandwidth>0</nsd:leaf-bandwidth>
    <nsd:provider-network>...</nsd:provider-network>
    <nsd:mgmt-network>false</nsd:mgmt-network>
    <nsd:vim-network-name>STRING</nsd:vim-network-name>
    <nsd:ip-profile-ref>STRING</nsd:ip-profile-ref>
    <nsd:vnfd-connection-point-ref>...</nsd:vnfd-connection-point-ref>
  </nsd:vld>
  <nsd:constituent-vnfd>
    <nsd:member-vnf-index>0</nsd:member-vnf-index>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
    <nsd:start-by-default>true</nsd:start-by-default>
  </nsd:constituent-vnfd>
  <nsd:placement-groups>
    <nsd:name>STRING</nsd:name>
    <nsd:requirement>STRING</nsd:requirement>
    <nsd:strategy>COLOCATION</nsd:strategy>
    <nsd:member-vnfd>...</nsd:member-vnfd>
  </nsd:placement-groups>
  <nsd:vnf-dependency>
    <nsd:vnf-source-ref>STRING</nsd:vnf-source-ref>
    <nsd:vnf-depends-on-ref>STRING</nsd:vnf-depends-on-ref>
  </nsd:vnf-dependency>
  <nsd:monitoring-param>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:value-type>INT</nsd:value-type>
    <nsd:numeric-constraints>...</nsd:numeric-constraints>
    <nsd:text-constraints>...</nsd:text-constraints>
    <nsd:value-integer>0</nsd:value-integer>
    <nsd:value-decimal>0.0</nsd:value-decimal>
    <nsd:value-string>STRING</nsd:value-string>
    <nsd:description>STRING</nsd:description>
    <nsd:group-tag>STRING</nsd:group-tag>
    <nsd:widget-type>COUNTER</nsd:widget-type>
    <nsd:units>STRING</nsd:units>
    <nsd:aggregation-type>AVERAGE</nsd:aggregation-type>
    <nsd:vnfd-monitoring-param>...</nsd:vnfd-monitoring-param>
  </nsd:monitoring-param>
  <nsd:service-primitive>
    <nsd:name>STRING</nsd:name>
    <nsd:parameter>...</nsd:parameter>
    <nsd:parameter-group>...</nsd:parameter-group>
    <nsd:vnf-primitive-group>...</nsd:vnf-primitive-group>
    <nsd:user-defined-script>STRING</nsd:user-defined-script>
  </nsd:service-primitive>
</nsd:nsd>

nsd:connection-point

List for external connection points. Each NS has one or more external connection points. As the name implies that external connection points are used for connecting the NS to other NS or to external networks. Each NS exposes these connection points to the orchestrator. The orchestrator can construct network service chains by connecting the connection points between different NS.

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:connection-point
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:connection-point[nsd:name='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/connection-point/STRING

Fields

Name	Type	Description
name	STRING	Name of the NS connection point.
type	ENUM	Type of the connection point.

JSON Config Sample

[
  {
    "name": "STRING",
    "type": "VPORT"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "type": "VPORT"
  }, {
    ...
  }
]

XML Config Sample

<nsd:connection-point xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:type>VPORT</nsd:type>
</nsd:connection-point>

XML Sample

<nsd:connection-point xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:type>VPORT</nsd:type>
</nsd:connection-point>

nsd:scaling-group-descriptor

scaling group descriptor within this network service. The scaling group defines a group of VNFs, and the ratio of VNFs in the network service that is used as target for scaling action

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING

Fields

Name	Type	Description
name	STRING	Name of this scaling group.
scaling-policy	LIST
vnfd-member	LIST	List of VNFs in this scaling group
min-instance-count	UINT32	Minimum instances of the scaling group which are allowed. These instances are created by default when the network service is instantiated.
max-instance-count	UINT32	Maximum instances of this scaling group that are allowed in a single network service. The network service scaling will fail, when the number of service group instances exceed the max-instance-count specified.
scaling-config-action	LIST	List of scaling config actions

JSON Config Sample

[
  {
    "name": "STRING",
    "scaling-policy": [
      {
        "name": "STRING",
        "scaling-type": "manual",
        "enabled": true,
        "scale-in-operation-type": "AND",
        "scale-out-operation-type": "OR",
        "threshold-time": 0,
        "cooldown-time": 0,
        "scaling-criteria": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnfd-member": [
      {
        "member-vnf-index-ref": 0,
        "count": 1
      }, {
        ...
      }
    ],
    "min-instance-count": 0,
    "max-instance-count": 10,
    "scaling-config-action": [
      {
        "trigger": "pre-scale-in",
        "ns-service-primitive-name-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scaling-policy": [
      {
        "name": "STRING",
        "scaling-type": "manual",
        "enabled": true,
        "scale-in-operation-type": "AND",
        "scale-out-operation-type": "OR",
        "threshold-time": 0,
        "cooldown-time": 0,
        "scaling-criteria": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnfd-member": [
      {
        "member-vnf-index-ref": 0,
        "count": 1
      }, {
        ...
      }
    ],
    "min-instance-count": 0,
    "max-instance-count": 10,
    "scaling-config-action": [
      {
        "trigger": "pre-scale-in",
        "ns-service-primitive-name-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:scaling-group-descriptor xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:scaling-policy>
    <nsd:name>STRING</nsd:name>
    <nsd:scaling-type>manual</nsd:scaling-type>
    <nsd:enabled>true</nsd:enabled>
    <nsd:scale-in-operation-type>AND</nsd:scale-in-operation-type>
    <nsd:scale-out-operation-type>OR</nsd:scale-out-operation-type>
    <nsd:threshold-time>0</nsd:threshold-time>
    <nsd:cooldown-time>0</nsd:cooldown-time>
    <nsd:scaling-criteria>...</nsd:scaling-criteria>
  </nsd:scaling-policy>
  <nsd:vnfd-member>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:count>1</nsd:count>
  </nsd:vnfd-member>
  <nsd:min-instance-count>0</nsd:min-instance-count>
  <nsd:max-instance-count>10</nsd:max-instance-count>
  <nsd:scaling-config-action>
    <nsd:trigger>pre-scale-in</nsd:trigger>
    <nsd:ns-service-primitive-name-ref>STRING</nsd:ns-service-primitive-name-ref>
  </nsd:scaling-config-action>
</nsd:scaling-group-descriptor>

XML Sample

<nsd:scaling-group-descriptor xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:scaling-policy>
    <nsd:name>STRING</nsd:name>
    <nsd:scaling-type>manual</nsd:scaling-type>
    <nsd:enabled>true</nsd:enabled>
    <nsd:scale-in-operation-type>AND</nsd:scale-in-operation-type>
    <nsd:scale-out-operation-type>OR</nsd:scale-out-operation-type>
    <nsd:threshold-time>0</nsd:threshold-time>
    <nsd:cooldown-time>0</nsd:cooldown-time>
    <nsd:scaling-criteria>...</nsd:scaling-criteria>
  </nsd:scaling-policy>
  <nsd:vnfd-member>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:count>1</nsd:count>
  </nsd:vnfd-member>
  <nsd:min-instance-count>0</nsd:min-instance-count>
  <nsd:max-instance-count>10</nsd:max-instance-count>
  <nsd:scaling-config-action>
    <nsd:trigger>pre-scale-in</nsd:trigger>
    <nsd:ns-service-primitive-name-ref>STRING</nsd:ns-service-primitive-name-ref>
  </nsd:scaling-config-action>
</nsd:scaling-group-descriptor>

nsd:scaling-policy

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-policy

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-policy[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-policy/STRING

Fields

Name	Type	Description
name	STRING	Name of the scaling policy
scaling-type	ENUM	Type of scaling
enabled	BOOLEAN	Specifies if the scaling policy can be applied
scale-in-operation-type	ENUM	Operation to be applied to check between scaling criterias to check if the scale in threshold condition has been met. Defaults to AND
scale-out-operation-type	ENUM	Operation to be applied to check between scaling criterias to check if the scale out threshold condition has been met. Defauls to OR
threshold-time	UINT32	The duration for which the criteria must hold true
cooldown-time	UINT32	The duration after a scaling-in/scaling-out action has been triggered, for which there will be no further optional
scaling-criteria	LIST	list of conditions to be met for generating scaling requests

JSON Config Sample

[
  {
    "name": "STRING",
    "scaling-type": "manual",
    "enabled": true,
    "scale-in-operation-type": "AND",
    "scale-out-operation-type": "OR",
    "threshold-time": 0,
    "cooldown-time": 0,
    "scaling-criteria": [
      {
        "name": "STRING",
        "scale-in-threshold": 0,
        "scale-out-threshold": 0,
        "ns-monitoring-param-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scaling-type": "manual",
    "enabled": true,
    "scale-in-operation-type": "AND",
    "scale-out-operation-type": "OR",
    "threshold-time": 0,
    "cooldown-time": 0,
    "scaling-criteria": [
      {
        "name": "STRING",
        "scale-in-threshold": 0,
        "scale-out-threshold": 0,
        "ns-monitoring-param-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:scaling-policy xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:scaling-type>manual</nsd:scaling-type>
  <nsd:enabled>true</nsd:enabled>
  <nsd:scale-in-operation-type>AND</nsd:scale-in-operation-type>
  <nsd:scale-out-operation-type>OR</nsd:scale-out-operation-type>
  <nsd:threshold-time>0</nsd:threshold-time>
  <nsd:cooldown-time>0</nsd:cooldown-time>
  <nsd:scaling-criteria>
    <nsd:name>STRING</nsd:name>
    <nsd:scale-in-threshold>0</nsd:scale-in-threshold>
    <nsd:scale-out-threshold>0</nsd:scale-out-threshold>
    <nsd:ns-monitoring-param-ref>STRING</nsd:ns-monitoring-param-ref>
  </nsd:scaling-criteria>
</nsd:scaling-policy>

XML Sample

<nsd:scaling-policy xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:scaling-type>manual</nsd:scaling-type>
  <nsd:enabled>true</nsd:enabled>
  <nsd:scale-in-operation-type>AND</nsd:scale-in-operation-type>
  <nsd:scale-out-operation-type>OR</nsd:scale-out-operation-type>
  <nsd:threshold-time>0</nsd:threshold-time>
  <nsd:cooldown-time>0</nsd:cooldown-time>
  <nsd:scaling-criteria>
    <nsd:name>STRING</nsd:name>
    <nsd:scale-in-threshold>0</nsd:scale-in-threshold>
    <nsd:scale-out-threshold>0</nsd:scale-out-threshold>
    <nsd:ns-monitoring-param-ref>STRING</nsd:ns-monitoring-param-ref>
  </nsd:scaling-criteria>
</nsd:scaling-policy>

nsd:scaling-criteria

list of conditions to be met for generating scaling requests

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-policy/nsd:scaling-criteria

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-policy[nsd:name='STRING']/nsd:scaling-criteria[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-policy/STRING/scaling-criteria/STRING

Fields

Name	Type	Description
name	STRING
scale-in-threshold	UINT64	Value below which scale-in requests are generated
scale-out-threshold	UINT64	Value above which scale-out requests are generated
ns-monitoring-param-ref	LEAFREF	Reference to the NS level monitoring parameter that is aggregated

JSON Config Sample

[
  {
    "name": "STRING",
    "scale-in-threshold": 0,
    "scale-out-threshold": 0,
    "ns-monitoring-param-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "scale-in-threshold": 0,
    "scale-out-threshold": 0,
    "ns-monitoring-param-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:scaling-criteria xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:scale-in-threshold>0</nsd:scale-in-threshold>
  <nsd:scale-out-threshold>0</nsd:scale-out-threshold>
  <nsd:ns-monitoring-param-ref>STRING</nsd:ns-monitoring-param-ref>
</nsd:scaling-criteria>

XML Sample

<nsd:scaling-criteria xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:scale-in-threshold>0</nsd:scale-in-threshold>
  <nsd:scale-out-threshold>0</nsd:scale-out-threshold>
  <nsd:ns-monitoring-param-ref>STRING</nsd:ns-monitoring-param-ref>
</nsd:scaling-criteria>

nsd:vnfd-member

List of VNFs in this scaling group

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:vnfd-member

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:vnfd-member[nsd:member-vnf-index-ref='0']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/vnfd-member/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	member VNF index of this member VNF
count	UINT32	count of this member VNF within this scaling group. The count allows to define the number of instances when a scaling action targets this scaling group

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "count": 1
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "count": 1
  }, {
    ...
  }
]

XML Config Sample

<nsd:vnfd-member xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:count>1</nsd:count>
</nsd:vnfd-member>

XML Sample

<nsd:vnfd-member xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:count>1</nsd:count>
</nsd:vnfd-member>

nsd:scaling-config-action

List of scaling config actions

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:scaling-group-descriptor/nsd:scaling-config-action

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:scaling-group-descriptor[nsd:name='STRING']/nsd:scaling-config-action[nsd:trigger='pre-scale-in']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/scaling-group-descriptor/STRING/scaling-config-action/pre-scale-in

Fields

Name	Type	Description
trigger	ENUM	scaling trigger
ns-service-primitive-name-ref	LEAFREF	Reference to the NS service primitive

JSON Config Sample

[
  {
    "trigger": "pre-scale-in",
    "ns-service-primitive-name-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "trigger": "pre-scale-in",
    "ns-service-primitive-name-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:scaling-config-action xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:trigger>pre-scale-in</nsd:trigger>
  <nsd:ns-service-primitive-name-ref>STRING</nsd:ns-service-primitive-name-ref>
</nsd:scaling-config-action>

XML Sample

<nsd:scaling-config-action xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:trigger>pre-scale-in</nsd:trigger>
  <nsd:ns-service-primitive-name-ref>STRING</nsd:ns-service-primitive-name-ref>
</nsd:scaling-config-action>

nsd:vnffgd

List of VNF Forwarding Graph Descriptors (VNFFGD).

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/vnffgd/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VNFFGD.
name	STRING	VNFFGD name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Provider of the VNFFGD.
description	STRING	Description of the VNFFGD.
version	STRING	Version of the VNFFGD
rsp	LIST	List of Rendered Service Paths (RSP).
classifier	LIST	List of classifier rules.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "rsp": [
      {
        "id": "STRING",
        "name": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier": [
      {
        "id": "STRING",
        "name": "STRING",
        "rsp-id-ref": "STRING",
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING",
        "match-attributes": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "rsp": [
      {
        "id": "STRING",
        "name": "STRING",
        "vnfd-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier": [
      {
        "id": "STRING",
        "name": "STRING",
        "rsp-id-ref": "STRING",
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING",
        "match-attributes": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:vnffgd xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:short-name>STRING</nsd:short-name>
  <nsd:vendor>STRING</nsd:vendor>
  <nsd:description>STRING</nsd:description>
  <nsd:version>STRING</nsd:version>
  <nsd:rsp>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:vnfd-connection-point-ref>...</nsd:vnfd-connection-point-ref>
  </nsd:rsp>
  <nsd:classifier>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:rsp-id-ref>STRING</nsd:rsp-id-ref>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
    <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
    <nsd:match-attributes>...</nsd:match-attributes>
  </nsd:classifier>
</nsd:vnffgd>

XML Sample

<nsd:vnffgd xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:short-name>STRING</nsd:short-name>
  <nsd:vendor>STRING</nsd:vendor>
  <nsd:description>STRING</nsd:description>
  <nsd:version>STRING</nsd:version>
  <nsd:rsp>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:vnfd-connection-point-ref>...</nsd:vnfd-connection-point-ref>
  </nsd:rsp>
  <nsd:classifier>
    <nsd:id>STRING</nsd:id>
    <nsd:name>STRING</nsd:name>
    <nsd:rsp-id-ref>STRING</nsd:rsp-id-ref>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
    <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
    <nsd:match-attributes>...</nsd:match-attributes>
  </nsd:classifier>
</nsd:vnffgd>

nsd:rsp

List of Rendered Service Paths (RSP).

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:rsp
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:rsp[nsd:id='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/rsp/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the RSP.
name	STRING	RSP name.
vnfd-connection-point-ref	LIST	A list of references to connection points.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "order": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "order": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:rsp xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:vnfd-connection-point-ref>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:order>0</nsd:order>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
    <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
  </nsd:vnfd-connection-point-ref>
</nsd:rsp>

XML Sample

<nsd:rsp xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:vnfd-connection-point-ref>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:order>0</nsd:order>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
    <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
  </nsd:vnfd-connection-point-ref>
</nsd:rsp>

nsd:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:rsp/nsd:vnfd-connection-point-ref

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:rsp[nsd:id='STRING']/nsd:vnfd-connection-point-ref[nsd:member-vnf-index-ref='0']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/rsp/STRING/vnfd-connection-point-ref/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
order	UINT8	A number that denotes the order of a VNF in a chain
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref
vnfd-connection-point-ref	STRING	A reference to a connection point name in a vnfd. This is a leafref to path: /vnfd:vnfd-catalog/vnfd:vnfd + [vnfd:id = current()/../nsd:vnfd-id-ref] + /vnfd:connection-point/vnfd:name NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "order": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "order": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:vnfd-connection-point-ref xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:order>0</nsd:order>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
</nsd:vnfd-connection-point-ref>

XML Sample

<nsd:vnfd-connection-point-ref xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:order>0</nsd:order>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
</nsd:vnfd-connection-point-ref>

nsd:classifier

List of classifier rules.

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:classifier

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:classifier[nsd:id='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/classifier/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the classifier rule.
name	STRING	Name of the classifier.
rsp-id-ref	LEAFREF	A reference to the RSP.
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	LEAFREF	A reference to a vnfd. This is a leafref to path: ../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref
vnfd-connection-point-ref	STRING	A reference to a connection point name in a vnfd. This is a leafref to path: /vnfd:vnfd-catalog/vnfd:vnfd + [vnfd:id = current()/../nsd:vnfd-id-ref] + /vnfd:connection-point/vnfd:name NOTE: An issue with confd is preventing the use of xpath. Seems to be an issue with leafref to leafref, whose target is in a different module. Once that is resolved this will switched to use leafref
match-attributes	LIST	List of match attributes.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "rsp-id-ref": "STRING",
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING",
    "match-attributes": [
      {
        "id": "STRING",
        "ip-proto": 0,
        "source-ip-address": "UNION_VALUE",
        "destination-ip-address": "UNION_VALUE",
        "source-port": 0,
        "destination-port": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "rsp-id-ref": "STRING",
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING",
    "match-attributes": [
      {
        "id": "STRING",
        "ip-proto": 0,
        "source-ip-address": "UNION_VALUE",
        "destination-ip-address": "UNION_VALUE",
        "source-port": 0,
        "destination-port": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:classifier xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:rsp-id-ref>STRING</nsd:rsp-id-ref>
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
  <nsd:match-attributes>
    <nsd:id>STRING</nsd:id>
    <nsd:ip-proto>0</nsd:ip-proto>
    <nsd:source-ip-address>UNION_VALUE</nsd:source-ip-address>
    <nsd:destination-ip-address>UNION_VALUE</nsd:destination-ip-address>
    <nsd:source-port>0</nsd:source-port>
    <nsd:destination-port>0</nsd:destination-port>
  </nsd:match-attributes>
</nsd:classifier>

XML Sample

<nsd:classifier xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:rsp-id-ref>STRING</nsd:rsp-id-ref>
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
  <nsd:match-attributes>
    <nsd:id>STRING</nsd:id>
    <nsd:ip-proto>0</nsd:ip-proto>
    <nsd:source-ip-address>UNION_VALUE</nsd:source-ip-address>
    <nsd:destination-ip-address>UNION_VALUE</nsd:destination-ip-address>
    <nsd:source-port>0</nsd:source-port>
    <nsd:destination-port>0</nsd:destination-port>
  </nsd:match-attributes>
</nsd:classifier>

nsd:match-attributes

List of match attributes.

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:vnffgd/nsd:classifier/nsd:match-attributes

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnffgd[nsd:id='STRING']/nsd:classifier[nsd:id='STRING']/nsd:match-attributes[nsd:id='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/vnffgd/STRING/classifier/STRING/match-attributes/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the classifier match attribute rule.
ip-proto	UINT8	IP Protocol.
source-ip-address	UNION	Source IP address.
destination-ip-address	UNION	Destination IP address.
source-port	UINT16	Source port number.
destination-port	UINT16	Destination port number.

JSON Config Sample

[
  {
    "id": "STRING",
    "ip-proto": 0,
    "source-ip-address": "UNION_VALUE",
    "destination-ip-address": "UNION_VALUE",
    "source-port": 0,
    "destination-port": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "ip-proto": 0,
    "source-ip-address": "UNION_VALUE",
    "destination-ip-address": "UNION_VALUE",
    "source-port": 0,
    "destination-port": 0
  }, {
    ...
  }
]

XML Config Sample

<nsd:match-attributes xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:ip-proto>0</nsd:ip-proto>
  <nsd:source-ip-address>UNION_VALUE</nsd:source-ip-address>
  <nsd:destination-ip-address>UNION_VALUE</nsd:destination-ip-address>
  <nsd:source-port>0</nsd:source-port>
  <nsd:destination-port>0</nsd:destination-port>
</nsd:match-attributes>

XML Sample

<nsd:match-attributes xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:ip-proto>0</nsd:ip-proto>
  <nsd:source-ip-address>UNION_VALUE</nsd:source-ip-address>
  <nsd:destination-ip-address>UNION_VALUE</nsd:destination-ip-address>
  <nsd:source-port>0</nsd:source-port>
  <nsd:destination-port>0</nsd:destination-port>
</nsd:match-attributes>

nsd:ip-profiles

List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING

Fields

Name	Type	Description
name	STRING	Name of the IP-Profile
description	STRING	Description for IP profile
ip-profile-params	CONTAINER

JSON Config Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "ip-profile-params": {
      "ip-version": "ipv4",
      "subnet-address": "UNION_VALUE",
      "gateway-address": "UNION_VALUE",
      "security-group": "STRING",
      "dns-server": [ { ... }, { ... } ],
      "dhcp-params": { ... },
      "subnet-prefix-pool": "STRING"
    }
  }, {
    ...
  }
]

XML Config Sample

<nsd:ip-profiles xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:description>STRING</nsd:description>
  <nsd:ip-profile-params>
    <nsd:ip-version>ipv4</nsd:ip-version>
    <nsd:subnet-address>UNION_VALUE</nsd:subnet-address>
    <nsd:gateway-address>UNION_VALUE</nsd:gateway-address>
    <nsd:security-group>STRING</nsd:security-group>
    <nsd:dns-server>...</nsd:dns-server>
    <nsd:dhcp-params>...</nsd:dhcp-params>
    <nsd:subnet-prefix-pool>STRING</nsd:subnet-prefix-pool>
  </nsd:ip-profile-params>
</nsd:ip-profiles>

XML Sample

<nsd:ip-profiles xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:description>STRING</nsd:description>
  <nsd:ip-profile-params>
    <nsd:ip-version>ipv4</nsd:ip-version>
    <nsd:subnet-address>UNION_VALUE</nsd:subnet-address>
    <nsd:gateway-address>UNION_VALUE</nsd:gateway-address>
    <nsd:security-group>STRING</nsd:security-group>
    <nsd:dns-server>...</nsd:dns-server>
    <nsd:dhcp-params>...</nsd:dhcp-params>
    <nsd:subnet-prefix-pool>STRING</nsd:subnet-prefix-pool>
  </nsd:ip-profile-params>
</nsd:ip-profiles>

nsd:ip-profile-params

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params

Fields

Name	Type	Description
ip-version	ENUM
subnet-address	UNION	Subnet IP prefix associated with IP Profile
gateway-address	UNION	IP Address of the default gateway associated with IP Profile
security-group	STRING	Name of the security group
dns-server	LIST
dhcp-params	CONTAINER
subnet-prefix-pool	STRING	VIM Specific reference to pre-created subnet prefix

JSON Config Sample

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

JSON Sample

{
  "ip-version": "ipv4",
  "subnet-address": "UNION_VALUE",
  "gateway-address": "UNION_VALUE",
  "security-group": "STRING",
  "dns-server": [
    {
      "address": "UNION_VALUE"
    }, {
      ...
    }
  ],
  "dhcp-params": {
    "enabled": true,
    "start-address": "UNION_VALUE",
    "count": 0
  },
  "subnet-prefix-pool": "STRING"
}

XML Config Sample

<nsd:ip-profile-params xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:ip-version>ipv4</nsd:ip-version>
  <nsd:subnet-address>UNION_VALUE</nsd:subnet-address>
  <nsd:gateway-address>UNION_VALUE</nsd:gateway-address>
  <nsd:security-group>STRING</nsd:security-group>
  <nsd:dns-server>
    <nsd:address>UNION_VALUE</nsd:address>
  </nsd:dns-server>
  <nsd:dhcp-params>
    <nsd:enabled>true</nsd:enabled>
    <nsd:start-address>UNION_VALUE</nsd:start-address>
    <nsd:count>0</nsd:count>
  </nsd:dhcp-params>
  <nsd:subnet-prefix-pool>STRING</nsd:subnet-prefix-pool>
</nsd:ip-profile-params>

XML Sample

<nsd:ip-profile-params xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:ip-version>ipv4</nsd:ip-version>
  <nsd:subnet-address>UNION_VALUE</nsd:subnet-address>
  <nsd:gateway-address>UNION_VALUE</nsd:gateway-address>
  <nsd:security-group>STRING</nsd:security-group>
  <nsd:dns-server>
    <nsd:address>UNION_VALUE</nsd:address>
  </nsd:dns-server>
  <nsd:dhcp-params>
    <nsd:enabled>true</nsd:enabled>
    <nsd:start-address>UNION_VALUE</nsd:start-address>
    <nsd:count>0</nsd:count>
  </nsd:dhcp-params>
  <nsd:subnet-prefix-pool>STRING</nsd:subnet-prefix-pool>
</nsd:ip-profile-params>

nsd:dns-server

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params/nsd:dns-server

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params/nsd:dns-server[nsd:address='UNION_VALUE']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params/dns-server/UNION_VALUE

Fields

Name	Type	Description
address	UNION	List of DNS Servers associated with IP Profile

JSON Config Sample

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "address": "UNION_VALUE"
  }, {
    ...
  }
]

XML Config Sample

<nsd:dns-server xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:address>UNION_VALUE</nsd:address>
</nsd:dns-server>

XML Sample

<nsd:dns-server xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:address>UNION_VALUE</nsd:address>
</nsd:dns-server>

nsd:dhcp-params

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:ip-profiles/nsd:ip-profile-params/nsd:dhcp-params

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:ip-profiles[nsd:name='STRING']/nsd:ip-profile-params/nsd:dhcp-params

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/ip-profiles/STRING/ip-profile-params/dhcp-params

Fields

Name	Type	Description
enabled	BOOLEAN	This flag indicates if DHCP is enabled or not
start-address	UNION	Start IP address of the IP-Address range associated with DHCP domain
count	UINT32	Size of the DHCP pool associated with DHCP domain

JSON Config Sample

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

JSON Sample

{
  "enabled": true,
  "start-address": "UNION_VALUE",
  "count": 0
}

XML Config Sample

<nsd:dhcp-params xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:enabled>true</nsd:enabled>
  <nsd:start-address>UNION_VALUE</nsd:start-address>
  <nsd:count>0</nsd:count>
</nsd:dhcp-params>

XML Sample

<nsd:dhcp-params xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:enabled>true</nsd:enabled>
  <nsd:start-address>UNION_VALUE</nsd:start-address>
  <nsd:count>0</nsd:count>
</nsd:dhcp-params>

nsd:initial-service-primitive

Initial set of service primitives for NSD.

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:initial-service-primitive
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:initial-service-primitive[nsd:seq='0']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/initial-service-primitive/0

Fields

Name	Type	Description
seq	UINT64	Sequence number for the configuration primitive.
name	STRING	Name of the configuration primitive.
user-defined-script	STRING	A user defined script.
parameter	LIST

JSON Config Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:initial-service-primitive xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:seq>0</nsd:seq>
  <nsd:name>STRING</nsd:name>
  <nsd:user-defined-script>STRING</nsd:user-defined-script>
  <nsd:parameter>
    <nsd:name>STRING</nsd:name>
    <nsd:value>STRING</nsd:value>
  </nsd:parameter>
</nsd:initial-service-primitive>

XML Sample

<nsd:initial-service-primitive xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:seq>0</nsd:seq>
  <nsd:name>STRING</nsd:name>
  <nsd:user-defined-script>STRING</nsd:user-defined-script>
  <nsd:parameter>
    <nsd:name>STRING</nsd:name>
    <nsd:value>STRING</nsd:value>
  </nsd:parameter>
</nsd:initial-service-primitive>

nsd:parameter

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:initial-service-primitive/nsd:parameter

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:initial-service-primitive[nsd:seq='0']/nsd:parameter[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/initial-service-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING
value	STRING	Value of the configuration primitive.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:parameter xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:value>STRING</nsd:value>
</nsd:parameter>

XML Sample

<nsd:parameter xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:value>STRING</nsd:value>
</nsd:parameter>

nsd:terminate-service-primitive

Set of service primitives during termination for NSD.

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:terminate-service-primitive
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:terminate-service-primitive[nsd:seq='0']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/terminate-service-primitive/0

Fields

Name	Type	Description
seq	UINT64	Sequence number for the configuration primitive.
name	STRING	Name of the configuration primitive.
user-defined-script	STRING	A user defined script.
parameter	LIST

JSON Config Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "seq": 0,
    "name": "STRING",
    "user-defined-script": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:terminate-service-primitive xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:seq>0</nsd:seq>
  <nsd:name>STRING</nsd:name>
  <nsd:user-defined-script>STRING</nsd:user-defined-script>
  <nsd:parameter>
    <nsd:name>STRING</nsd:name>
    <nsd:value>STRING</nsd:value>
  </nsd:parameter>
</nsd:terminate-service-primitive>

XML Sample

<nsd:terminate-service-primitive xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:seq>0</nsd:seq>
  <nsd:name>STRING</nsd:name>
  <nsd:user-defined-script>STRING</nsd:user-defined-script>
  <nsd:parameter>
    <nsd:name>STRING</nsd:name>
    <nsd:value>STRING</nsd:value>
  </nsd:parameter>
</nsd:terminate-service-primitive>

nsd:parameter

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:terminate-service-primitive/nsd:parameter

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:terminate-service-primitive[nsd:seq='0']/nsd:parameter[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/terminate-service-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING
value	STRING	Value of the configuration primitive.

JSON Config Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:parameter xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:value>STRING</nsd:value>
</nsd:parameter>

XML Sample

<nsd:parameter xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:value>STRING</nsd:value>
</nsd:parameter>

nsd:input-parameter-xpath

List of xpaths to parameters inside the NSD the can be customized during the instantiation.

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:input-parameter-xpath
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:input-parameter-xpath[nsd:xpath='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/input-parameter-xpath/STRING

Fields

Name	Type	Description
xpath	STRING	An xpath that specifies the element in a descriptor.
label	STRING	A descriptive string
default-value	STRING	Default Value for the Input Parameter

JSON Config Sample

[
  {
    "xpath": "STRING",
    "label": "STRING",
    "default-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "xpath": "STRING",
    "label": "STRING",
    "default-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:input-parameter-xpath xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:xpath>STRING</nsd:xpath>
  <nsd:label>STRING</nsd:label>
  <nsd:default-value>STRING</nsd:default-value>
</nsd:input-parameter-xpath>

XML Sample

<nsd:input-parameter-xpath xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:xpath>STRING</nsd:xpath>
  <nsd:label>STRING</nsd:label>
  <nsd:default-value>STRING</nsd:default-value>
</nsd:input-parameter-xpath>

nsd:parameter-pool

Pool of parameter values which must be pulled from during configuration

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:parameter-pool
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:parameter-pool[nsd:name='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/parameter-pool/STRING

Fields

Name	Type	Description
name	STRING	Name of the configuration value pool
range	CONTAINER	Create a range of values to populate the pool with

JSON Config Sample

[
  {
    "name": "STRING",
    "range": {
      "start-value": 0,
      "end-value": 0
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "range": {
      "start-value": 0,
      "end-value": 0
    }
  }, {
    ...
  }
]

XML Config Sample

<nsd:parameter-pool xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:range>
    <nsd:start-value>0</nsd:start-value>
    <nsd:end-value>0</nsd:end-value>
  </nsd:range>
</nsd:parameter-pool>

XML Sample

<nsd:parameter-pool xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:range>
    <nsd:start-value>0</nsd:start-value>
    <nsd:end-value>0</nsd:end-value>
  </nsd:range>
</nsd:parameter-pool>

nsd:range

Create a range of values to populate the pool with

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:parameter-pool/nsd:range
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:parameter-pool[nsd:name='STRING']/nsd:range
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/parameter-pool/STRING/range

Fields

Name	Type	Description
start-value	UINT32	Generated pool values start at this value
end-value	UINT32	Generated pool values stop at this value

JSON Config Sample

{
  "start-value": 0,
  "end-value": 0
}

JSON Sample

{
  "start-value": 0,
  "end-value": 0
}

XML Config Sample

<nsd:range xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:start-value>0</nsd:start-value>
  <nsd:end-value>0</nsd:end-value>
</nsd:range>

XML Sample

<nsd:range xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:start-value>0</nsd:start-value>
  <nsd:end-value>0</nsd:end-value>
</nsd:range>

nsd:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:key-pair
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:key-pair[nsd:name='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Config Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:key-pair xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:key>STRING</nsd:key>
</nsd:key-pair>

XML Sample

<nsd:key-pair xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:key>STRING</nsd:key>
</nsd:key-pair>

nsd:user

List of users to be added through cloud-config

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:user
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:user[nsd:name='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/user/STRING

Fields

Name	Type	Description
name	STRING	Name of the user
user-info	STRING	The user name's real name
key-pair	LIST	Used to configure the list of public keys to be injected as part of ns instantiation

JSON Config Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "user-info": "STRING",
    "key-pair": [
      {
        "name": "STRING",
        "key": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:user xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:user-info>STRING</nsd:user-info>
  <nsd:key-pair>
    <nsd:name>STRING</nsd:name>
    <nsd:key>STRING</nsd:key>
  </nsd:key-pair>
</nsd:user>

XML Sample

<nsd:user xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:user-info>STRING</nsd:user-info>
  <nsd:key-pair>
    <nsd:name>STRING</nsd:name>
    <nsd:key>STRING</nsd:key>
  </nsd:key-pair>
</nsd:user>

nsd:key-pair

Used to configure the list of public keys to be injected as part of ns instantiation

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:user/nsd:key-pair

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:user[nsd:name='STRING']/nsd:key-pair[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/user/STRING/key-pair/STRING

Fields

Name	Type	Description
name	STRING	Name of this key pair
key	STRING	Key associated with this key pair

JSON Config Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "key": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:key-pair xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:key>STRING</nsd:key>
</nsd:key-pair>

XML Sample

<nsd:key-pair xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:key>STRING</nsd:key>
</nsd:key-pair>

nsd:vld

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:vld
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/vld/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VLD.
name	STRING	Virtual Link Descriptor (VLD) name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Provider of the VLD.
description	STRING	Description of the VLD.
version	STRING	Version of the VLD
type	ENUM
root-bandwidth	UINT64	For ELAN this is the aggregate bandwidth.
leaf-bandwidth	UINT64	For ELAN this is the bandwidth of branches.
provider-network	CONTAINER	Container for the provider network.
mgmt-network	BOOLEAN	Flag indicating whether this network is a VIM management network
vim-network-name	STRING	Name of network in VIM account. This is used to indicate pre-provisioned network name in cloud account.
ip-profile-ref	LEAFREF	Named reference to IP-profile object
vnfd-connection-point-ref	LIST	A list of references to connection points.

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "segmentation_id": 0
    },
    "mgmt-network": false,
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "segmentation_id": 0
    },
    "mgmt-network": false,
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING",
    "vnfd-connection-point-ref": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-connection-point-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:vld xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:short-name>STRING</nsd:short-name>
  <nsd:vendor>STRING</nsd:vendor>
  <nsd:description>STRING</nsd:description>
  <nsd:version>STRING</nsd:version>
  <nsd:type>ELAN</nsd:type>
  <nsd:root-bandwidth>0</nsd:root-bandwidth>
  <nsd:leaf-bandwidth>0</nsd:leaf-bandwidth>
  <nsd:provider-network>
    <nsd:physical-network>STRING</nsd:physical-network>
    <nsd:overlay-type>LOCAL</nsd:overlay-type>
    <nsd:segmentation_id>0</nsd:segmentation_id>
  </nsd:provider-network>
  <nsd:mgmt-network>false</nsd:mgmt-network>
  <nsd:vim-network-name>STRING</nsd:vim-network-name>
  <nsd:ip-profile-ref>STRING</nsd:ip-profile-ref>
  <nsd:vnfd-connection-point-ref>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  </nsd:vnfd-connection-point-ref>
</nsd:vld>

XML Sample

<nsd:vld xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:short-name>STRING</nsd:short-name>
  <nsd:vendor>STRING</nsd:vendor>
  <nsd:description>STRING</nsd:description>
  <nsd:version>STRING</nsd:version>
  <nsd:type>ELAN</nsd:type>
  <nsd:root-bandwidth>0</nsd:root-bandwidth>
  <nsd:leaf-bandwidth>0</nsd:leaf-bandwidth>
  <nsd:provider-network>
    <nsd:physical-network>STRING</nsd:physical-network>
    <nsd:overlay-type>LOCAL</nsd:overlay-type>
    <nsd:segmentation_id>0</nsd:segmentation_id>
  </nsd:provider-network>
  <nsd:mgmt-network>false</nsd:mgmt-network>
  <nsd:vim-network-name>STRING</nsd:vim-network-name>
  <nsd:ip-profile-ref>STRING</nsd:ip-profile-ref>
  <nsd:vnfd-connection-point-ref>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  </nsd:vnfd-connection-point-ref>
</nsd:vld>

nsd:provider-network

Container for the provider network.

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:vld/nsd:provider-network
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/nsd:provider-network
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/vld/STRING/provider-network

Fields

Name	Type	Description
physical-network	STRING	Name of the physical network on which the provider network is built.
overlay-type	ENUM	Type of the overlay network. LOCAL - Provider network implemented in a single compute node FLAT - Provider network shared by all tenants VLAN - Provider network implemented using 802.1Q tagging VXLAN - Provider networks implemented using RFC 7348 GRE - Provider networks implemented using GRE tunnels PORTGROUP - Provider networks implemented for VIO support
segmentation_id	UINT32	ID of segregated virtual networks

JSON Config Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

JSON Sample

{
  "physical-network": "STRING",
  "overlay-type": "LOCAL",
  "segmentation_id": 0
}

XML Config Sample

<nsd:provider-network xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:physical-network>STRING</nsd:physical-network>
  <nsd:overlay-type>LOCAL</nsd:overlay-type>
  <nsd:segmentation_id>0</nsd:segmentation_id>
</nsd:provider-network>

XML Sample

<nsd:provider-network xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:physical-network>STRING</nsd:physical-network>
  <nsd:overlay-type>LOCAL</nsd:overlay-type>
  <nsd:segmentation_id>0</nsd:segmentation_id>
</nsd:provider-network>

nsd:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:vld/nsd:vnfd-connection-point-ref

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vld[nsd:id='STRING']/nsd:vnfd-connection-point-ref[nsd:member-vnf-index-ref='0'][nsd:vnfd-connection-point-ref='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/vld/STRING/vnfd-connection-point-ref/0,STRING

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	LEAFREF	A reference to a VNFD
vnfd-connection-point-ref	LEAFREF	A reference to a connection point name

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-connection-point-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:vnfd-connection-point-ref xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
</nsd:vnfd-connection-point-ref>

XML Sample

<nsd:vnfd-connection-point-ref xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-connection-point-ref>STRING</nsd:vnfd-connection-point-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
</nsd:vnfd-connection-point-ref>

nsd:constituent-vnfd

List of VNFDs that are part of this network service.

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:constituent-vnfd
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:constituent-vnfd[nsd:member-vnf-index='0']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/constituent-vnfd/0

Fields

Name	Type	Description
member-vnf-index	UINT64	Identifier/index for the VNFD. This separate id is required to ensure that multiple VNFs can be part of single NS
vnfd-id-ref	LEAFREF	Identifier for the VNFD.
start-by-default	BOOLEAN	VNFD is started as part of the NS instantiation

JSON Config Sample

[
  {
    "member-vnf-index": 0,
    "vnfd-id-ref": "STRING",
    "start-by-default": true
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index": 0,
    "vnfd-id-ref": "STRING",
    "start-by-default": true
  }, {
    ...
  }
]

XML Config Sample

<nsd:constituent-vnfd xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index>0</nsd:member-vnf-index>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  <nsd:start-by-default>true</nsd:start-by-default>
</nsd:constituent-vnfd>

XML Sample

<nsd:constituent-vnfd xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index>0</nsd:member-vnf-index>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  <nsd:start-by-default>true</nsd:start-by-default>
</nsd:constituent-vnfd>

nsd:placement-groups

List of placement groups at NS level

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:placement-groups
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:placement-groups[nsd:name='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/placement-groups/STRING

Fields

Name	Type	Description
name	STRING	Place group construct to define the compute resource placement strategy in cloud environment
requirement	STRING	This is free text space used to describe the intent/rationale behind this placement group. This is for human consumption only
strategy	ENUM	Strategy associated with this placement group Following values are possible - COLOCATION: Colocation strategy imply intent to share the physical infrastructure (hypervisor/network) among all members of this group. - ISOLATION: Isolation strategy imply intent to not share the physical infrastructure (hypervisor/network) among the members of this group.
member-vnfd	LIST	List of VNFDs that are part of this placement group

JSON Config Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vnfd": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vnfd": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:placement-groups xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:requirement>STRING</nsd:requirement>
  <nsd:strategy>COLOCATION</nsd:strategy>
  <nsd:member-vnfd>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  </nsd:member-vnfd>
</nsd:placement-groups>

XML Sample

<nsd:placement-groups xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:requirement>STRING</nsd:requirement>
  <nsd:strategy>COLOCATION</nsd:strategy>
  <nsd:member-vnfd>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  </nsd:member-vnfd>
</nsd:placement-groups>

nsd:member-vnfd

List of VNFDs that are part of this placement group

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:placement-groups/nsd:member-vnfd

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:placement-groups[nsd:name='STRING']/nsd:member-vnfd[nsd:member-vnf-index-ref='0']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/placement-groups/STRING/member-vnfd/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Member VNF index of this member VNF
vnfd-id-ref	LEAFREF	Identifier for the VNFD.

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:member-vnfd xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
</nsd:member-vnfd>

XML Sample

<nsd:member-vnfd xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
</nsd:member-vnfd>

nsd:vnf-dependency

List of VNF dependencies.

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:vnf-dependency
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:vnf-dependency[nsd:vnf-source-ref='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/vnf-dependency/STRING

Fields

Name	Type	Description
vnf-source-ref	LEAFREF
vnf-depends-on-ref	LEAFREF	Reference to VNF that sorce VNF depends.

JSON Config Sample

[
  {
    "vnf-source-ref": "STRING",
    "vnf-depends-on-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnf-source-ref": "STRING",
    "vnf-depends-on-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:vnf-dependency xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:vnf-source-ref>STRING</nsd:vnf-source-ref>
  <nsd:vnf-depends-on-ref>STRING</nsd:vnf-depends-on-ref>
</nsd:vnf-dependency>

XML Sample

<nsd:vnf-dependency xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:vnf-source-ref>STRING</nsd:vnf-source-ref>
  <nsd:vnf-depends-on-ref>STRING</nsd:vnf-depends-on-ref>
</nsd:vnf-dependency>

nsd:monitoring-param

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING

Fields

Name	Type	Description
id	STRING
name	STRING
value-type	ENUM
numeric-constraints	CONTAINER
text-constraints	CONTAINER
value-integer	INT64	Current value for an integer parameter
value-decimal	DECIMAL64	Current value for a decimal parameter
value-string	STRING	Current value for a string parameter
description	STRING
group-tag	STRING	A tag to group monitoring parameters
widget-type	ENUM	Defines the UI Display variant of measured counters.
units	STRING	Measured Counter Units (e.g., Packets, Kbps, Mbps, etc.)
aggregation-type	ENUM
vnfd-monitoring-param	LIST	A list of VNFD monitoring params

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "aggregation-type": "AVERAGE",
    "vnfd-monitoring-param": [
      {
        "vnfd-id-ref": "STRING",
        "vnfd-monitoring-param-ref": "STRING",
        "member-vnf-index-ref": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "value-type": "INT",
    "numeric-constraints": {
      "min-value": 0,
      "max-value": 0
    },
    "text-constraints": {
      "min-length": 0,
      "max-length": 0
    },
    "value-integer": 0,
    "value-decimal": 0.0,
    "value-string": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "COUNTER",
    "units": "STRING",
    "aggregation-type": "AVERAGE",
    "vnfd-monitoring-param": [
      {
        "vnfd-id-ref": "STRING",
        "vnfd-monitoring-param-ref": "STRING",
        "member-vnf-index-ref": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:monitoring-param xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:value-type>INT</nsd:value-type>
  <nsd:numeric-constraints>
    <nsd:min-value>0</nsd:min-value>
    <nsd:max-value>0</nsd:max-value>
  </nsd:numeric-constraints>
  <nsd:text-constraints>
    <nsd:min-length>0</nsd:min-length>
    <nsd:max-length>0</nsd:max-length>
  </nsd:text-constraints>
  <nsd:value-integer>0</nsd:value-integer>
  <nsd:value-decimal>0.0</nsd:value-decimal>
  <nsd:value-string>STRING</nsd:value-string>
  <nsd:description>STRING</nsd:description>
  <nsd:group-tag>STRING</nsd:group-tag>
  <nsd:widget-type>COUNTER</nsd:widget-type>
  <nsd:units>STRING</nsd:units>
  <nsd:aggregation-type>AVERAGE</nsd:aggregation-type>
  <nsd:vnfd-monitoring-param>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-monitoring-param-ref>STRING</nsd:vnfd-monitoring-param-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  </nsd:vnfd-monitoring-param>
</nsd:monitoring-param>

XML Sample

<nsd:monitoring-param xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:id>STRING</nsd:id>
  <nsd:name>STRING</nsd:name>
  <nsd:value-type>INT</nsd:value-type>
  <nsd:numeric-constraints>
    <nsd:min-value>0</nsd:min-value>
    <nsd:max-value>0</nsd:max-value>
  </nsd:numeric-constraints>
  <nsd:text-constraints>
    <nsd:min-length>0</nsd:min-length>
    <nsd:max-length>0</nsd:max-length>
  </nsd:text-constraints>
  <nsd:value-integer>0</nsd:value-integer>
  <nsd:value-decimal>0.0</nsd:value-decimal>
  <nsd:value-string>STRING</nsd:value-string>
  <nsd:description>STRING</nsd:description>
  <nsd:group-tag>STRING</nsd:group-tag>
  <nsd:widget-type>COUNTER</nsd:widget-type>
  <nsd:units>STRING</nsd:units>
  <nsd:aggregation-type>AVERAGE</nsd:aggregation-type>
  <nsd:vnfd-monitoring-param>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-monitoring-param-ref>STRING</nsd:vnfd-monitoring-param-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  </nsd:vnfd-monitoring-param>
</nsd:monitoring-param>

nsd:numeric-constraints

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:numeric-constraints

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:numeric-constraints

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/numeric-constraints

Fields

Name	Type	Description
min-value	UINT64	Minimum value for the parameter
max-value	UINT64	Maximum value for the parameter

JSON Config Sample

{
  "min-value": 0,
  "max-value": 0
}

JSON Sample

{
  "min-value": 0,
  "max-value": 0
}

XML Config Sample

<nsd:numeric-constraints xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:min-value>0</nsd:min-value>
  <nsd:max-value>0</nsd:max-value>
</nsd:numeric-constraints>

XML Sample

<nsd:numeric-constraints xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:min-value>0</nsd:min-value>
  <nsd:max-value>0</nsd:max-value>
</nsd:numeric-constraints>

nsd:text-constraints

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:text-constraints

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:text-constraints

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/text-constraints

Fields

Name	Type	Description
min-length	UINT8	Minimum string length for the parameter
max-length	UINT8	Maximum string length for the parameter

JSON Config Sample

{
  "min-length": 0,
  "max-length": 0
}

JSON Sample

{
  "min-length": 0,
  "max-length": 0
}

XML Config Sample

<nsd:text-constraints xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:min-length>0</nsd:min-length>
  <nsd:max-length>0</nsd:max-length>
</nsd:text-constraints>

XML Sample

<nsd:text-constraints xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:min-length>0</nsd:min-length>
  <nsd:max-length>0</nsd:max-length>
</nsd:text-constraints>

nsd:vnfd-monitoring-param

A list of VNFD monitoring params

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:monitoring-param/nsd:vnfd-monitoring-param

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:monitoring-param[nsd:id='STRING']/nsd:vnfd-monitoring-param[nsd:member-vnf-index-ref='0'][nsd:vnfd-monitoring-param-ref='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/monitoring-param/STRING/vnfd-monitoring-param/0,STRING

Fields

Name	Type	Description
vnfd-id-ref	LEAFREF	A reference to a VNFD. This is a leafref
vnfd-monitoring-param-ref	LEAFREF	A reference to the VNFD monitoring param
member-vnf-index-ref	LEAFREF	Mandatory reference to member-vnf within constituent-vnfds

JSON Config Sample

[
  {
    "vnfd-id-ref": "STRING",
    "vnfd-monitoring-param-ref": "STRING",
    "member-vnf-index-ref": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfd-id-ref": "STRING",
    "vnfd-monitoring-param-ref": "STRING",
    "member-vnf-index-ref": 0
  }, {
    ...
  }
]

XML Config Sample

<nsd:vnfd-monitoring-param xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-monitoring-param-ref>STRING</nsd:vnfd-monitoring-param-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
</nsd:vnfd-monitoring-param>

XML Sample

<nsd:vnfd-monitoring-param xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-monitoring-param-ref>STRING</nsd:vnfd-monitoring-param-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
</nsd:vnfd-monitoring-param>

nsd:service-primitive

Network service level service primitives.

Key Identifiers:

XPath Path	/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive
XPath Keyed Path	/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']
RW.REST URI Path	/nsd:nsd-catalog/nsd/STRING/service-primitive/STRING

Fields

Name	Type	Description
name	STRING	Name of the service primitive.
parameter	LIST	List of parameters for the service primitive.
parameter-group	LIST	Grouping of parameters which are logically grouped in UI
vnf-primitive-group	LIST	List of service primitives grouped by VNF.
user-defined-script	STRING	A user defined script.

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "mandatory": true
      }, {
        ...
      }
    ],
    "vnf-primitive-group": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-name": "STRING",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "mandatory": true
      }, {
        ...
      }
    ],
    "vnf-primitive-group": [
      {
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfd-name": "STRING",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "user-defined-script": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:service-primitive xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:parameter>
    <nsd:name>STRING</nsd:name>
    <nsd:data-type>STRING</nsd:data-type>
    <nsd:mandatory>false</nsd:mandatory>
    <nsd:default-value>STRING</nsd:default-value>
    <nsd:parameter-pool>STRING</nsd:parameter-pool>
    <nsd:read-only>false</nsd:read-only>
    <nsd:hidden>false</nsd:hidden>
  </nsd:parameter>
  <nsd:parameter-group>
    <nsd:name>STRING</nsd:name>
    <nsd:parameter>...</nsd:parameter>
    <nsd:mandatory>true</nsd:mandatory>
  </nsd:parameter-group>
  <nsd:vnf-primitive-group>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
    <nsd:vnfd-name>STRING</nsd:vnfd-name>
    <nsd:primitive>...</nsd:primitive>
  </nsd:vnf-primitive-group>
  <nsd:user-defined-script>STRING</nsd:user-defined-script>
</nsd:service-primitive>

XML Sample

<nsd:service-primitive xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:parameter>
    <nsd:name>STRING</nsd:name>
    <nsd:data-type>STRING</nsd:data-type>
    <nsd:mandatory>false</nsd:mandatory>
    <nsd:default-value>STRING</nsd:default-value>
    <nsd:parameter-pool>STRING</nsd:parameter-pool>
    <nsd:read-only>false</nsd:read-only>
    <nsd:hidden>false</nsd:hidden>
  </nsd:parameter>
  <nsd:parameter-group>
    <nsd:name>STRING</nsd:name>
    <nsd:parameter>...</nsd:parameter>
    <nsd:mandatory>true</nsd:mandatory>
  </nsd:parameter-group>
  <nsd:vnf-primitive-group>
    <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
    <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
    <nsd:vnfd-name>STRING</nsd:vnfd-name>
    <nsd:primitive>...</nsd:primitive>
  </nsd:vnf-primitive-group>
  <nsd:user-defined-script>STRING</nsd:user-defined-script>
</nsd:service-primitive>

nsd:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
data-type	ENUM	Data type associated with the name.
mandatory	BOOLEAN	Is this field mandatory
default-value	STRING	The default value for this field
parameter-pool	STRING	NSD parameter pool name to use for this parameter
read-only	BOOLEAN	The value should be dimmed by the UI. Only applies to parameters with default values.
hidden	BOOLEAN	The value should be hidden by the UI. Only applies to parameters with default values.

JSON Config Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Config Sample

<nsd:parameter xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:data-type>STRING</nsd:data-type>
  <nsd:mandatory>false</nsd:mandatory>
  <nsd:default-value>STRING</nsd:default-value>
  <nsd:parameter-pool>STRING</nsd:parameter-pool>
  <nsd:read-only>false</nsd:read-only>
  <nsd:hidden>false</nsd:hidden>
</nsd:parameter>

XML Sample

<nsd:parameter xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:data-type>STRING</nsd:data-type>
  <nsd:mandatory>false</nsd:mandatory>
  <nsd:default-value>STRING</nsd:default-value>
  <nsd:parameter-pool>STRING</nsd:parameter-pool>
  <nsd:read-only>false</nsd:read-only>
  <nsd:hidden>false</nsd:hidden>
</nsd:parameter>

nsd:parameter-group

Grouping of parameters which are logically grouped in UI

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter-group

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter-group[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter group
parameter	LIST	List of parameters for the service primitive.
mandatory	BOOLEAN	Is this parameter group mandatory

JSON Config Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "mandatory": true
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": false,
        "hidden": false
      }, {
        ...
      }
    ],
    "mandatory": true
  }, {
    ...
  }
]

XML Config Sample

<nsd:parameter-group xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:parameter>
    <nsd:name>STRING</nsd:name>
    <nsd:data-type>STRING</nsd:data-type>
    <nsd:mandatory>false</nsd:mandatory>
    <nsd:default-value>STRING</nsd:default-value>
    <nsd:parameter-pool>STRING</nsd:parameter-pool>
    <nsd:read-only>false</nsd:read-only>
    <nsd:hidden>false</nsd:hidden>
  </nsd:parameter>
  <nsd:mandatory>true</nsd:mandatory>
</nsd:parameter-group>

XML Sample

<nsd:parameter-group xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:parameter>
    <nsd:name>STRING</nsd:name>
    <nsd:data-type>STRING</nsd:data-type>
    <nsd:mandatory>false</nsd:mandatory>
    <nsd:default-value>STRING</nsd:default-value>
    <nsd:parameter-pool>STRING</nsd:parameter-pool>
    <nsd:read-only>false</nsd:read-only>
    <nsd:hidden>false</nsd:hidden>
  </nsd:parameter>
  <nsd:mandatory>true</nsd:mandatory>
</nsd:parameter-group>

nsd:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:parameter-group/nsd:parameter

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:parameter-group[nsd:name='STRING']/nsd:parameter[nsd:name='STRING']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
data-type	ENUM	Data type associated with the name.
mandatory	BOOLEAN	Is this field mandatory
default-value	STRING	The default value for this field
parameter-pool	STRING	NSD parameter pool name to use for this parameter
read-only	BOOLEAN	The value should be dimmed by the UI. Only applies to parameters with default values.
hidden	BOOLEAN	The value should be hidden by the UI. Only applies to parameters with default values.

JSON Config Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "data-type": "STRING",
    "mandatory": false,
    "default-value": "STRING",
    "parameter-pool": "STRING",
    "read-only": false,
    "hidden": false
  }, {
    ...
  }
]

XML Config Sample

<nsd:parameter xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:data-type>STRING</nsd:data-type>
  <nsd:mandatory>false</nsd:mandatory>
  <nsd:default-value>STRING</nsd:default-value>
  <nsd:parameter-pool>STRING</nsd:parameter-pool>
  <nsd:read-only>false</nsd:read-only>
  <nsd:hidden>false</nsd:hidden>
</nsd:parameter>

XML Sample

<nsd:parameter xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:name>STRING</nsd:name>
  <nsd:data-type>STRING</nsd:data-type>
  <nsd:mandatory>false</nsd:mandatory>
  <nsd:default-value>STRING</nsd:default-value>
  <nsd:parameter-pool>STRING</nsd:parameter-pool>
  <nsd:read-only>false</nsd:read-only>
  <nsd:hidden>false</nsd:hidden>
</nsd:parameter>

nsd:vnf-primitive-group

List of service primitives grouped by VNF.

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:vnf-primitive-group

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:vnf-primitive-group[nsd:member-vnf-index-ref='0']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/vnf-primitive-group/0

Fields

Name	Type	Description
member-vnf-index-ref	LEAFREF	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	LEAFREF	A reference to a VNFD. This is a leafref
vnfd-name	LEAFREF	Name of the VNFD
primitive	LIST

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-name": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfd-name": "STRING",
    "primitive": [
      {
        "index": 0,
        "name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsd:vnf-primitive-group xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  <nsd:vnfd-name>STRING</nsd:vnfd-name>
  <nsd:primitive>
    <nsd:index>0</nsd:index>
    <nsd:name>STRING</nsd:name>
  </nsd:primitive>
</nsd:vnf-primitive-group>

XML Sample

<nsd:vnf-primitive-group xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:member-vnf-index-ref>0</nsd:member-vnf-index-ref>
  <nsd:vnfd-id-ref>STRING</nsd:vnfd-id-ref>
  <nsd:vnfd-name>STRING</nsd:vnfd-name>
  <nsd:primitive>
    <nsd:index>0</nsd:index>
    <nsd:name>STRING</nsd:name>
  </nsd:primitive>
</nsd:vnf-primitive-group>

nsd:primitive

Key Identifiers:

XPath Path

/nsd:nsd-catalog/nsd:nsd/nsd:service-primitive/nsd:vnf-primitive-group/nsd:primitive

XPath Keyed Path

/nsd:nsd-catalog/nsd:nsd[nsd:id='STRING']/nsd:service-primitive[nsd:name='STRING']/nsd:vnf-primitive-group[nsd:member-vnf-index-ref='0']/nsd:primitive[nsd:index='0']

RW.REST URI Path

/nsd:nsd-catalog/nsd/STRING/service-primitive/STRING/vnf-primitive-group/0/primitive/0

Fields

Name	Type	Description
index	UINT32	Index of this primitive
name	STRING	Name of the primitive in the VNF primitive

JSON Config Sample

[
  {
    "index": 0,
    "name": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "index": 0,
    "name": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsd:primitive xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:index>0</nsd:index>
  <nsd:name>STRING</nsd:name>
</nsd:primitive>

XML Sample

<nsd:primitive xmlns:nsd="urn:ietf:params:xml:ns:yang:nfvo:nsd">
  <nsd:index>0</nsd:index>
  <nsd:name>STRING</nsd:name>
</nsd:primitive>