nsr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwNsr_Nsr_t_schema
Global Schema Pointer	rw_ypbc_RwNsr_Nsr_g_schema

nsr data

nsr:key-pair

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

Key Identifiers:

XPath Path	/nsr:key-pair
XPath Keyed Path	/nsr:key-pair[nsr:name='STRING']
RW.REST URI Path	/nsr: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

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

XML Sample

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

nsr:ns-instance-config

Key Identifiers:

XPath Path	/nsr:ns-instance-config
XPath Keyed Path	/nsr:ns-instance-config
RW.REST URI Path	/nsr:ns-instance-config

Fields

Name	Type	Description
nsr	LIST
nfvi-polling-period	UINT64	Defines the period (secons) that the NFVI metrics are polled at

JSON Config Sample

{
  "nsr": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "description": "STRING",
      "admin-status": "ENABLED",
      "nsd": { ... },
      "input-parameter": [ { ... }, { ... } ],
      "scaling-group": [ { ... }, { ... } ],
      "nsd-placement-group-maps": [ { ... }, { ... } ],
      "vnfd-placement-group-maps": [ { ... }, { ... } ],
      "ssh-authorized-key": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ],
      "rw-nsr:cloud-account": "STRING",
      "rw-nsr:om-datacenter": "STRING",
      "rw-nsr:vnf-cloud-account-map": [ { ... }, { ... } ],
      "rw-nsr:vl-cloud-account-map": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "rw-nsr:nfvi-polling-period": 4
}

JSON Sample

{
  "nsr": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "description": "STRING",
      "admin-status": "ENABLED",
      "nsd": { ... },
      "input-parameter": [ { ... }, { ... } ],
      "scaling-group": [ { ... }, { ... } ],
      "nsd-placement-group-maps": [ { ... }, { ... } ],
      "vnfd-placement-group-maps": [ { ... }, { ... } ],
      "ssh-authorized-key": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ],
      "rw-nsr:cloud-account": "STRING",
      "rw-nsr:om-datacenter": "STRING",
      "rw-nsr:vnf-cloud-account-map": [ { ... }, { ... } ],
      "rw-nsr:vl-cloud-account-map": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "rw-nsr:nfvi-polling-period": 4
}

XML Config Sample

<nsr:ns-instance-config xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:description>STRING</nsr:description>
    <nsr:admin-status>ENABLED</nsr:admin-status>
    <nsr:nsd>...</nsr:nsd>
    <nsr:input-parameter>...</nsr:input-parameter>
    <nsr:scaling-group>...</nsr:scaling-group>
    <nsr:nsd-placement-group-maps>...</nsr:nsd-placement-group-maps>
    <nsr:vnfd-placement-group-maps>...</nsr:vnfd-placement-group-maps>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
    <nsr:user>...</nsr:user>
    <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
    <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
    <rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:vnf-cloud-account-map>
    <rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:vl-cloud-account-map>
  </nsr:nsr>
  <rw-nsr:nfvi-polling-period xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">4</rw-nsr:nfvi-polling-period>
</nsr:ns-instance-config>

XML Sample

<nsr:ns-instance-config xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:description>STRING</nsr:description>
    <nsr:admin-status>ENABLED</nsr:admin-status>
    <nsr:nsd>...</nsr:nsd>
    <nsr:input-parameter>...</nsr:input-parameter>
    <nsr:scaling-group>...</nsr:scaling-group>
    <nsr:nsd-placement-group-maps>...</nsr:nsd-placement-group-maps>
    <nsr:vnfd-placement-group-maps>...</nsr:vnfd-placement-group-maps>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
    <nsr:user>...</nsr:user>
    <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
    <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
    <rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:vnf-cloud-account-map>
    <rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:vl-cloud-account-map>
  </nsr:nsr>
  <rw-nsr:nfvi-polling-period xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">4</rw-nsr:nfvi-polling-period>
</nsr:ns-instance-config>

nsr:nsr

Key Identifiers:

XPath Path	/nsr:ns-instance-config/nsr:nsr
XPath Keyed Path	/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']
RW.REST URI Path	/nsr:ns-instance-config/nsr/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the NSR.
name	STRING	NSR name.
short-name	STRING	NSR short name.
description	STRING	NSR description.
admin-status	ENUM	This is the administrative status of the NS instance
nsd	CONTAINER	NS descriptor used to instantiate this NS
input-parameter	LIST	List of input parameters
scaling-group	LIST	List of ns scaling group instances
nsd-placement-group-maps	LIST	Mapping from mano-placement groups construct from NSD to cloud platform placement group construct
vnfd-placement-group-maps	LIST	Mapping from mano-placement groups construct from VNFD to cloud platform placement group construct
ssh-authorized-key	LIST	List of authorized ssh keys as part of cloud-config
user	LIST	List of users to be added through cloud-config
cloud-account	LEAFREF	The configured cloud account which the NSR is instantiated within. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance
om-datacenter	STRING	Openmano datacenter name to use when instantiating the network service. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.
vnf-cloud-account-map	LIST	Mapping VNF to Cloud Account where VNF will be instantiated
vl-cloud-account-map	LIST	Mapping VL to Cloud Account where VL will be instantiated

JSON Config Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "description": "STRING",
    "admin-status": "ENABLED",
    "nsd": {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "connection-point": [ { ... }, { ... } ],
      "vld": [ { ... }, { ... } ],
      "constituent-vnfd": [ { ... }, { ... } ],
      "scaling-group-descriptor": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "vnf-dependency": [ { ... }, { ... } ],
      "vnffgd": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "input-parameter-xpath": [ { ... }, { ... } ],
      "parameter-pool": [ { ... }, { ... } ],
      "service-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ],
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ]
    },
    "input-parameter": [
      {
        "xpath": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "scaling-group": [
      {
        "scaling-group-name-ref": "STRING",
        "instance": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "nsd-placement-group-maps": [
      {
        "placement-group-ref": "STRING",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "vnfd-placement-group-maps": [
      {
        "vnfd-id-ref": "STRING",
        "placement-group-ref": "STRING",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "ssh-authorized-key": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "rw-nsr:cloud-account": "STRING",
    "rw-nsr:om-datacenter": "STRING",
    "rw-nsr:vnf-cloud-account-map": [
      {
        "member-vnf-index-ref": 0,
        "cloud-account": "STRING",
        "om-datacenter": "STRING",
        "config-agent-account": "STRING"
      }, {
        ...
      }
    ],
    "rw-nsr:vl-cloud-account-map": [
      {
        "vld-id-ref": "STRING",
        "cloud-accounts": [ "STRING", ... ],
        "om-datacenters": [ "STRING", ... ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "description": "STRING",
    "admin-status": "ENABLED",
    "nsd": {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "connection-point": [ { ... }, { ... } ],
      "vld": [ { ... }, { ... } ],
      "constituent-vnfd": [ { ... }, { ... } ],
      "scaling-group-descriptor": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "vnf-dependency": [ { ... }, { ... } ],
      "vnffgd": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "input-parameter-xpath": [ { ... }, { ... } ],
      "parameter-pool": [ { ... }, { ... } ],
      "service-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ],
      "key-pair": [ { ... }, { ... } ],
      "user": [ { ... }, { ... } ]
    },
    "input-parameter": [
      {
        "xpath": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "scaling-group": [
      {
        "scaling-group-name-ref": "STRING",
        "instance": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "nsd-placement-group-maps": [
      {
        "placement-group-ref": "STRING",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "vnfd-placement-group-maps": [
      {
        "vnfd-id-ref": "STRING",
        "placement-group-ref": "STRING",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ],
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ],
    "user": [
      {
        "name": "STRING",
        "user-info": "STRING",
        "ssh-authorized-key": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "rw-nsr:cloud-account": "STRING",
    "rw-nsr:om-datacenter": "STRING",
    "rw-nsr:vnf-cloud-account-map": [
      {
        "member-vnf-index-ref": 0,
        "cloud-account": "STRING",
        "om-datacenter": "STRING",
        "config-agent-account": "STRING"
      }, {
        ...
      }
    ],
    "rw-nsr:vl-cloud-account-map": [
      {
        "vld-id-ref": "STRING",
        "cloud-accounts": [ "STRING", ... ],
        "om-datacenters": [ "STRING", ... ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:nsr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:description>STRING</nsr:description>
  <nsr:admin-status>ENABLED</nsr:admin-status>
  <nsr:nsd>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:vendor>STRING</nsr:vendor>
    <nsr:logo>STRING</nsr:logo>
    <nsr:description>STRING</nsr:description>
    <nsr:version>STRING</nsr:version>
    <nsr:connection-point>...</nsr:connection-point>
    <nsr:vld>...</nsr:vld>
    <nsr:constituent-vnfd>...</nsr:constituent-vnfd>
    <nsr:scaling-group-descriptor>...</nsr:scaling-group-descriptor>
    <nsr:placement-groups>...</nsr:placement-groups>
    <nsr:ip-profiles>...</nsr:ip-profiles>
    <nsr:vnf-dependency>...</nsr:vnf-dependency>
    <nsr:vnffgd>...</nsr:vnffgd>
    <nsr:monitoring-param>...</nsr:monitoring-param>
    <nsr:input-parameter-xpath>...</nsr:input-parameter-xpath>
    <nsr:parameter-pool>...</nsr:parameter-pool>
    <nsr:service-primitive>...</nsr:service-primitive>
    <nsr:initial-config-primitive>...</nsr:initial-config-primitive>
    <nsr:key-pair>...</nsr:key-pair>
    <nsr:user>...</nsr:user>
  </nsr:nsd>
  <nsr:input-parameter>
    <nsr:xpath>STRING</nsr:xpath>
    <nsr:value>STRING</nsr:value>
  </nsr:input-parameter>
  <nsr:scaling-group>
    <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
    <nsr:instance>...</nsr:instance>
  </nsr:scaling-group>
  <nsr:nsd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:nsd-placement-group-maps>
  <nsr:vnfd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:vnfd-placement-group-maps>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
  </nsr:user>
  <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
  <rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:member-vnf-index-ref>0</rw-nsr:member-vnf-index-ref>
    <rw-nsr:cloud-account>STRING</rw-nsr:cloud-account>
    <rw-nsr:om-datacenter>STRING</rw-nsr:om-datacenter>
    <rw-nsr:config-agent-account>STRING</rw-nsr:config-agent-account>
  </rw-nsr:vnf-cloud-account-map>
  <rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:vld-id-ref>STRING</rw-nsr:vld-id-ref>
    <rw-nsr:cloud-accounts>STRING</rw-nsr:cloud-accounts>
    <rw-nsr:cloud-accounts>...</rw-nsr:cloud-accounts>
    <rw-nsr:om-datacenters>STRING</rw-nsr:om-datacenters>
    <rw-nsr:om-datacenters>...</rw-nsr:om-datacenters>
  </rw-nsr:vl-cloud-account-map>
</nsr:nsr>

XML Sample

<nsr:nsr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:short-name>STRING</nsr:short-name>
  <nsr:description>STRING</nsr:description>
  <nsr:admin-status>ENABLED</nsr:admin-status>
  <nsr:nsd>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:short-name>STRING</nsr:short-name>
    <nsr:vendor>STRING</nsr:vendor>
    <nsr:logo>STRING</nsr:logo>
    <nsr:description>STRING</nsr:description>
    <nsr:version>STRING</nsr:version>
    <nsr:connection-point>...</nsr:connection-point>
    <nsr:vld>...</nsr:vld>
    <nsr:constituent-vnfd>...</nsr:constituent-vnfd>
    <nsr:scaling-group-descriptor>...</nsr:scaling-group-descriptor>
    <nsr:placement-groups>...</nsr:placement-groups>
    <nsr:ip-profiles>...</nsr:ip-profiles>
    <nsr:vnf-dependency>...</nsr:vnf-dependency>
    <nsr:vnffgd>...</nsr:vnffgd>
    <nsr:monitoring-param>...</nsr:monitoring-param>
    <nsr:input-parameter-xpath>...</nsr:input-parameter-xpath>
    <nsr:parameter-pool>...</nsr:parameter-pool>
    <nsr:service-primitive>...</nsr:service-primitive>
    <nsr:initial-config-primitive>...</nsr:initial-config-primitive>
    <nsr:key-pair>...</nsr:key-pair>
    <nsr:user>...</nsr:user>
  </nsr:nsd>
  <nsr:input-parameter>
    <nsr:xpath>STRING</nsr:xpath>
    <nsr:value>STRING</nsr:value>
  </nsr:input-parameter>
  <nsr:scaling-group>
    <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
    <nsr:instance>...</nsr:instance>
  </nsr:scaling-group>
  <nsr:nsd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:nsd-placement-group-maps>
  <nsr:vnfd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:vnfd-placement-group-maps>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
  </nsr:user>
  <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
  <rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:member-vnf-index-ref>0</rw-nsr:member-vnf-index-ref>
    <rw-nsr:cloud-account>STRING</rw-nsr:cloud-account>
    <rw-nsr:om-datacenter>STRING</rw-nsr:om-datacenter>
    <rw-nsr:config-agent-account>STRING</rw-nsr:config-agent-account>
  </rw-nsr:vnf-cloud-account-map>
  <rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:vld-id-ref>STRING</rw-nsr:vld-id-ref>
    <rw-nsr:cloud-accounts>STRING</rw-nsr:cloud-accounts>
    <rw-nsr:cloud-accounts>...</rw-nsr:cloud-accounts>
    <rw-nsr:om-datacenters>STRING</rw-nsr:om-datacenters>
    <rw-nsr:om-datacenters>...</rw-nsr:om-datacenters>
  </rw-nsr:vl-cloud-account-map>
</nsr:nsr>

nsr:nsd

NS descriptor used to instantiate this NS

Key Identifiers:

XPath Path	/nsr:ns-instance-config/nsr:nsr/nsr:nsd
XPath Keyed Path	/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd
RW.REST URI Path	/nsr:ns-instance-config/nsr/STRING/nsd

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 network service (NS) has one or more external connection points that connect the NS to other NSs or to external networks. Each NS exposes connection points to the orchestrator, which can construct network service chains by connecting the connection points between different NSs.
vld	LIST	List of Virtual Link Descriptors (VLDs).
constituent-vnfd	LIST	List of VNFDs that are part of this network service.
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
placement-groups	LIST	List of placement groups at NS level
ip-profiles	LIST	List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
vnf-dependency	LIST	List of VNF dependencies.
vnffgd	LIST	List of VNF Forwarding Graph Descriptors (VNFFGD).
monitoring-param	LIST	List of monitoring parameters from VNFs that should be propogated up into NSR
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 from which to choose during configuration.
service-primitive	LIST	Network service level service primitives.
initial-config-primitive	LIST	Initial set of configuration primitives for NSD.
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

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:connection-point

List for external connection points. Each network service (NS) has one or more external connection points that connect the NS to other NSs or to external networks. Each NS exposes connection points to the orchestrator, which can construct network service chains by connecting the connection points between different NSs.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:connection-point

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:connection-point[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:vld

List of Virtual Link Descriptors (VLDs).

Key Identifiers:

XPath Path	/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vld
XPath Keyed Path	/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vld[nsr:id='STRING']
RW.REST URI Path	/nsr:ns-instance-config/nsr/STRING/nsd/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.
vnfd-connection-point-ref	LIST	A list of references to connection points.
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

JSON Config Sample

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

XML Config Sample

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

XML Sample

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

nsr:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vld/nsr:vnfd-connection-point-ref

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vld[nsr:id='STRING']/nsr:vnfd-connection-point-ref[nsr:member-vnf-index-ref='0'][nsr:vnfd-connection-point-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vld/nsr:provider-network

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vld[nsr:id='STRING']/nsr:provider-network

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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
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

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

XML Sample

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

nsr:constituent-vnfd

List of VNFDs that are part of this network service.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:constituent-vnfd

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:constituent-vnfd[nsr:member-vnf-index='0']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/constituent-vnfd/0

Fields

Name	Type	Description
member-vnf-index	UINT64	Identifier/index for the VNFD. This separate id is required so 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

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

XML Sample

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

nsr: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

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:scaling-group-descriptor[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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 number of instances of the scaling group that are allowed in a single network service. These instances are created by default when the network service is instantiated.
max-instance-count	UINT32	Maximum number of instances of this scaling group that are allowed in a single network service. The network service scaling fails when the number of service group instances exceeds 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-config-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-config-primitive-name-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

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

XML Sample

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

nsr:scaling-policy

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor/nsr:scaling-policy

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:scaling-group-descriptor[nsr:name='STRING']/nsr:scaling-policy[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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. Defaults 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 scaling activity
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

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

XML Sample

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

nsr:scaling-criteria

list of conditions to be met for generating scaling requests

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor/nsr:scaling-policy/nsr:scaling-criteria

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:scaling-group-descriptor[nsr:name='STRING']/nsr:scaling-policy[nsr:name='STRING']/nsr:scaling-criteria[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/scaling-group-descriptor/STRING/scaling-policy/STRING/scaling-criteria/STRING

Fields

Name	Type	Description
name	STRING	Name of the scaling criteria
scale-in-threshold	UINT64	Value below which scale-in requests are generated (depends on monitoring parameters)
scale-out-threshold	UINT64	Value above which scale-out requests are generated (depends on monitoring parameters)
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

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

XML Sample

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

nsr:vnfd-member

List of VNFs in this scaling group

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor/nsr:vnfd-member

XPath Keyed Path

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

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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 defines 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

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

XML Sample

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

nsr:scaling-config-action

List of scaling config actions

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:scaling-group-descriptor/nsr:scaling-config-action

XPath Keyed Path

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

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/scaling-group-descriptor/STRING/scaling-config-action/pre-scale-in

Fields

Name	Type	Description
trigger	ENUM	Scaling trigger
ns-config-primitive-name-ref	LEAFREF	Reference to the NS config name primitive

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:placement-groups

List of placement groups at NS level

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:placement-groups

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:placement-groups[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:member-vnfd

List of VNFDs that are part of this placement group

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:placement-groups/nsr:member-vnfd

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:placement-groups[nsr:name='STRING']/nsr:member-vnfd[nsr:member-vnf-index-ref='0']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:ip-profiles

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

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:ip-profiles

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:ip-profiles[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:ip-profile-params

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:ip-profiles/nsr:ip-profile-params

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:ip-profiles[nsr:name='STRING']/nsr:ip-profile-params

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:dns-server

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:ip-profiles/nsr:ip-profile-params/nsr:dns-server

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:ip-profiles[nsr:name='STRING']/nsr:ip-profile-params/nsr:dns-server[nsr:address='UNION_VALUE']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:dhcp-params

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:ip-profiles/nsr:ip-profile-params/nsr:dhcp-params

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:ip-profiles[nsr:name='STRING']/nsr:ip-profile-params/nsr:dhcp-params

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:vnf-dependency

List of VNF dependencies.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnf-dependency

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnf-dependency[nsr:vnf-source-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/vnf-dependency/STRING

Fields

Name	Type	Description
vnf-source-ref	LEAFREF
vnf-depends-on-ref	LEAFREF	Reference to VNF on which the source 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

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

XML Sample

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

nsr:vnffgd

List of VNF Forwarding Graph Descriptors (VNFFGD).

Key Identifiers:

XPath Path	/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd
XPath Keyed Path	/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']
RW.REST URI Path	/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:rsp

List of Rendered Service Paths (RSP).

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd/nsr:rsp

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:vnfd-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd/nsr:rsp/nsr:vnfd-connection-point-ref

XPath Keyed Path

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

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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
vnfd-connection-point-ref	LEAFREF	A reference to a connection point name

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

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

XML Sample

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

nsr:classifier

List of classifier rules.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd/nsr:classifier

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']/nsr:classifier[nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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
vnfd-connection-point-ref	LEAFREF	A reference to a connection point name
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

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

XML Sample

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

nsr:match-attributes

List of match attributes.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:vnffgd/nsr:classifier/nsr:match-attributes

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:vnffgd[nsr:id='STRING']/nsr:classifier[nsr:id='STRING']/nsr:match-attributes[nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/vnffgd/STRING/classifier/STRING/match-attributes/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the classifier match attribute rule.
ip-proto	UINT8	Internet 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

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

XML Sample

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

nsr:monitoring-param

List of monitoring parameters from VNFs that should be propogated up into NSR

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:monitoring-param

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:monitoring-param[nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/monitoring-param/STRING

Fields

Name	Type	Description
id	STRING	Identifier for a monitoring parameter
name	STRING	Name of the monitoring parameter
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": "HISTOGRAM",
    "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": "HISTOGRAM",
    "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

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

XML Sample

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

nsr:numeric-constraints

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:monitoring-param/nsr:numeric-constraints

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:monitoring-param[nsr:id='STRING']/nsr:numeric-constraints

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:text-constraints

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:monitoring-param/nsr:text-constraints

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:monitoring-param[nsr:id='STRING']/nsr:text-constraints

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:vnfd-monitoring-param

A list of VNFD monitoring params

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:monitoring-param/nsr:vnfd-monitoring-param

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:monitoring-param[nsr:id='STRING']/nsr:vnfd-monitoring-param[nsr:member-vnf-index-ref='0'][nsr:vnfd-monitoring-param-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:input-parameter-xpath

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

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:input-parameter-xpath

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:input-parameter-xpath[nsr:xpath='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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	/nsd:nsd-catalog/nsd:nsd/nsd:vendor

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:parameter-pool

Pool of parameter values from which to choose during configuration.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:parameter-pool

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:parameter-pool[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/parameter-pool/STRING

Fields

Name	Type	Description
name	STRING	Name of the configuration value pool
range	CONTAINER	Create a range of values from which 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

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

XML Sample

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

nsr:range

Create a range of values from which to populate the pool with

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:parameter-pool/nsr:range

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:parameter-pool[nsr:name='STRING']/nsr:range

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:service-primitive

Network service level service primitives.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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": true,
        "hidden": true
      }, {
        ...
      }
    ],
    "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": true,
        "hidden": true
      }, {
        ...
      }
    ],
    "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

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

XML Sample

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

nsr:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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": true,
    "hidden": true
  }, {
    ...
  }
]

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:parameter-group

Grouping of parameters which are logically grouped in UI

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:parameter-group

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:parameter-group[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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": true,
        "hidden": true
      }, {
        ...
      }
    ],
    "mandatory": true
  }, {
    ...
  }
]

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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": true,
    "hidden": true
  }, {
    ...
  }
]

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:vnf-primitive-group

List of service primitives grouped by VNF.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:vnf-primitive-group

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:primitive

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:service-primitive/nsr:vnf-primitive-group/nsr:primitive

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:service-primitive[nsr:name='STRING']/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']/nsr:primitive[nsr:index='0']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:initial-config-primitive

Initial set of configuration primitives for NSD.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:initial-config-primitive

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:initial-config-primitive[nsr:seq='0']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/initial-config-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

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

XML Sample

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

nsr:parameter

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:initial-config-primitive/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:initial-config-primitive[nsr:seq='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/initial-config-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

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

XML Sample

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

nsr:key-pair

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

Key Identifiers:

XPath Path	/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:key-pair
XPath Keyed Path	/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:key-pair[nsr:name='STRING']
RW.REST URI Path	/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:user

List of users to be added through cloud-config

Key Identifiers:

XPath Path	/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:user
XPath Keyed Path	/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:user[nsr:name='STRING']
RW.REST URI Path	/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:key-pair

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

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd/nsr:user/nsr:key-pair

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd/nsr:user[nsr:name='STRING']/nsr:key-pair[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd/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

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

XML Sample

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

nsr:input-parameter

List of input parameters

Key Identifiers:

XPath Path	/nsr:ns-instance-config/nsr:nsr/nsr:input-parameter
XPath Keyed Path	/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:input-parameter[nsr:xpath='STRING']
RW.REST URI Path	/nsr:ns-instance-config/nsr/STRING/input-parameter/STRING

Fields

Name	Type	Description
xpath	STRING	An xpath that specfies which element in a descriptor is to be modified.
value	STRING	The value that the element specified by the xpath should take when a record is created.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:scaling-group

List of ns scaling group instances

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:scaling-group

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:scaling-group[nsr:scaling-group-name-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/scaling-group/STRING

Fields

Name	Type	Description
scaling-group-name-ref	STRING	name of the scaling group leafref path ../../nsd/scaling-group-descriptor/name
instance	LIST	The instance of the scaling group

JSON Config Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "id": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "id": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:scaling-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:id>0</nsr:id>
  </nsr:instance>
</nsr:scaling-group>

XML Sample

<nsr:scaling-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:id>0</nsr:id>
  </nsr:instance>
</nsr:scaling-group>

nsr:instance

The instance of the scaling group

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:scaling-group/nsr:instance

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:scaling-group[nsr:scaling-group-name-ref='STRING']/nsr:instance[nsr:id='0']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/scaling-group/STRING/instance/0

Fields

Name	Type	Description
id	UINT16	Scaling group instance uuid

JSON Config Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

XML Config Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>0</nsr:id>
</nsr:instance>

XML Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>0</nsr:id>
</nsr:instance>

nsr:nsd-placement-group-maps

Mapping from mano-placement groups construct from NSD to cloud platform placement group construct

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd-placement-group-maps

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd-placement-group-maps/STRING

Fields

Name	Type	Description
placement-group-ref	STRING	Reference for NSD placement group leafref path ../../nsd/placement-groups/name
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Config Sample

[
  {
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Config Sample

<nsr:nsd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:nsd-placement-group-maps>

XML Sample

<nsr:nsd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:nsd-placement-group-maps>

nsr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd-placement-group-maps/nsr:availability-zone

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:availability-zone

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd-placement-group-maps/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

XML Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

nsr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd-placement-group-maps/nsr:server-group

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:server-group

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd-placement-group-maps/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

XML Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

nsr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:nsd-placement-group-maps/nsr:host-aggregate

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:host-aggregate[nsr:metadata-key='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/nsd-placement-group-maps/STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Config Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

XML Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

nsr:vnfd-placement-group-maps

Mapping from mano-placement groups construct from VNFD to cloud platform placement group construct

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:vnfd-placement-group-maps

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/vnfd-placement-group-maps/STRING,STRING

Fields

Name	Type	Description
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsr:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref NOTE: confd limitations prevent the use of xpath
placement-group-ref	LEAFREF	A reference to VNFD placement group
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Config Sample

[
  {
    "vnfd-id-ref": "STRING",
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfd-id-ref": "STRING",
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnfd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:vnfd-placement-group-maps>

XML Sample

<nsr:vnfd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:vnfd-placement-group-maps>

nsr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:vnfd-placement-group-maps/nsr:availability-zone

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:availability-zone

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/vnfd-placement-group-maps/STRING,STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

XML Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

nsr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:vnfd-placement-group-maps/nsr:server-group

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:server-group

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/vnfd-placement-group-maps/STRING,STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

XML Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

nsr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:vnfd-placement-group-maps/nsr:host-aggregate

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:host-aggregate[nsr:metadata-key='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/vnfd-placement-group-maps/STRING,STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Config Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

XML Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

nsr:ssh-authorized-key

List of authorized ssh keys as part of cloud-config

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:ssh-authorized-key

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:ssh-authorized-key[nsr:key-pair-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/ssh-authorized-key/STRING

Fields

Name	Type	Description
key-pair-ref	LEAFREF	A reference to the key pair entry in the global key pair table

JSON Config Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

XML Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

nsr:user

List of users to be added through cloud-config

Key Identifiers:

XPath Path	/nsr:ns-instance-config/nsr:nsr/nsr:user
XPath Keyed Path	/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:user[nsr:name='STRING']
RW.REST URI Path	/nsr:ns-instance-config/nsr/STRING/user/STRING

Fields

Name	Type	Description
name	STRING	Name of the user
user-info	STRING	The user name's real name
ssh-authorized-key	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",
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:ssh-authorized-key

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

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/nsr:user/nsr:ssh-authorized-key

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/nsr:user[nsr:name='STRING']/nsr:ssh-authorized-key[nsr:key-pair-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/user/STRING/ssh-authorized-key/STRING

Fields

Name	Type	Description
key-pair-ref	LEAFREF	A reference to the key pair entry in the global key pair table

JSON Config Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

XML Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

rw-nsr:vnf-cloud-account-map

Mapping VNF to Cloud Account where VNF will be instantiated

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/rw-nsr:vnf-cloud-account-map

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/rw-nsr:vnf-cloud-account-map[rw-nsr:member-vnf-index-ref='0']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/rw-nsr:vnf-cloud-account-map/0

Fields

Name	Type	Description
member-vnf-index-ref	UINT64
cloud-account	LEAFREF	The configured cloud account where VNF is instantiated within. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance
om-datacenter	STRING	Openmano datacenter name to use when instantiating the network service. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.
config-agent-account	LEAFREF	The configured config agent account to use for instantiating this VNF. The configuration for this VNF will be driven using the specified config agent account

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "cloud-account": "STRING",
    "om-datacenter": "STRING",
    "config-agent-account": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "cloud-account": "STRING",
    "om-datacenter": "STRING",
    "config-agent-account": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:member-vnf-index-ref>0</rw-nsr:member-vnf-index-ref>
  <rw-nsr:cloud-account>STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter>STRING</rw-nsr:om-datacenter>
  <rw-nsr:config-agent-account>STRING</rw-nsr:config-agent-account>
</rw-nsr:vnf-cloud-account-map>

XML Sample

<rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:member-vnf-index-ref>0</rw-nsr:member-vnf-index-ref>
  <rw-nsr:cloud-account>STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter>STRING</rw-nsr:om-datacenter>
  <rw-nsr:config-agent-account>STRING</rw-nsr:config-agent-account>
</rw-nsr:vnf-cloud-account-map>

rw-nsr:vl-cloud-account-map

Mapping VL to Cloud Account where VL will be instantiated

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/rw-nsr:vl-cloud-account-map

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/rw-nsr:vl-cloud-account-map[rw-nsr:vld-id-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/rw-nsr:vl-cloud-account-map/STRING

Fields

Name	Type	Description
vld-id-ref	STRING	A reference to a vld. leafref path ../../nsd/vld/id
cloud-accounts	LEAF_LIST	The configured list of cloud accounts where VL is instantiated. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance
om-datacenters	LEAF_LIST	Openmano datacenter names to use when instantiating the VLs. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.

JSON Config Sample

[
  {
    "vld-id-ref": "STRING",
    "cloud-accounts": [ "STRING", ... ],
    "om-datacenters": [ "STRING", ... ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vld-id-ref": "STRING",
    "cloud-accounts": [ "STRING", ... ],
    "om-datacenters": [ "STRING", ... ]
  }, {
    ...
  }
]

XML Config Sample

<rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:vld-id-ref>STRING</rw-nsr:vld-id-ref>
  <rw-nsr:cloud-accounts>STRING</rw-nsr:cloud-accounts>
  <rw-nsr:cloud-accounts>...</rw-nsr:cloud-accounts>
  <rw-nsr:om-datacenters>STRING</rw-nsr:om-datacenters>
  <rw-nsr:om-datacenters>...</rw-nsr:om-datacenters>
</rw-nsr:vl-cloud-account-map>

XML Sample

<rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:vld-id-ref>STRING</rw-nsr:vld-id-ref>
  <rw-nsr:cloud-accounts>STRING</rw-nsr:cloud-accounts>
  <rw-nsr:cloud-accounts>...</rw-nsr:cloud-accounts>
  <rw-nsr:om-datacenters>STRING</rw-nsr:om-datacenters>
  <rw-nsr:om-datacenters>...</rw-nsr:om-datacenters>
</rw-nsr:vl-cloud-account-map>

rw-nsr:cloud-accounts

The configured list of cloud accounts where VL is instantiated. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/rw-nsr:vl-cloud-account-map/rw-nsr:cloud-accounts

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/rw-nsr:vl-cloud-account-map[rw-nsr:vld-id-ref='STRING']/rw-nsr:cloud-accounts

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/rw-nsr:vl-cloud-account-map/STRING/cloud-accounts

JSON Config Sample

[ "STRING", ... ]

JSON Sample

[ "STRING", ... ]

XML Config Sample

<rw-nsr:cloud-accounts xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-accounts>
<rw-nsr:cloud-accounts xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:cloud-accounts>

XML Sample

<rw-nsr:cloud-accounts xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-accounts>
<rw-nsr:cloud-accounts xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:cloud-accounts>

rw-nsr:om-datacenters

Openmano datacenter names to use when instantiating the VLs. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.

Key Identifiers:

XPath Path

/nsr:ns-instance-config/nsr:nsr/rw-nsr:vl-cloud-account-map/rw-nsr:om-datacenters

XPath Keyed Path

/nsr:ns-instance-config/nsr:nsr[nsr:id='STRING']/rw-nsr:vl-cloud-account-map[rw-nsr:vld-id-ref='STRING']/rw-nsr:om-datacenters

RW.REST URI Path

/nsr:ns-instance-config/nsr/STRING/rw-nsr:vl-cloud-account-map/STRING/om-datacenters

JSON Config Sample

[ "STRING", ... ]

JSON Sample

[ "STRING", ... ]

XML Config Sample

<rw-nsr:om-datacenters xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenters>
<rw-nsr:om-datacenters xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:om-datacenters>

XML Sample

<rw-nsr:om-datacenters xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenters>
<rw-nsr:om-datacenters xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:om-datacenters>

nsr:ns-instance-opdata

Key Identifiers:

XPath Path	/nsr:ns-instance-opdata
XPath Keyed Path	/nsr:ns-instance-opdata
RW.REST URI Path	/nsr:ns-instance-opdata

Fields

Name	Type	Description
nsr	LIST

JSON Sample

{
  "nsr": [
    {
      "ns-instance-config-ref": "STRING",
      "name-ref": "STRING",
      "nsd-ref": "STRING",
      "nsd-name-ref": "STRING",
      "create-time": 0,
      "uptime": 0,
      "connection-point": [ { ... }, { ... } ],
      "vlr": [ { ... }, { ... } ],
      "constituent-vnfr-ref": [ { ... }, { ... } ],
      "scaling-group-record": [ { ... }, { ... } ],
      "vnffgr": [ { ... }, { ... } ],
      "operational-status": "init",
      "config-status": "init",
      "service-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "config-agent-job": [ { ... }, { ... } ],
      "rw-nsr:action-param": [ { ... }, { ... } ],
      "rw-nsr:control-param": [ { ... }, { ... } ],
      "rw-nsr:sdn-account": "STRING",
      "rw-nsr:config-status-details": "STRING",
      "rw-nsr:nfvi-metrics": { ... },
      "rw-nsr:epa-param": { ... },
      "rw-nsr:operational-events": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<nsr:ns-instance-opdata xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr>
    <nsr:ns-instance-config-ref>STRING</nsr:ns-instance-config-ref>
    <nsr:name-ref>STRING</nsr:name-ref>
    <nsr:nsd-ref>STRING</nsr:nsd-ref>
    <nsr:nsd-name-ref>STRING</nsr:nsd-name-ref>
    <nsr:create-time>0</nsr:create-time>
    <nsr:uptime>0</nsr:uptime>
    <nsr:connection-point>...</nsr:connection-point>
    <nsr:vlr>...</nsr:vlr>
    <nsr:constituent-vnfr-ref>...</nsr:constituent-vnfr-ref>
    <nsr:scaling-group-record>...</nsr:scaling-group-record>
    <nsr:vnffgr>...</nsr:vnffgr>
    <nsr:operational-status>init</nsr:operational-status>
    <nsr:config-status>init</nsr:config-status>
    <nsr:service-primitive>...</nsr:service-primitive>
    <nsr:initial-config-primitive>...</nsr:initial-config-primitive>
    <nsr:monitoring-param>...</nsr:monitoring-param>
    <nsr:config-agent-job>...</nsr:config-agent-job>
    <rw-nsr:action-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:action-param>
    <rw-nsr:control-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:control-param>
    <rw-nsr:sdn-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:sdn-account>
    <rw-nsr:config-status-details xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:config-status-details>
    <rw-nsr:nfvi-metrics xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:nfvi-metrics>
    <rw-nsr:epa-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:epa-param>
    <rw-nsr:operational-events xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:operational-events>
  </nsr:nsr>
</nsr:ns-instance-opdata>

nsr:nsr

Key Identifiers:

XPath Path	/nsr:ns-instance-opdata/nsr:nsr
XPath Keyed Path	/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']
RW.REST URI Path	/nsr:ns-instance-opdata/nsr/STRING

Fields

Name	Type	Description
ns-instance-config-ref	LEAFREF
name-ref	LEAFREF	Network service name reference
nsd-ref	LEAFREF	Network service descriptor id reference
nsd-name-ref	LEAFREF	Network service descriptor name reference
create-time	UINT32	Creation timestamp of this Network Service. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
uptime	UINT32	Active period of this Network Service. Uptime is expressed in seconds
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.
vlr	LIST
constituent-vnfr-ref	LIST	List of VNFRs that are part of this network service.
scaling-group-record	LIST	List of scaling group records
vnffgr	LIST
operational-status	ENUM	The operational status of the NS instance init : The network service has just started. vl-init-phase : The VLs in the NS are being instantiated. vnf-init-phase : The VNFs in the NS are being instantiated. running : The NS is in running state. terminate : The NS is being terminated. vnf-terminate-phase : The NS is terminating the VNFs in the NS. vl-terminate-phase : The NS is terminating the VLs in the NS. terminated : The NS is in the terminated state. failed : The NS instantiation failed. scaling-out : The NS is scaling out scaling-in : The NS is scaling in vl-instantiate : The NS is initiating a new VL vl-terminate : The NS is terminating a VL
config-status	ENUM	The configuration status of the NS instance configuring: At least one of the VNFs in this instance is in configuring state configured: All the VNFs in this NS instance are configured or config-not-needed state
service-primitive	LIST	Network service level service primitives.
initial-config-primitive	LIST	Initial set of configuration primitives for NSD.
monitoring-param	LIST	List of NS level params.
config-agent-job	LIST
action-param	LIST	List of action parameters to control VNF
control-param	LIST	List of control parameters to manage and update the running configuration of the VNF
sdn-account	LEAFREF	The SDN account associted with the cloud account using which an NS was instantiated.
config-status-details	STRING	The configuration status error details of the NS instance, in case of any errors
nfvi-metrics	CONTAINER
epa-param	CONTAINER
operational-events	LIST	Recent operational events for this network service. Though the model does not impose any restrictions on the numbe of events, the max operational events will be limited to the most recent 10

JSON Sample

[
  {
    "ns-instance-config-ref": "STRING",
    "name-ref": "STRING",
    "nsd-ref": "STRING",
    "nsd-name-ref": "STRING",
    "create-time": 0,
    "uptime": 0,
    "connection-point": [
      {
        "name": "STRING",
        "type": "VPORT"
      }, {
        ...
      }
    ],
    "vlr": [
      {
        "vlr-ref": "STRING",
        "vnfr-connection-point-ref": [ { ... }, { ... } ],
        "rw-nsr:assigned-subnet": "STRING",
        "rw-nsr:cloud-account": "STRING",
        "rw-nsr:om-datacenter": "STRING"
      }, {
        ...
      }
    ],
    "constituent-vnfr-ref": [
      {
        "vnfr-id": "STRING",
        "rw-nsr:cloud-account": "STRING",
        "rw-nsr:om-datacenter": "STRING"
      }, {
        ...
      }
    ],
    "scaling-group-record": [
      {
        "scaling-group-name-ref": "STRING",
        "instance": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnffgr": [
      {
        "id": "STRING",
        "vnffgd-id-ref": "STRING",
        "vnffgd-name-ref": "STRING",
        "sdn-account": "STRING",
        "operational-status": "init",
        "rsp": [ { ... }, { ... } ],
        "classifier": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "operational-status": "init",
    "config-status": "init",
    "service-primitive": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "parameter-group": [ { ... }, { ... } ],
        "vnf-primitive-group": [ { ... }, { ... } ],
        "user-defined-script": "STRING"
      }, {
        ...
      }
    ],
    "initial-config-primitive": [
      {
        "seq": 0,
        "name": "STRING",
        "user-defined-script": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING",
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "HISTOGRAM",
        "units": "STRING",
        "aggregation-type": "AVERAGE",
        "id": "STRING",
        "name": "STRING",
        "nsd-mon-param-ref": "STRING",
        "vnfr-mon-param-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "config-agent-job": [
      {
        "job-id": 0,
        "job-name": "STRING",
        "job-status": "pending",
        "triggered-by": "ns-primitive",
        "create-time": 0,
        "job-status-details": "STRING",
        "parameter": [ { ... }, { ... } ],
        "parameter-group": [ { ... }, { ... } ],
        "vnfr": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "rw-nsr:action-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "group-tag": "STRING",
        "url": "STRING",
        "method": "POST",
        "payload": "STRING"
      }, {
        ...
      }
    ],
    "rw-nsr:control-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "group-tag": "STRING",
        "min-value": 0,
        "max-value": 0,
        "current-value": 0,
        "step-value": 0,
        "units": "STRING",
        "widget-type": "HISTOGRAM",
        "url": "STRING",
        "method": "POST",
        "payload": "STRING"
      }, {
        ...
      }
    ],
    "rw-nsr:sdn-account": "STRING",
    "rw-nsr:config-status-details": "STRING",
    "rw-nsr:nfvi-metrics": {
      "vm": { ... },
      "vcpu": { ... },
      "memory": { ... },
      "storage": { ... },
      "external-ports": { ... },
      "internal-ports": { ... },
      "network": { ... }
    },
    "rw-nsr:epa-param": {
      "ovs-acceleration": { ... },
      "ovs-offload": { ... },
      "ddio": { ... },
      "cat": { ... },
      "cmt": { ... }
    },
    "rw-nsr:operational-events": [
      {
        "id": 0,
        "timestamp": 0,
        "event": "STRING",
        "description": "STRING",
        "details": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:nsr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:ns-instance-config-ref>STRING</nsr:ns-instance-config-ref>
  <nsr:name-ref>STRING</nsr:name-ref>
  <nsr:nsd-ref>STRING</nsr:nsd-ref>
  <nsr:nsd-name-ref>STRING</nsr:nsd-name-ref>
  <nsr:create-time>0</nsr:create-time>
  <nsr:uptime>0</nsr:uptime>
  <nsr:connection-point>
    <nsr:name>STRING</nsr:name>
    <nsr:type>VPORT</nsr:type>
  </nsr:connection-point>
  <nsr:vlr>
    <nsr:vlr-ref>STRING</nsr:vlr-ref>
    <nsr:vnfr-connection-point-ref>...</nsr:vnfr-connection-point-ref>
    <rw-nsr:assigned-subnet xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:assigned-subnet>
    <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
    <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
  </nsr:vlr>
  <nsr:constituent-vnfr-ref>
    <nsr:vnfr-id>STRING</nsr:vnfr-id>
    <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
    <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
  </nsr:constituent-vnfr-ref>
  <nsr:scaling-group-record>
    <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
    <nsr:instance>...</nsr:instance>
  </nsr:scaling-group-record>
  <nsr:vnffgr>
    <nsr:id>STRING</nsr:id>
    <nsr:vnffgd-id-ref>STRING</nsr:vnffgd-id-ref>
    <nsr:vnffgd-name-ref>STRING</nsr:vnffgd-name-ref>
    <nsr:sdn-account>STRING</nsr:sdn-account>
    <nsr:operational-status>init</nsr:operational-status>
    <nsr:rsp>...</nsr:rsp>
    <nsr:classifier>...</nsr:classifier>
  </nsr:vnffgr>
  <nsr:operational-status>init</nsr:operational-status>
  <nsr:config-status>init</nsr:config-status>
  <nsr:service-primitive>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:parameter-group>...</nsr:parameter-group>
    <nsr:vnf-primitive-group>...</nsr:vnf-primitive-group>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
  </nsr:service-primitive>
  <nsr:initial-config-primitive>
    <nsr:seq>0</nsr:seq>
    <nsr:name>STRING</nsr:name>
    <nsr:user-defined-script>STRING</nsr:user-defined-script>
    <nsr:parameter>...</nsr:parameter>
  </nsr:initial-config-primitive>
  <nsr:monitoring-param>
    <nsr:id>STRING</nsr:id>
    <nsr:value-type>INT</nsr:value-type>
    <nsr:numeric-constraints>...</nsr:numeric-constraints>
    <nsr:text-constraints>...</nsr:text-constraints>
    <nsr:value-integer>0</nsr:value-integer>
    <nsr:value-decimal>0.0</nsr:value-decimal>
    <nsr:value-string>STRING</nsr:value-string>
    <nsr:description>STRING</nsr:description>
    <nsr:group-tag>STRING</nsr:group-tag>
    <nsr:widget-type>HISTOGRAM</nsr:widget-type>
    <nsr:units>STRING</nsr:units>
    <nsr:aggregation-type>AVERAGE</nsr:aggregation-type>
    <nsr:name>STRING</nsr:name>
    <nsr:nsd-mon-param-ref>STRING</nsr:nsd-mon-param-ref>
    <nsr:vnfr-mon-param-ref>...</nsr:vnfr-mon-param-ref>
  </nsr:monitoring-param>
  <nsr:config-agent-job>
    <nsr:job-id>0</nsr:job-id>
    <nsr:job-name>STRING</nsr:job-name>
    <nsr:job-status>pending</nsr:job-status>
    <nsr:triggered-by>ns-primitive</nsr:triggered-by>
    <nsr:create-time>0</nsr:create-time>
    <nsr:job-status-details>STRING</nsr:job-status-details>
    <nsr:parameter>...</nsr:parameter>
    <nsr:parameter-group>...</nsr:parameter-group>
    <nsr:vnfr>...</nsr:vnfr>
  </nsr:config-agent-job>
  <rw-nsr:action-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:id>STRING</rw-nsr:id>
    <rw-nsr:name>STRING</rw-nsr:name>
    <rw-nsr:description>STRING</rw-nsr:description>
    <rw-nsr:group-tag>STRING</rw-nsr:group-tag>
    <rw-nsr:url>STRING</rw-nsr:url>
    <rw-nsr:method>POST</rw-nsr:method>
    <rw-nsr:payload>STRING</rw-nsr:payload>
  </rw-nsr:action-param>
  <rw-nsr:control-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:id>STRING</rw-nsr:id>
    <rw-nsr:name>STRING</rw-nsr:name>
    <rw-nsr:description>STRING</rw-nsr:description>
    <rw-nsr:group-tag>STRING</rw-nsr:group-tag>
    <rw-nsr:min-value>0</rw-nsr:min-value>
    <rw-nsr:max-value>0</rw-nsr:max-value>
    <rw-nsr:current-value>0</rw-nsr:current-value>
    <rw-nsr:step-value>0</rw-nsr:step-value>
    <rw-nsr:units>STRING</rw-nsr:units>
    <rw-nsr:widget-type>HISTOGRAM</rw-nsr:widget-type>
    <rw-nsr:url>STRING</rw-nsr:url>
    <rw-nsr:method>POST</rw-nsr:method>
    <rw-nsr:payload>STRING</rw-nsr:payload>
  </rw-nsr:control-param>
  <rw-nsr:sdn-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:sdn-account>
  <rw-nsr:config-status-details xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:config-status-details>
  <rw-nsr:nfvi-metrics xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:vm>...</rw-nsr:vm>
    <rw-nsr:vcpu>...</rw-nsr:vcpu>
    <rw-nsr:memory>...</rw-nsr:memory>
    <rw-nsr:storage>...</rw-nsr:storage>
    <rw-nsr:external-ports>...</rw-nsr:external-ports>
    <rw-nsr:internal-ports>...</rw-nsr:internal-ports>
    <rw-nsr:network>...</rw-nsr:network>
  </rw-nsr:nfvi-metrics>
  <rw-nsr:epa-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:ovs-acceleration>...</rw-nsr:ovs-acceleration>
    <rw-nsr:ovs-offload>...</rw-nsr:ovs-offload>
    <rw-nsr:ddio>...</rw-nsr:ddio>
    <rw-nsr:cat>...</rw-nsr:cat>
    <rw-nsr:cmt>...</rw-nsr:cmt>
  </rw-nsr:epa-param>
  <rw-nsr:operational-events xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:id>0</rw-nsr:id>
    <rw-nsr:timestamp>0</rw-nsr:timestamp>
    <rw-nsr:event>STRING</rw-nsr:event>
    <rw-nsr:description>STRING</rw-nsr:description>
    <rw-nsr:details>STRING</rw-nsr:details>
  </rw-nsr:operational-events>
</nsr:nsr>

nsr: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

/nsr:ns-instance-opdata/nsr:nsr/nsr:connection-point

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:connection-point[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/connection-point/STRING

Fields

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

JSON Sample

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

XML Sample

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

nsr:vlr

Key Identifiers:

XPath Path	/nsr:ns-instance-opdata/nsr:nsr/nsr:vlr
XPath Keyed Path	/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vlr[nsr:vlr-ref='STRING']
RW.REST URI Path	/nsr:ns-instance-opdata/nsr/STRING/vlr/STRING

Fields

Name	Type	Description
vlr-ref	LEAFREF	Reference to a VLR record in the VLR catalog
vnfr-connection-point-ref	LIST	A list of references to connection points.
assigned-subnet	STRING	Subnet added for the VL
cloud-account	LEAFREF	The configured cloud account in which the VL is instantiated within.
om-datacenter	STRING	Openmano datacenter name to use when instantiating the network service. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.

JSON Sample

[
  {
    "vlr-ref": "STRING",
    "vnfr-connection-point-ref": [
      {
        "vnfr-id": "STRING",
        "connection-point": "STRING"
      }, {
        ...
      }
    ],
    "rw-nsr:assigned-subnet": "STRING",
    "rw-nsr:cloud-account": "STRING",
    "rw-nsr:om-datacenter": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:vlr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vlr-ref>STRING</nsr:vlr-ref>
  <nsr:vnfr-connection-point-ref>
    <nsr:vnfr-id>STRING</nsr:vnfr-id>
    <nsr:connection-point>STRING</nsr:connection-point>
  </nsr:vnfr-connection-point-ref>
  <rw-nsr:assigned-subnet xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:assigned-subnet>
  <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
</nsr:vlr>

nsr:vnfr-connection-point-ref

A list of references to connection points.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:vlr/nsr:vnfr-connection-point-ref

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vlr[nsr:vlr-ref='STRING']/nsr:vnfr-connection-point-ref[nsr:vnfr-id='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/vlr/STRING/vnfr-connection-point-ref/STRING

Fields

Name	Type	Description
vnfr-id	LEAFREF	A reference to a vnfr
connection-point	LEAFREF	A reference to a connection point name in a vnfr

JSON Sample

[
  {
    "vnfr-id": "STRING",
    "connection-point": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:vnfr-connection-point-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfr-id>STRING</nsr:vnfr-id>
  <nsr:connection-point>STRING</nsr:connection-point>
</nsr:vnfr-connection-point-ref>

nsr:constituent-vnfr-ref

List of VNFRs that are part of this network service.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:constituent-vnfr-ref

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:constituent-vnfr-ref[nsr:vnfr-id='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/constituent-vnfr-ref/STRING

Fields

Name	Type	Description
vnfr-id	STRING	Reference to the VNFR id This should be a leafref to /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:id But due to confd bug (RIFT-9451), changing to string.
cloud-account	LEAFREF	The configured cloud account in which the VNF is instantiated within. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance
om-datacenter	STRING	Openmano datacenter name to use when instantiating the network service. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.

JSON Sample

[
  {
    "vnfr-id": "STRING",
    "rw-nsr:cloud-account": "STRING",
    "rw-nsr:om-datacenter": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:constituent-vnfr-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfr-id>STRING</nsr:vnfr-id>
  <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
</nsr:constituent-vnfr-ref>

nsr:scaling-group-record

List of scaling group records

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:scaling-group-record

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:scaling-group-record[nsr:scaling-group-name-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/scaling-group-record/STRING

Fields

Name	Type	Description
scaling-group-name-ref	LEAFREF	name of the scaling group
instance	LIST	Reference to scaling group instance record

JSON Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "instance-id": 0,
        "is-default": true,
        "op-status": "init",
        "config-status": "init",
        "error-msg": "STRING",
        "create-time": 0,
        "vnfrs": [ "STRING", ... ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:scaling-group-record xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:instance-id>0</nsr:instance-id>
    <nsr:is-default>true</nsr:is-default>
    <nsr:op-status>init</nsr:op-status>
    <nsr:config-status>init</nsr:config-status>
    <nsr:error-msg>STRING</nsr:error-msg>
    <nsr:create-time>0</nsr:create-time>
    <nsr:vnfrs>STRING</nsr:vnfrs>
    <nsr:vnfrs>...</nsr:vnfrs>
  </nsr:instance>
</nsr:scaling-group-record>

nsr:instance

Reference to scaling group instance record

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:scaling-group-record/nsr:instance

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:scaling-group-record[nsr:scaling-group-name-ref='STRING']/nsr:instance[nsr:instance-id='0']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/scaling-group-record/STRING/instance/0

Fields

Name	Type	Description
instance-id	UINT16	Scaling group instance id
is-default	BOOLEAN	Flag indicating whether this instance was part of default scaling group (and thus undeletable)
op-status	ENUM	The operational status of the NS instance init : The scaling group has just started. vnf-init-phase : The VNFs in the scaling group are being instantiated. running : The scaling group is in running state. terminate : The scaling group is being terminated. vnf-terminate-phase : The VNFs in the scaling group are being terminated. terminated : The scaling group is in the terminated state. failed : The scaling group instantiation failed.
config-status	ENUM	The configuration status of the scaling group instance configuring : At least one of the VNFs in this scaling group instance is in configuring state configured : All the VNFs in this scaling group instance are configured or config-not-needed state failed : Configuring this scaling group instance failed
error-msg	STRING	Reason for failure in configuration of this scaling instance
create-time	UINT32	Creation timestamp of this scaling group record. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
vnfrs	LEAF_LIST	Reference to VNFR within the scale instance

JSON Sample

[
  {
    "instance-id": 0,
    "is-default": true,
    "op-status": "init",
    "config-status": "init",
    "error-msg": "STRING",
    "create-time": 0,
    "vnfrs": [ "STRING", ... ]
  }, {
    ...
  }
]

XML Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:instance-id>0</nsr:instance-id>
  <nsr:is-default>true</nsr:is-default>
  <nsr:op-status>init</nsr:op-status>
  <nsr:config-status>init</nsr:config-status>
  <nsr:error-msg>STRING</nsr:error-msg>
  <nsr:create-time>0</nsr:create-time>
  <nsr:vnfrs>STRING</nsr:vnfrs>
  <nsr:vnfrs>...</nsr:vnfrs>
</nsr:instance>

nsr:vnfrs

Reference to VNFR within the scale instance

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:scaling-group-record/nsr:instance/nsr:vnfrs

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:scaling-group-record[nsr:scaling-group-name-ref='STRING']/nsr:instance[nsr:instance-id='0']/nsr:vnfrs

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/scaling-group-record/STRING/instance/0/vnfrs

JSON Sample

[ "STRING", ... ]

XML Sample

<nsr:vnfrs xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">STRING</nsr:vnfrs>
<nsr:vnfrs xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">...</nsr:vnfrs>

nsr:vnffgr

Key Identifiers:

XPath Path	/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr
XPath Keyed Path	/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']
RW.REST URI Path	/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VNFFGR.
vnffgd-id-ref	LEAFREF	VNFFG descriptor id reference
vnffgd-name-ref	LEAFREF	VNFFG descriptor name reference
sdn-account	LEAFREF	The SDN account to use when requesting resources for this vnffgr
operational-status	ENUM	The operational status of the VNFFGR instance init : The VNFFGR has just started. running : The VNFFGR is in running state. terminate : The VNFFGR is being terminated. terminated : The VNFFGR is in the terminated state. failed : The VNFFGR instantiation failed
rsp	LIST
classifier	LIST

JSON Sample

[
  {
    "id": "STRING",
    "vnffgd-id-ref": "STRING",
    "vnffgd-name-ref": "STRING",
    "sdn-account": "STRING",
    "operational-status": "init",
    "rsp": [
      {
        "id": "STRING",
        "name": "STRING",
        "vnffgd-rsp-id-ref": "STRING",
        "vnffgd-rsp-name-ref": "STRING",
        "classifier-name": "STRING",
        "path-id": 0,
        "vnfr-connection-point-ref": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "classifier": [
      {
        "id": "STRING",
        "name": "STRING",
        "rsp-id-ref": "STRING",
        "rsp-name": "STRING",
        "vnfr-id-ref": "STRING",
        "vnfr-name-ref": "STRING",
        "vnfr-connection-point-ref": "STRING",
        "port-id": "STRING",
        "vm-id": "STRING",
        "ip-address": "STRING",
        "sff-name": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:vnffgr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:vnffgd-id-ref>STRING</nsr:vnffgd-id-ref>
  <nsr:vnffgd-name-ref>STRING</nsr:vnffgd-name-ref>
  <nsr:sdn-account>STRING</nsr:sdn-account>
  <nsr:operational-status>init</nsr:operational-status>
  <nsr:rsp>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:vnffgd-rsp-id-ref>STRING</nsr:vnffgd-rsp-id-ref>
    <nsr:vnffgd-rsp-name-ref>STRING</nsr:vnffgd-rsp-name-ref>
    <nsr:classifier-name>STRING</nsr:classifier-name>
    <nsr:path-id>0</nsr:path-id>
    <nsr:vnfr-connection-point-ref>...</nsr:vnfr-connection-point-ref>
  </nsr:rsp>
  <nsr:classifier>
    <nsr:id>STRING</nsr:id>
    <nsr:name>STRING</nsr:name>
    <nsr:rsp-id-ref>STRING</nsr:rsp-id-ref>
    <nsr:rsp-name>STRING</nsr:rsp-name>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnfr-name-ref>STRING</nsr:vnfr-name-ref>
    <nsr:vnfr-connection-point-ref>STRING</nsr:vnfr-connection-point-ref>
    <nsr:port-id>STRING</nsr:port-id>
    <nsr:vm-id>STRING</nsr:vm-id>
    <nsr:ip-address>STRING</nsr:ip-address>
    <nsr:sff-name>STRING</nsr:sff-name>
  </nsr:classifier>
</nsr:vnffgr>

nsr:rsp

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:rsp

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/rsp/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the RSP.
name	STRING	Name for the RSP
vnffgd-rsp-id-ref	LEAFREF	Identifier for the VNFFG Descriptor RSP reference
vnffgd-rsp-name-ref	LEAFREF	Name for the VNFFG Descriptor RSP reference
classifier-name	STRING
path-id	UINT32	Unique Identifier for the service path
vnfr-connection-point-ref	LIST

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "vnffgd-rsp-id-ref": "STRING",
    "vnffgd-rsp-name-ref": "STRING",
    "classifier-name": "STRING",
    "path-id": 0,
    "vnfr-connection-point-ref": [
      {
        "hop-number": 0,
        "service-function-type": "STRING",
        "member-vnf-index-ref": 0,
        "vnfd-id-ref": "STRING",
        "vnfr-id-ref": "STRING",
        "vnfr-name-ref": "STRING",
        "vnfr-connection-point-ref": "STRING",
        "service-index": 0,
        "connection-point-params": { ... },
        "service-function-forwarder": { ... }
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:rsp xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:vnffgd-rsp-id-ref>STRING</nsr:vnffgd-rsp-id-ref>
  <nsr:vnffgd-rsp-name-ref>STRING</nsr:vnffgd-rsp-name-ref>
  <nsr:classifier-name>STRING</nsr:classifier-name>
  <nsr:path-id>0</nsr:path-id>
  <nsr:vnfr-connection-point-ref>
    <nsr:hop-number>0</nsr:hop-number>
    <nsr:service-function-type>STRING</nsr:service-function-type>
    <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnfr-name-ref>STRING</nsr:vnfr-name-ref>
    <nsr:vnfr-connection-point-ref>STRING</nsr:vnfr-connection-point-ref>
    <nsr:service-index>0</nsr:service-index>
    <nsr:connection-point-params>...</nsr:connection-point-params>
    <nsr:service-function-forwarder>...</nsr:service-function-forwarder>
  </nsr:vnfr-connection-point-ref>
</nsr:rsp>

nsr:vnfr-connection-point-ref

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:rsp/nsr:vnfr-connection-point-ref

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']/nsr:vnfr-connection-point-ref[nsr:hop-number='0']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/rsp/STRING/vnfr-connection-point-ref/0

Fields

Name	Type	Description
hop-number	UINT8	Monotonically increasing number to show service path hop order
service-function-type	STRING	Type of Service Function. NOTE: This needs to map with Service Function Type in ODL to support VNFFG. Service Function Type is mandatory param in ODL SFC. This is temporarily set to string for ease of use
member-vnf-index-ref	UINT64
vnfd-id-ref	STRING	Reference to VNF Descriptor Id
vnfr-id-ref	LEAFREF	A reference to a vnfr id
vnfr-name-ref	LEAFREF	A reference to a vnfr name
vnfr-connection-point-ref	LEAFREF	A reference to a vnfr connection point.
service-index	UINT8	Location within the service path
connection-point-params	CONTAINER
service-function-forwarder	CONTAINER

JSON Sample

[
  {
    "hop-number": 0,
    "service-function-type": "STRING",
    "member-vnf-index-ref": 0,
    "vnfd-id-ref": "STRING",
    "vnfr-id-ref": "STRING",
    "vnfr-name-ref": "STRING",
    "vnfr-connection-point-ref": "STRING",
    "service-index": 0,
    "connection-point-params": {
      "mgmt-address": "UNION_VALUE",
      "name": "STRING",
      "port-id": "STRING",
      "vm-id": "STRING",
      "address": "UNION_VALUE",
      "port": 0
    },
    "service-function-forwarder": {
      "name": "STRING",
      "ip-address": "UNION_VALUE",
      "port": 0
    }
  }, {
    ...
  }
]

XML Sample

<nsr:vnfr-connection-point-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:hop-number>0</nsr:hop-number>
  <nsr:service-function-type>STRING</nsr:service-function-type>
  <nsr:member-vnf-index-ref>0</nsr:member-vnf-index-ref>
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnfr-name-ref>STRING</nsr:vnfr-name-ref>
  <nsr:vnfr-connection-point-ref>STRING</nsr:vnfr-connection-point-ref>
  <nsr:service-index>0</nsr:service-index>
  <nsr:connection-point-params>
    <nsr:mgmt-address>UNION_VALUE</nsr:mgmt-address>
    <nsr:name>STRING</nsr:name>
    <nsr:port-id>STRING</nsr:port-id>
    <nsr:vm-id>STRING</nsr:vm-id>
    <nsr:address>UNION_VALUE</nsr:address>
    <nsr:port>0</nsr:port>
  </nsr:connection-point-params>
  <nsr:service-function-forwarder>
    <nsr:name>STRING</nsr:name>
    <nsr:ip-address>UNION_VALUE</nsr:ip-address>
    <nsr:port>0</nsr:port>
  </nsr:service-function-forwarder>
</nsr:vnfr-connection-point-ref>

nsr:connection-point-params

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:rsp/nsr:vnfr-connection-point-ref/nsr:connection-point-params

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']/nsr:vnfr-connection-point-ref[nsr:hop-number='0']/nsr:connection-point-params

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/rsp/STRING/vnfr-connection-point-ref/0/connection-point-params

Fields

Name	Type	Description
mgmt-address	UNION
name	STRING
port-id	STRING
vm-id	STRING
address	UNION
port	UINT16

JSON Sample

{
  "mgmt-address": "UNION_VALUE",
  "name": "STRING",
  "port-id": "STRING",
  "vm-id": "STRING",
  "address": "UNION_VALUE",
  "port": 0
}

XML Sample

<nsr:connection-point-params xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:mgmt-address>UNION_VALUE</nsr:mgmt-address>
  <nsr:name>STRING</nsr:name>
  <nsr:port-id>STRING</nsr:port-id>
  <nsr:vm-id>STRING</nsr:vm-id>
  <nsr:address>UNION_VALUE</nsr:address>
  <nsr:port>0</nsr:port>
</nsr:connection-point-params>

nsr:service-function-forwarder

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:rsp/nsr:vnfr-connection-point-ref/nsr:service-function-forwarder

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:rsp[nsr:id='STRING']/nsr:vnfr-connection-point-ref[nsr:hop-number='0']/nsr:service-function-forwarder

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/vnffgr/STRING/rsp/STRING/vnfr-connection-point-ref/0/service-function-forwarder

Fields

Name	Type	Description
name	STRING	Service Function Forwarder name
ip-address	UNION	Data Plane IP Address of the SFF
port	UINT16	Data Plane Port of the SFF

JSON Sample

{
  "name": "STRING",
  "ip-address": "UNION_VALUE",
  "port": 0
}

XML Sample

<nsr:service-function-forwarder xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:ip-address>UNION_VALUE</nsr:ip-address>
  <nsr:port>0</nsr:port>
</nsr:service-function-forwarder>

nsr:classifier

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:vnffgr/nsr:classifier

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:vnffgr[nsr:id='STRING']/nsr:classifier[nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/vnffgr/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.
rsp-name	STRING	Name for the RSP
vnfr-id-ref	LEAFREF	A reference to a vnfr id
vnfr-name-ref	LEAFREF	A reference to a vnfr name
vnfr-connection-point-ref	LEAFREF	A reference to a vnfr connection point.
port-id	STRING
vm-id	STRING
ip-address	STRING
sff-name	STRING

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "rsp-id-ref": "STRING",
    "rsp-name": "STRING",
    "vnfr-id-ref": "STRING",
    "vnfr-name-ref": "STRING",
    "vnfr-connection-point-ref": "STRING",
    "port-id": "STRING",
    "vm-id": "STRING",
    "ip-address": "STRING",
    "sff-name": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:classifier xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:name>STRING</nsr:name>
  <nsr:rsp-id-ref>STRING</nsr:rsp-id-ref>
  <nsr:rsp-name>STRING</nsr:rsp-name>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnfr-name-ref>STRING</nsr:vnfr-name-ref>
  <nsr:vnfr-connection-point-ref>STRING</nsr:vnfr-connection-point-ref>
  <nsr:port-id>STRING</nsr:port-id>
  <nsr:vm-id>STRING</nsr:vm-id>
  <nsr:ip-address>STRING</nsr:ip-address>
  <nsr:sff-name>STRING</nsr:sff-name>
</nsr:classifier>

nsr:service-primitive

Network service level service primitives.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/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 Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "data-type": "STRING",
        "mandatory": false,
        "default-value": "STRING",
        "parameter-pool": "STRING",
        "read-only": true,
        "hidden": true
      }, {
        ...
      }
    ],
    "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 Sample

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

nsr:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/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 Sample

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

XML Sample

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

nsr:parameter-group

Grouping of parameters which are logically grouped in UI

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:parameter-group

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:parameter-group[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/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 Sample

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

XML Sample

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

nsr:parameter

List of parameters for the service primitive.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/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 Sample

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

XML Sample

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

nsr:vnf-primitive-group

List of service primitives grouped by VNF.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:vnf-primitive-group

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/service-primitive/STRING/vnf-primitive-group/0

Fields

Name	Type	Description
member-vnf-index-ref	UINT64	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref NOTE: confd limitations prevent the use of xpath
vnfd-name	STRING	Name of the VNFD
primitive	LIST

JSON Sample

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

XML Sample

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

nsr:primitive

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:service-primitive/nsr:vnf-primitive-group/nsr:primitive

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:service-primitive[nsr:name='STRING']/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']/nsr:primitive[nsr:index='0']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/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 Sample

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

XML Sample

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

nsr:initial-config-primitive

Initial set of configuration primitives for NSD.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:initial-config-primitive

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:initial-config-primitive[nsr:seq='0']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/initial-config-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	List of parameters for the initial config primitive

JSON Sample

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

XML Sample

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

nsr:parameter

List of parameters for the initial config primitive

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:initial-config-primitive/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:initial-config-primitive[nsr:seq='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/initial-config-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the intitial config parameter
value	STRING	Value associated with the initial config parameter

JSON Sample

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

XML Sample

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

nsr:monitoring-param

List of NS level params.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:monitoring-param

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:monitoring-param[nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/monitoring-param/STRING

Fields

Name	Type	Description
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
id	STRING
name	STRING
nsd-mon-param-ref	LEAFREF	Reference to the NSD monitoring param descriptor that produced this result
vnfr-mon-param-ref	LIST	A list of VNFR monitoring params associated with this monp

JSON Sample

[
  {
    "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": "HISTOGRAM",
    "units": "STRING",
    "aggregation-type": "AVERAGE",
    "id": "STRING",
    "name": "STRING",
    "nsd-mon-param-ref": "STRING",
    "vnfr-mon-param-ref": [
      {
        "vnfr-id-ref": "STRING",
        "vnfr-mon-param-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

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

nsr:numeric-constraints

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:monitoring-param/nsr:numeric-constraints

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:monitoring-param[nsr:id='STRING']/nsr:numeric-constraints

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/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 Sample

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

XML Sample

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

nsr:text-constraints

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:monitoring-param/nsr:text-constraints

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:monitoring-param[nsr:id='STRING']/nsr:text-constraints

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/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 Sample

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

XML Sample

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

nsr:vnfr-mon-param-ref

A list of VNFR monitoring params associated with this monp

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:monitoring-param/nsr:vnfr-mon-param-ref

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:monitoring-param[nsr:id='STRING']/nsr:vnfr-mon-param-ref[nsr:vnfr-id-ref='STRING'][nsr:vnfr-mon-param-ref='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/monitoring-param/STRING/vnfr-mon-param-ref/STRING,STRING

Fields

Name	Type	Description
vnfr-id-ref	STRING	A reference to a vnfr. This is a leafref to path: /vnfr:vnfr-catalog/vnfr:vnfr/vnfr:id
vnfr-mon-param-ref	LEAFREF	A reference to the VNFR monitoring param

JSON Sample

[
  {
    "vnfr-id-ref": "STRING",
    "vnfr-mon-param-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:vnfr-mon-param-ref xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnfr-mon-param-ref>STRING</nsr:vnfr-mon-param-ref>
</nsr:vnfr-mon-param-ref>

nsr:config-agent-job

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0

Fields

Name	Type	Description
job-id	UINT64	config agent job Identifier for the NS.
job-name	STRING	Config agent job name
job-status	ENUM	Job status to be set based on each VNF primitive execution, pending - if at least one VNF is in pending state and remaining VNFs are in success state. Success - if all VNF executions are in success state failure - if one of the VNF executions is failure
triggered-by	ENUM	The primitive is triggered from NS or VNF level
create-time	UINT32	Creation timestamp of this Config Agent Job. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
job-status-details	STRING	Config agent job status details, in case of errors
parameter	LIST	List of parameters to the configuration primitive.
parameter-group	LIST	List of NS Primitive parameter groups
vnfr	LIST

JSON Sample

[
  {
    "job-id": 0,
    "job-name": "STRING",
    "job-status": "pending",
    "triggered-by": "ns-primitive",
    "create-time": 0,
    "job-status-details": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "parameter-group": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "vnfr": [
      {
        "id": "STRING",
        "vnf-job-status": "pending",
        "primitive": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:config-agent-job xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:job-id>0</nsr:job-id>
  <nsr:job-name>STRING</nsr:job-name>
  <nsr:job-status>pending</nsr:job-status>
  <nsr:triggered-by>ns-primitive</nsr:triggered-by>
  <nsr:create-time>0</nsr:create-time>
  <nsr:job-status-details>STRING</nsr:job-status-details>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:parameter-group>
  <nsr:vnfr>
    <nsr:id>STRING</nsr:id>
    <nsr:vnf-job-status>pending</nsr:vnf-job-status>
    <nsr:primitive>...</nsr:primitive>
  </nsr:vnfr>
</nsr:config-agent-job>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

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

XML Sample

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

nsr:parameter-group

List of NS Primitive parameter groups

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:parameter-group

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:parameter-group[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
parameter	LIST	List of parameters to the configuration primitive.

JSON Sample

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

XML Sample

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

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

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

XML Sample

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

nsr:vnfr

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:vnfr

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:vnfr[nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/vnfr/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VNFR.
vnf-job-status	ENUM	Job status to be set based on each VNF primitive execution, pending - if at least one primitive is in pending state and remaining primitives are in success state. Success - if all primitive executions are in success state failure - if one of the primitive executions is failure
primitive	LIST

JSON Sample

[
  {
    "id": "STRING",
    "vnf-job-status": "pending",
    "primitive": [
      {
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "execution-id": "STRING",
        "execution-status": "pending",
        "execution-error-details": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:vnfr xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>STRING</nsr:id>
  <nsr:vnf-job-status>pending</nsr:vnf-job-status>
  <nsr:primitive>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:execution-id>STRING</nsr:execution-id>
    <nsr:execution-status>pending</nsr:execution-status>
    <nsr:execution-error-details>STRING</nsr:execution-error-details>
  </nsr:primitive>
</nsr:vnfr>

nsr:primitive

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:vnfr/nsr:primitive

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:vnfr[nsr:id='STRING']/nsr:primitive[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/vnfr/STRING/primitive/STRING

Fields

Name	Type	Description
name	STRING	the name of the primitive
parameter	LIST	List of parameters to the configuration primitive.
execution-id	STRING	Execution id of the primitive
execution-status	ENUM	status of the Execution
execution-error-details	STRING	Error details if execution-status is failure

JSON Sample

[
  {
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "execution-id": "STRING",
    "execution-status": "pending",
    "execution-error-details": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:execution-id>STRING</nsr:execution-id>
  <nsr:execution-status>pending</nsr:execution-status>
  <nsr:execution-error-details>STRING</nsr:execution-error-details>
</nsr:primitive>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/nsr:config-agent-job/nsr:vnfr/nsr:primitive/nsr:parameter

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/nsr:config-agent-job[nsr:job-id='0']/nsr:vnfr[nsr:id='STRING']/nsr:primitive[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/config-agent-job/0/vnfr/STRING/primitive/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

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

XML Sample

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

rw-nsr:action-param

List of action parameters to control VNF

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:action-param

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:action-param[rw-nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:action-param/STRING

Fields

Name	Type	Description
id	STRING
name	STRING
description	STRING
group-tag	STRING	A tag to group monitoring parameter
url	STRING	This is the URL where to perform the operation
method	ENUM	This is the method to be performed at the uri. POST by default for action
payload	STRING	This is the operation payload or payload template to be sent in the data for this operation call

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "url": "STRING",
    "method": "POST",
    "payload": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-nsr:action-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:id>STRING</rw-nsr:id>
  <rw-nsr:name>STRING</rw-nsr:name>
  <rw-nsr:description>STRING</rw-nsr:description>
  <rw-nsr:group-tag>STRING</rw-nsr:group-tag>
  <rw-nsr:url>STRING</rw-nsr:url>
  <rw-nsr:method>POST</rw-nsr:method>
  <rw-nsr:payload>STRING</rw-nsr:payload>
</rw-nsr:action-param>

rw-nsr:control-param

List of control parameters to manage and update the running configuration of the VNF

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:control-param

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:control-param[rw-nsr:id='STRING']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:control-param/STRING

Fields

Name	Type	Description
id	STRING	Identifier for control parameter
name	STRING	Name of a control parameter
description	STRING	A description of the control parameter
group-tag	STRING	A tag to group control parameters
min-value	UINT64	Minimum value for the parameter
max-value	UINT64	Maximum value for the parameter
current-value	UINT64	Current value for the parameter
step-value	UINT64	Step value for the parameter
units	STRING
widget-type	ENUM
url	STRING	This is the URL where the operation should be performed.
method	ENUM	Method that the URI should perform. Default Action is POST
payload	STRING	This is the operation payload or payload template as stringified JSON. This field provides the data to be sent for this operation call

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "group-tag": "STRING",
    "min-value": 0,
    "max-value": 0,
    "current-value": 0,
    "step-value": 0,
    "units": "STRING",
    "widget-type": "HISTOGRAM",
    "url": "STRING",
    "method": "POST",
    "payload": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-nsr:control-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:id>STRING</rw-nsr:id>
  <rw-nsr:name>STRING</rw-nsr:name>
  <rw-nsr:description>STRING</rw-nsr:description>
  <rw-nsr:group-tag>STRING</rw-nsr:group-tag>
  <rw-nsr:min-value>0</rw-nsr:min-value>
  <rw-nsr:max-value>0</rw-nsr:max-value>
  <rw-nsr:current-value>0</rw-nsr:current-value>
  <rw-nsr:step-value>0</rw-nsr:step-value>
  <rw-nsr:units>STRING</rw-nsr:units>
  <rw-nsr:widget-type>HISTOGRAM</rw-nsr:widget-type>
  <rw-nsr:url>STRING</rw-nsr:url>
  <rw-nsr:method>POST</rw-nsr:method>
  <rw-nsr:payload>STRING</rw-nsr:payload>
</rw-nsr:control-param>

rw-nsr:nfvi-metrics

Key Identifiers:

XPath Path	/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics
XPath Keyed Path	/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics
RW.REST URI Path	/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics

Fields

Name	Type	Description
vm	CONTAINER
vcpu	CONTAINER
memory	CONTAINER
storage	CONTAINER
external-ports	CONTAINER
internal-ports	CONTAINER
network	CONTAINER

JSON Sample

{
  "vm": {
    "label": "VM",
    "active-vm": 0,
    "inactive-vm": 0
  },
  "vcpu": {
    "label": "VCPU",
    "total": 0,
    "utilization": 0.0
  },
  "memory": {
    "label": "MEMORY",
    "used": 0,
    "total": 0,
    "utilization": 0.0
  },
  "storage": {
    "label": "STORAGE",
    "used": 0,
    "total": 0,
    "utilization": 0.0
  },
  "external-ports": {
    "label": "EXTERNAL PORTS",
    "total": 0
  },
  "internal-ports": {
    "label": "INTERNAL PORTS",
    "total": 0
  },
  "network": {
    "label": "NETWORK TRAFFIC",
    "incoming": { ... },
    "outgoing": { ... }
  }
}

XML Sample

<rw-nsr:nfvi-metrics xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:vm>
    <rw-nsr:label>VM</rw-nsr:label>
    <rw-nsr:active-vm>0</rw-nsr:active-vm>
    <rw-nsr:inactive-vm>0</rw-nsr:inactive-vm>
  </rw-nsr:vm>
  <rw-nsr:vcpu>
    <rw-nsr:label>VCPU</rw-nsr:label>
    <rw-nsr:total>0</rw-nsr:total>
    <rw-nsr:utilization>0.0</rw-nsr:utilization>
  </rw-nsr:vcpu>
  <rw-nsr:memory>
    <rw-nsr:label>MEMORY</rw-nsr:label>
    <rw-nsr:used>0</rw-nsr:used>
    <rw-nsr:total>0</rw-nsr:total>
    <rw-nsr:utilization>0.0</rw-nsr:utilization>
  </rw-nsr:memory>
  <rw-nsr:storage>
    <rw-nsr:label>STORAGE</rw-nsr:label>
    <rw-nsr:used>0</rw-nsr:used>
    <rw-nsr:total>0</rw-nsr:total>
    <rw-nsr:utilization>0.0</rw-nsr:utilization>
  </rw-nsr:storage>
  <rw-nsr:external-ports>
    <rw-nsr:label>EXTERNAL PORTS</rw-nsr:label>
    <rw-nsr:total>0</rw-nsr:total>
  </rw-nsr:external-ports>
  <rw-nsr:internal-ports>
    <rw-nsr:label>INTERNAL PORTS</rw-nsr:label>
    <rw-nsr:total>0</rw-nsr:total>
  </rw-nsr:internal-ports>
  <rw-nsr:network>
    <rw-nsr:label>NETWORK TRAFFIC</rw-nsr:label>
    <rw-nsr:incoming>...</rw-nsr:incoming>
    <rw-nsr:outgoing>...</rw-nsr:outgoing>
  </rw-nsr:network>
</rw-nsr:nfvi-metrics>

rw-nsr:vm

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:vm

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:vm

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/vm

Fields

Name	Type	Description
label	STRING	Label to show in UI
active-vm	UINT64	The number of active VMs.
inactive-vm	UINT64	The number of inactive VMs.

JSON Sample

{
  "label": "VM",
  "active-vm": 0,
  "inactive-vm": 0
}

XML Sample

<rw-nsr:vm xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>VM</rw-nsr:label>
  <rw-nsr:active-vm>0</rw-nsr:active-vm>
  <rw-nsr:inactive-vm>0</rw-nsr:inactive-vm>
</rw-nsr:vm>

rw-nsr:vcpu

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:vcpu

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:vcpu

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/vcpu

Fields

Name	Type	Description
label	STRING	Label to show in UI
total	UINT64	The total number of VCPUs available.
utilization	DECIMAL64	The VCPU utilization (percentage).

JSON Sample

{
  "label": "VCPU",
  "total": 0,
  "utilization": 0.0
}

XML Sample

<rw-nsr:vcpu xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>VCPU</rw-nsr:label>
  <rw-nsr:total>0</rw-nsr:total>
  <rw-nsr:utilization>0.0</rw-nsr:utilization>
</rw-nsr:vcpu>

rw-nsr:memory

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:memory

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:memory

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/memory

Fields

Name	Type	Description
label	STRING	Label to show in UI
used	UINT64	The amount of memory (bytes) currently in use.
total	UINT64	The amount of memory (bytes) available.
utilization	DECIMAL64	The memory utilization (percentage).

JSON Sample

{
  "label": "MEMORY",
  "used": 0,
  "total": 0,
  "utilization": 0.0
}

XML Sample

<rw-nsr:memory xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>MEMORY</rw-nsr:label>
  <rw-nsr:used>0</rw-nsr:used>
  <rw-nsr:total>0</rw-nsr:total>
  <rw-nsr:utilization>0.0</rw-nsr:utilization>
</rw-nsr:memory>

rw-nsr:storage

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:storage

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:storage

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/storage

Fields

Name	Type	Description
label	STRING	Label to show in UI
used	UINT64	The amount of storage (bytes) currently in use.
total	UINT64	The amount of storage (bytes) available.
utilization	DECIMAL64	The storage utilization (percentage).

JSON Sample

{
  "label": "STORAGE",
  "used": 0,
  "total": 0,
  "utilization": 0.0
}

XML Sample

<rw-nsr:storage xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>STORAGE</rw-nsr:label>
  <rw-nsr:used>0</rw-nsr:used>
  <rw-nsr:total>0</rw-nsr:total>
  <rw-nsr:utilization>0.0</rw-nsr:utilization>
</rw-nsr:storage>

rw-nsr:external-ports

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:external-ports

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:external-ports

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/external-ports

Fields

Name	Type	Description
label	STRING	Label to show in UI
total	UINT64	The total number of external ports.

JSON Sample

{
  "label": "EXTERNAL PORTS",
  "total": 0
}

XML Sample

<rw-nsr:external-ports xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>EXTERNAL PORTS</rw-nsr:label>
  <rw-nsr:total>0</rw-nsr:total>
</rw-nsr:external-ports>

rw-nsr:internal-ports

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:internal-ports

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:internal-ports

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/internal-ports

Fields

Name	Type	Description
label	STRING	Label to show in UI
total	UINT64	The total number of internal ports.

JSON Sample

{
  "label": "INTERNAL PORTS",
  "total": 0
}

XML Sample

<rw-nsr:internal-ports xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>INTERNAL PORTS</rw-nsr:label>
  <rw-nsr:total>0</rw-nsr:total>
</rw-nsr:internal-ports>

rw-nsr:network

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:network

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:network

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/network

Fields

Name	Type	Description
label	STRING	Label to show in UI
incoming	CONTAINER
outgoing	CONTAINER

JSON Sample

{
  "label": "NETWORK TRAFFIC",
  "incoming": {
    "label": "INCOMING NETWORK TRAFFIC",
    "bytes": 0,
    "packets": 0,
    "byte-rate": 0.0,
    "packet-rate": 0.0
  },
  "outgoing": {
    "label": "OUTGOING NETWORK TRAFFIC",
    "bytes": 0,
    "packets": 0,
    "byte-rate": 0.0,
    "packet-rate": 0.0
  }
}

XML Sample

<rw-nsr:network xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>NETWORK TRAFFIC</rw-nsr:label>
  <rw-nsr:incoming>
    <rw-nsr:label>INCOMING NETWORK TRAFFIC</rw-nsr:label>
    <rw-nsr:bytes>0</rw-nsr:bytes>
    <rw-nsr:packets>0</rw-nsr:packets>
    <rw-nsr:byte-rate>0.0</rw-nsr:byte-rate>
    <rw-nsr:packet-rate>0.0</rw-nsr:packet-rate>
  </rw-nsr:incoming>
  <rw-nsr:outgoing>
    <rw-nsr:label>OUTGOING NETWORK TRAFFIC</rw-nsr:label>
    <rw-nsr:bytes>0</rw-nsr:bytes>
    <rw-nsr:packets>0</rw-nsr:packets>
    <rw-nsr:byte-rate>0.0</rw-nsr:byte-rate>
    <rw-nsr:packet-rate>0.0</rw-nsr:packet-rate>
  </rw-nsr:outgoing>
</rw-nsr:network>

rw-nsr:incoming

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:network/rw-nsr:incoming

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:network/rw-nsr:incoming

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/network/incoming

Fields

Name	Type	Description
label	STRING	Label to show in UI
bytes	UINT64	The cumulative number of incoming bytes.
packets	UINT64	The cumulative number of incoming packets.
byte-rate	DECIMAL64	The current incoming byte-rate (bytes per second).
packet-rate	DECIMAL64	The current incoming packet (packets per second).

JSON Sample

{
  "label": "INCOMING NETWORK TRAFFIC",
  "bytes": 0,
  "packets": 0,
  "byte-rate": 0.0,
  "packet-rate": 0.0
}

XML Sample

<rw-nsr:incoming xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>INCOMING NETWORK TRAFFIC</rw-nsr:label>
  <rw-nsr:bytes>0</rw-nsr:bytes>
  <rw-nsr:packets>0</rw-nsr:packets>
  <rw-nsr:byte-rate>0.0</rw-nsr:byte-rate>
  <rw-nsr:packet-rate>0.0</rw-nsr:packet-rate>
</rw-nsr:incoming>

rw-nsr:outgoing

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:nfvi-metrics/rw-nsr:network/rw-nsr:outgoing

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:nfvi-metrics/rw-nsr:network/rw-nsr:outgoing

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:nfvi-metrics/network/outgoing

Fields

Name	Type	Description
label	STRING	Label to show in UI
bytes	UINT64	The cumulative number of outgoing bytes.
packets	UINT64	The cumulative number of outgoing packets.
byte-rate	DECIMAL64	The current outgoing byte-rate (bytes per second).
packet-rate	DECIMAL64	The current outgoing packet (packets per second).

JSON Sample

{
  "label": "OUTGOING NETWORK TRAFFIC",
  "bytes": 0,
  "packets": 0,
  "byte-rate": 0.0,
  "packet-rate": 0.0
}

XML Sample

<rw-nsr:outgoing xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>OUTGOING NETWORK TRAFFIC</rw-nsr:label>
  <rw-nsr:bytes>0</rw-nsr:bytes>
  <rw-nsr:packets>0</rw-nsr:packets>
  <rw-nsr:byte-rate>0.0</rw-nsr:byte-rate>
  <rw-nsr:packet-rate>0.0</rw-nsr:packet-rate>
</rw-nsr:outgoing>

rw-nsr:epa-param

Key Identifiers:

XPath Path	/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:epa-param
XPath Keyed Path	/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:epa-param
RW.REST URI Path	/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:epa-param

Fields

Name	Type	Description
ovs-acceleration	CONTAINER
ovs-offload	CONTAINER
ddio	CONTAINER
cat	CONTAINER
cmt	CONTAINER

JSON Sample

{
  "ovs-acceleration": {
    "label": "OVS ACCELERATION",
    "vm": 0,
    "unit": "vms"
  },
  "ovs-offload": {
    "label": "OVS OFFLOAD",
    "vm": 0,
    "unit": "vms"
  },
  "ddio": {
    "label": "DDIO",
    "vm": 0,
    "unit": "vms"
  },
  "cat": {
    "label": "CAT",
    "vm": 0,
    "unit": "vms"
  },
  "cmt": {
    "label": "CMT",
    "vm": 0,
    "unit": "vms"
  }
}

XML Sample

<rw-nsr:epa-param xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:ovs-acceleration>
    <rw-nsr:label>OVS ACCELERATION</rw-nsr:label>
    <rw-nsr:vm>0</rw-nsr:vm>
    <rw-nsr:unit>vms</rw-nsr:unit>
  </rw-nsr:ovs-acceleration>
  <rw-nsr:ovs-offload>
    <rw-nsr:label>OVS OFFLOAD</rw-nsr:label>
    <rw-nsr:vm>0</rw-nsr:vm>
    <rw-nsr:unit>vms</rw-nsr:unit>
  </rw-nsr:ovs-offload>
  <rw-nsr:ddio>
    <rw-nsr:label>DDIO</rw-nsr:label>
    <rw-nsr:vm>0</rw-nsr:vm>
    <rw-nsr:unit>vms</rw-nsr:unit>
  </rw-nsr:ddio>
  <rw-nsr:cat>
    <rw-nsr:label>CAT</rw-nsr:label>
    <rw-nsr:vm>0</rw-nsr:vm>
    <rw-nsr:unit>vms</rw-nsr:unit>
  </rw-nsr:cat>
  <rw-nsr:cmt>
    <rw-nsr:label>CMT</rw-nsr:label>
    <rw-nsr:vm>0</rw-nsr:vm>
    <rw-nsr:unit>vms</rw-nsr:unit>
  </rw-nsr:cmt>
</rw-nsr:epa-param>

rw-nsr:ovs-acceleration

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:epa-param/rw-nsr:ovs-acceleration

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:epa-param/rw-nsr:ovs-acceleration

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:epa-param/ovs-acceleration

Fields

Name	Type	Description
label	STRING	Label to show in UI for the param
vm	UINT64	Number of VMs with the EPA attribute
unit	STRING	Unit label to show in the UI

JSON Sample

{
  "label": "OVS ACCELERATION",
  "vm": 0,
  "unit": "vms"
}

XML Sample

<rw-nsr:ovs-acceleration xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>OVS ACCELERATION</rw-nsr:label>
  <rw-nsr:vm>0</rw-nsr:vm>
  <rw-nsr:unit>vms</rw-nsr:unit>
</rw-nsr:ovs-acceleration>

rw-nsr:ovs-offload

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:epa-param/rw-nsr:ovs-offload

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:epa-param/rw-nsr:ovs-offload

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:epa-param/ovs-offload

Fields

Name	Type	Description
label	STRING	Label to show in UI for the param
vm	UINT64	Number of VMs with the EPA attribute
unit	STRING	Unit label to show in the UI

JSON Sample

{
  "label": "OVS OFFLOAD",
  "vm": 0,
  "unit": "vms"
}

XML Sample

<rw-nsr:ovs-offload xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>OVS OFFLOAD</rw-nsr:label>
  <rw-nsr:vm>0</rw-nsr:vm>
  <rw-nsr:unit>vms</rw-nsr:unit>
</rw-nsr:ovs-offload>

rw-nsr:ddio

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:epa-param/rw-nsr:ddio

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:epa-param/rw-nsr:ddio

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:epa-param/ddio

Fields

Name	Type	Description
label	STRING	Label to show in UI for the param
vm	UINT64	Number of VMs with the EPA attribute
unit	STRING	Unit label to show in the UI

JSON Sample

{
  "label": "DDIO",
  "vm": 0,
  "unit": "vms"
}

XML Sample

<rw-nsr:ddio xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>DDIO</rw-nsr:label>
  <rw-nsr:vm>0</rw-nsr:vm>
  <rw-nsr:unit>vms</rw-nsr:unit>
</rw-nsr:ddio>

rw-nsr:cat

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:epa-param/rw-nsr:cat

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:epa-param/rw-nsr:cat

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:epa-param/cat

Fields

Name	Type	Description
label	STRING	Label to show in UI for the param
vm	UINT64	Number of VMs with the EPA attribute
unit	STRING	Unit label to show in the UI

JSON Sample

{
  "label": "CAT",
  "vm": 0,
  "unit": "vms"
}

XML Sample

<rw-nsr:cat xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>CAT</rw-nsr:label>
  <rw-nsr:vm>0</rw-nsr:vm>
  <rw-nsr:unit>vms</rw-nsr:unit>
</rw-nsr:cat>

rw-nsr:cmt

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:epa-param/rw-nsr:cmt

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:epa-param/rw-nsr:cmt

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:epa-param/cmt

Fields

Name	Type	Description
label	STRING	Label to show in UI for the param
vm	UINT64	Number of VMs with the EPA attribute
unit	STRING	Unit label to show in the UI

JSON Sample

{
  "label": "CMT",
  "vm": 0,
  "unit": "vms"
}

XML Sample

<rw-nsr:cmt xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:label>CMT</rw-nsr:label>
  <rw-nsr:vm>0</rw-nsr:vm>
  <rw-nsr:unit>vms</rw-nsr:unit>
</rw-nsr:cmt>

rw-nsr:operational-events

Recent operational events for this network service. Though the model does not impose any restrictions on the numbe of events, the max operational events will be limited to the most recent 10

Key Identifiers:

XPath Path

/nsr:ns-instance-opdata/nsr:nsr/rw-nsr:operational-events

XPath Keyed Path

/nsr:ns-instance-opdata/nsr:nsr[nsr:ns-instance-config-ref='STRING']/rw-nsr:operational-events[rw-nsr:id='0']

RW.REST URI Path

/nsr:ns-instance-opdata/nsr/STRING/rw-nsr:operational-events/0

Fields

Name	Type	Description
id	UINT64	The id of the instance
timestamp	UINT32	The timestamp of this event expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
event	STRING	Short description of the event
description	STRING	The description of this event
details	STRING	The detailed description of this event (in case of errors)

JSON Sample

[
  {
    "id": 0,
    "timestamp": 0,
    "event": "STRING",
    "description": "STRING",
    "details": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-nsr:operational-events xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:id>0</rw-nsr:id>
  <rw-nsr:timestamp>0</rw-nsr:timestamp>
  <rw-nsr:event>STRING</rw-nsr:event>
  <rw-nsr:description>STRING</rw-nsr:description>
  <rw-nsr:details>STRING</rw-nsr:details>
</rw-nsr:operational-events>

nsr rpc input

nsr:start-network-service

Key Identifiers:

XPath Path	/nsr:start-network-service
XPath Keyed Path	/nsr:start-network-service
RW.REST URI Path	/input

Fields

Name	Type	Description
name	STRING	Name of the Network Service
nsd-ref	LEAFREF	Reference to NSR ID ref
input-parameter	LIST	List of input parameters
scaling-group	LIST	List of ns scaling group instances
nsd-placement-group-maps	LIST	Mapping from mano-placement groups construct from NSD to cloud platform placement group construct
vnfd-placement-group-maps	LIST	Mapping from mano-placement groups construct from VNFD to cloud platform placement group construct
ssh-authorized-key	LIST	List of authorized ssh keys as part of cloud-config
user	LIST	List of users to be added through cloud-config
cloud-account	LEAFREF	The configured cloud account which the NSR is instantiated within. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance
om-datacenter	STRING	Openmano datacenter name to use when instantiating the network service. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.
vnf-cloud-account-map	LIST	Mapping VNF to Cloud Account where VNF will be instantiated
vl-cloud-account-map	LIST	Mapping VL to Cloud Account where VL will be instantiated

JSON Sample

{
  "name": "STRING",
  "nsd-ref": "STRING",
  "input-parameter": [
    {
      "xpath": "STRING",
      "value": "STRING"
    }, {
      ...
    }
  ],
  "scaling-group": [
    {
      "scaling-group-name-ref": "STRING",
      "instance": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "nsd-placement-group-maps": [
    {
      "placement-group-ref": "STRING",
      "cloud-type": "aws",
      "availability-zone": { ... },
      "server-group": { ... },
      "host-aggregate": [ { ... }, { ... } ],
      "aws-construct": [null],
      "openmano-construct": [null],
      "vsphere-construct": [null],
      "mock-construct": [null],
      "cloudsim-construct": [null]
    }, {
      ...
    }
  ],
  "vnfd-placement-group-maps": [
    {
      "vnfd-id-ref": "STRING",
      "placement-group-ref": "STRING",
      "cloud-type": "aws",
      "availability-zone": { ... },
      "server-group": { ... },
      "host-aggregate": [ { ... }, { ... } ],
      "aws-construct": [null],
      "openmano-construct": [null],
      "vsphere-construct": [null],
      "mock-construct": [null],
      "cloudsim-construct": [null]
    }, {
      ...
    }
  ],
  "ssh-authorized-key": [
    {
      "key-pair-ref": "STRING"
    }, {
      ...
    }
  ],
  "user": [
    {
      "name": "STRING",
      "user-info": "STRING",
      "ssh-authorized-key": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "rw-nsr:cloud-account": "STRING",
  "rw-nsr:om-datacenter": "STRING",
  "rw-nsr:vnf-cloud-account-map": [
    {
      "member-vnf-index-ref": 0,
      "cloud-account": "STRING",
      "om-datacenter": "STRING",
      "config-agent-account": "STRING"
    }, {
      ...
    }
  ],
  "rw-nsr:vl-cloud-account-map": [
    {
      "vld-id-ref": "STRING",
      "cloud-accounts": [ "STRING", ... ],
      "om-datacenters": [ "STRING", ... ]
    }, {
      ...
    }
  ]
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:nsd-ref>STRING</nsr:nsd-ref>
  <nsr:input-parameter>
    <nsr:xpath>STRING</nsr:xpath>
    <nsr:value>STRING</nsr:value>
  </nsr:input-parameter>
  <nsr:scaling-group>
    <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
    <nsr:instance>...</nsr:instance>
  </nsr:scaling-group>
  <nsr:nsd-placement-group-maps>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:nsd-placement-group-maps>
  <nsr:vnfd-placement-group-maps>
    <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
    <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
    <nsr:cloud-type>aws</nsr:cloud-type>
    <nsr:availability-zone>...</nsr:availability-zone>
    <nsr:server-group>...</nsr:server-group>
    <nsr:host-aggregate>...</nsr:host-aggregate>
    <nsr:aws-construct/>
    <nsr:openmano-construct/>
    <nsr:vsphere-construct/>
    <nsr:mock-construct/>
    <nsr:cloudsim-construct/>
  </nsr:vnfd-placement-group-maps>
  <nsr:ssh-authorized-key>
    <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
  </nsr:ssh-authorized-key>
  <nsr:user>
    <nsr:name>STRING</nsr:name>
    <nsr:user-info>STRING</nsr:user-info>
    <nsr:ssh-authorized-key>...</nsr:ssh-authorized-key>
  </nsr:user>
  <rw-nsr:cloud-account xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenter>
  <rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:member-vnf-index-ref>0</rw-nsr:member-vnf-index-ref>
    <rw-nsr:cloud-account>STRING</rw-nsr:cloud-account>
    <rw-nsr:om-datacenter>STRING</rw-nsr:om-datacenter>
    <rw-nsr:config-agent-account>STRING</rw-nsr:config-agent-account>
  </rw-nsr:vnf-cloud-account-map>
  <rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
    <rw-nsr:vld-id-ref>STRING</rw-nsr:vld-id-ref>
    <rw-nsr:cloud-accounts>STRING</rw-nsr:cloud-accounts>
    <rw-nsr:cloud-accounts>...</rw-nsr:cloud-accounts>
    <rw-nsr:om-datacenters>STRING</rw-nsr:om-datacenters>
    <rw-nsr:om-datacenters>...</rw-nsr:om-datacenters>
  </rw-nsr:vl-cloud-account-map>
</nsr:input>

nsr:input-parameter

List of input parameters

Key Identifiers:

XPath Path	/nsr:start-network-service/nsr:input-parameter
XPath Keyed Path	/nsr:start-network-service/nsr:input-parameter[nsr:xpath='STRING']
RW.REST URI Path	/input/input-parameter/STRING

Fields

Name	Type	Description
xpath	STRING	An xpath that specfies which element in a descriptor is to be modified.
value	STRING	The value that the element specified by the xpath should take when a record is created.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:scaling-group

List of ns scaling group instances

Key Identifiers:

XPath Path	/nsr:start-network-service/nsr:scaling-group
XPath Keyed Path	/nsr:start-network-service/nsr:scaling-group[nsr:scaling-group-name-ref='STRING']
RW.REST URI Path	/input/scaling-group/STRING

Fields

Name	Type	Description
scaling-group-name-ref	STRING	name of the scaling group leafref path ../../nsd/scaling-group-descriptor/name
instance	LIST	The instance of the scaling group

JSON Config Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "id": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "scaling-group-name-ref": "STRING",
    "instance": [
      {
        "id": 0
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:scaling-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:id>0</nsr:id>
  </nsr:instance>
</nsr:scaling-group>

XML Sample

<nsr:scaling-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance>
    <nsr:id>0</nsr:id>
  </nsr:instance>
</nsr:scaling-group>

nsr:instance

The instance of the scaling group

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:scaling-group/nsr:instance

XPath Keyed Path

/nsr:start-network-service/nsr:scaling-group[nsr:scaling-group-name-ref='STRING']/nsr:instance[nsr:id='0']

RW.REST URI Path

/input/scaling-group/STRING/instance/0

Fields

Name	Type	Description
id	UINT16	Scaling group instance uuid

JSON Config Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

JSON Sample

[
  {
    "id": 0
  }, {
    ...
  }
]

XML Config Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>0</nsr:id>
</nsr:instance>

XML Sample

<nsr:instance xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:id>0</nsr:id>
</nsr:instance>

nsr:nsd-placement-group-maps

Mapping from mano-placement groups construct from NSD to cloud platform placement group construct

Key Identifiers:

XPath Path	/nsr:start-network-service/nsr:nsd-placement-group-maps
XPath Keyed Path	/nsr:start-network-service/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']
RW.REST URI Path	/input/nsd-placement-group-maps/STRING

Fields

Name	Type	Description
placement-group-ref	STRING	Reference for NSD placement group leafref path ../../nsd/placement-groups/name
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Config Sample

[
  {
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Config Sample

<nsr:nsd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:nsd-placement-group-maps>

XML Sample

<nsr:nsd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:nsd-placement-group-maps>

nsr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:nsd-placement-group-maps/nsr:availability-zone

XPath Keyed Path

/nsr:start-network-service/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:availability-zone

RW.REST URI Path

/input/nsd-placement-group-maps/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

XML Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

nsr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:nsd-placement-group-maps/nsr:server-group

XPath Keyed Path

/nsr:start-network-service/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:server-group

RW.REST URI Path

/input/nsd-placement-group-maps/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

XML Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

nsr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:nsd-placement-group-maps/nsr:host-aggregate

XPath Keyed Path

/nsr:start-network-service/nsr:nsd-placement-group-maps[nsr:placement-group-ref='STRING']/nsr:host-aggregate[nsr:metadata-key='STRING']

RW.REST URI Path

/input/nsd-placement-group-maps/STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Config Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

XML Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

nsr:vnfd-placement-group-maps

Mapping from mano-placement groups construct from VNFD to cloud platform placement group construct

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING

Fields

Name	Type	Description
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsr:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref NOTE: confd limitations prevent the use of xpath
placement-group-ref	LEAFREF	A reference to VNFD placement group
cloud-type	ENUM
availability-zone	CONTAINER	Name of the Availability Zone
server-group	CONTAINER	Name of the Affinity/Anti-Affinity Server Group
host-aggregate	LIST	Name of the Host Aggregate
aws-construct	EMPTY
openmano-construct	EMPTY
vsphere-construct	EMPTY
mock-construct	EMPTY
cloudsim-construct	EMPTY

JSON Config Sample

[
  {
    "vnfd-id-ref": "STRING",
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vnfd-id-ref": "STRING",
    "placement-group-ref": "STRING",
    "cloud-type": "aws",
    "availability-zone": {
      "name": "STRING"
    },
    "server-group": {
      "name": "STRING"
    },
    "host-aggregate": [
      {
        "metadata-key": "STRING",
        "metadata-value": "STRING"
      }, {
        ...
      }
    ],
    "aws-construct": [null],
    "openmano-construct": [null],
    "vsphere-construct": [null],
    "mock-construct": [null],
    "cloudsim-construct": [null]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnfd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:vnfd-placement-group-maps>

XML Sample

<nsr:vnfd-placement-group-maps xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:vnfd-id-ref>STRING</nsr:vnfd-id-ref>
  <nsr:placement-group-ref>STRING</nsr:placement-group-ref>
  <nsr:cloud-type>aws</nsr:cloud-type>
  <nsr:availability-zone>
    <nsr:name>STRING</nsr:name>
  </nsr:availability-zone>
  <nsr:server-group>
    <nsr:name>STRING</nsr:name>
  </nsr:server-group>
  <nsr:host-aggregate>
    <nsr:metadata-key>STRING</nsr:metadata-key>
    <nsr:metadata-value>STRING</nsr:metadata-value>
  </nsr:host-aggregate>
  <nsr:aws-construct/>
  <nsr:openmano-construct/>
  <nsr:vsphere-construct/>
  <nsr:mock-construct/>
  <nsr:cloudsim-construct/>
</nsr:vnfd-placement-group-maps>

nsr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:availability-zone

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:availability-zone

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

XML Sample

<nsr:availability-zone xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:availability-zone>

nsr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:server-group

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:server-group

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Config Sample

{
  "name": "STRING"
}

JSON Sample

{
  "name": "STRING"
}

XML Config Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

XML Sample

<nsr:server-group xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
</nsr:server-group>

nsr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps/nsr:host-aggregate

XPath Keyed Path

/nsr:start-network-service/nsr:vnfd-placement-group-maps[nsr:placement-group-ref='STRING'][nsr:vnfd-id-ref='STRING']/nsr:host-aggregate[nsr:metadata-key='STRING']

RW.REST URI Path

/input/vnfd-placement-group-maps/STRING,STRING/host-aggregate/STRING

Fields

Name	Type	Description
metadata-key	STRING	Name of the additional information attached to the host-aggregate
metadata-value	STRING	Value of the corresponding metadata-key

JSON Config Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "metadata-key": "STRING",
    "metadata-value": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

XML Sample

<nsr:host-aggregate xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:metadata-key>STRING</nsr:metadata-key>
  <nsr:metadata-value>STRING</nsr:metadata-value>
</nsr:host-aggregate>

nsr:ssh-authorized-key

List of authorized ssh keys as part of cloud-config

Key Identifiers:

XPath Path	/nsr:start-network-service/nsr:ssh-authorized-key
XPath Keyed Path	/nsr:start-network-service/nsr:ssh-authorized-key[nsr:key-pair-ref='STRING']
RW.REST URI Path	/input/ssh-authorized-key/STRING

Fields

Name	Type	Description
key-pair-ref	LEAFREF	A reference to the key pair entry in the global key pair table

JSON Config Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

XML Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

nsr:user

List of users to be added through cloud-config

Key Identifiers:

XPath Path	/nsr:start-network-service/nsr:user
XPath Keyed Path	/nsr:start-network-service/nsr:user[nsr:name='STRING']
RW.REST URI Path	/input/user/STRING

Fields

Name	Type	Description
name	STRING	Name of the user
user-info	STRING	The user name's real name
ssh-authorized-key	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",
    "ssh-authorized-key": [
      {
        "key-pair-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:ssh-authorized-key

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

Key Identifiers:

XPath Path

/nsr:start-network-service/nsr:user/nsr:ssh-authorized-key

XPath Keyed Path

/nsr:start-network-service/nsr:user[nsr:name='STRING']/nsr:ssh-authorized-key[nsr:key-pair-ref='STRING']

RW.REST URI Path

/input/user/STRING/ssh-authorized-key/STRING

Fields

Name	Type	Description
key-pair-ref	LEAFREF	A reference to the key pair entry in the global key pair table

JSON Config Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "key-pair-ref": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

XML Sample

<nsr:ssh-authorized-key xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:key-pair-ref>STRING</nsr:key-pair-ref>
</nsr:ssh-authorized-key>

rw-nsr:vnf-cloud-account-map

Mapping VNF to Cloud Account where VNF will be instantiated

Key Identifiers:

XPath Path	/nsr:start-network-service/rw-nsr:vnf-cloud-account-map
XPath Keyed Path	/nsr:start-network-service/rw-nsr:vnf-cloud-account-map[rw-nsr:member-vnf-index-ref='0']
RW.REST URI Path	/input/rw-nsr:vnf-cloud-account-map/0

Fields

Name	Type	Description
member-vnf-index-ref	UINT64
cloud-account	LEAFREF	The configured cloud account where VNF is instantiated within. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance
om-datacenter	STRING	Openmano datacenter name to use when instantiating the network service. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.
config-agent-account	LEAFREF	The configured config agent account to use for instantiating this VNF. The configuration for this VNF will be driven using the specified config agent account

JSON Config Sample

[
  {
    "member-vnf-index-ref": 0,
    "cloud-account": "STRING",
    "om-datacenter": "STRING",
    "config-agent-account": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member-vnf-index-ref": 0,
    "cloud-account": "STRING",
    "om-datacenter": "STRING",
    "config-agent-account": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:member-vnf-index-ref>0</rw-nsr:member-vnf-index-ref>
  <rw-nsr:cloud-account>STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter>STRING</rw-nsr:om-datacenter>
  <rw-nsr:config-agent-account>STRING</rw-nsr:config-agent-account>
</rw-nsr:vnf-cloud-account-map>

XML Sample

<rw-nsr:vnf-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:member-vnf-index-ref>0</rw-nsr:member-vnf-index-ref>
  <rw-nsr:cloud-account>STRING</rw-nsr:cloud-account>
  <rw-nsr:om-datacenter>STRING</rw-nsr:om-datacenter>
  <rw-nsr:config-agent-account>STRING</rw-nsr:config-agent-account>
</rw-nsr:vnf-cloud-account-map>

rw-nsr:vl-cloud-account-map

Mapping VL to Cloud Account where VL will be instantiated

Key Identifiers:

XPath Path	/nsr:start-network-service/rw-nsr:vl-cloud-account-map
XPath Keyed Path	/nsr:start-network-service/rw-nsr:vl-cloud-account-map[rw-nsr:vld-id-ref='STRING']
RW.REST URI Path	/input/rw-nsr:vl-cloud-account-map/STRING

Fields

Name	Type	Description
vld-id-ref	STRING	A reference to a vld. leafref path ../../nsd/vld/id
cloud-accounts	LEAF_LIST	The configured list of cloud accounts where VL is instantiated. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance
om-datacenters	LEAF_LIST	Openmano datacenter names to use when instantiating the VLs. This is only used when openmano is selected as the cloud account. This should be superceded by multiple cloud accounts when that becomes available.

JSON Config Sample

[
  {
    "vld-id-ref": "STRING",
    "cloud-accounts": [ "STRING", ... ],
    "om-datacenters": [ "STRING", ... ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "vld-id-ref": "STRING",
    "cloud-accounts": [ "STRING", ... ],
    "om-datacenters": [ "STRING", ... ]
  }, {
    ...
  }
]

XML Config Sample

<rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:vld-id-ref>STRING</rw-nsr:vld-id-ref>
  <rw-nsr:cloud-accounts>STRING</rw-nsr:cloud-accounts>
  <rw-nsr:cloud-accounts>...</rw-nsr:cloud-accounts>
  <rw-nsr:om-datacenters>STRING</rw-nsr:om-datacenters>
  <rw-nsr:om-datacenters>...</rw-nsr:om-datacenters>
</rw-nsr:vl-cloud-account-map>

XML Sample

<rw-nsr:vl-cloud-account-map xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:vld-id-ref>STRING</rw-nsr:vld-id-ref>
  <rw-nsr:cloud-accounts>STRING</rw-nsr:cloud-accounts>
  <rw-nsr:cloud-accounts>...</rw-nsr:cloud-accounts>
  <rw-nsr:om-datacenters>STRING</rw-nsr:om-datacenters>
  <rw-nsr:om-datacenters>...</rw-nsr:om-datacenters>
</rw-nsr:vl-cloud-account-map>

rw-nsr:cloud-accounts

The configured list of cloud accounts where VL is instantiated. All VDU's, Virtual Links, and provider networks will be requested using the cloud-account's associated CAL instance

Key Identifiers:

XPath Path

/nsr:start-network-service/rw-nsr:vl-cloud-account-map/rw-nsr:cloud-accounts

XPath Keyed Path

/nsr:start-network-service/rw-nsr:vl-cloud-account-map[rw-nsr:vld-id-ref='STRING']/rw-nsr:cloud-accounts

RW.REST URI Path

/input/rw-nsr:vl-cloud-account-map/STRING/cloud-accounts

JSON Config Sample

[ "STRING", ... ]

JSON Sample

[ "STRING", ... ]

XML Config Sample

<rw-nsr:cloud-accounts xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-accounts>
<rw-nsr:cloud-accounts xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:cloud-accounts>

XML Sample

<rw-nsr:cloud-accounts xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:cloud-accounts>
<rw-nsr:cloud-accounts xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:cloud-accounts>

rw-nsr:om-datacenters

Key Identifiers:

XPath Path

/nsr:start-network-service/rw-nsr:vl-cloud-account-map/rw-nsr:om-datacenters

XPath Keyed Path

/nsr:start-network-service/rw-nsr:vl-cloud-account-map[rw-nsr:vld-id-ref='STRING']/rw-nsr:om-datacenters

RW.REST URI Path

/input/rw-nsr:vl-cloud-account-map/STRING/om-datacenters

JSON Config Sample

[ "STRING", ... ]

JSON Sample

[ "STRING", ... ]

XML Config Sample

<rw-nsr:om-datacenters xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenters>
<rw-nsr:om-datacenters xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:om-datacenters>

XML Sample

<rw-nsr:om-datacenters xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">STRING</rw-nsr:om-datacenters>
<rw-nsr:om-datacenters xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">...</rw-nsr:om-datacenters>

nsr:get-ns-service-primitive-values

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values
XPath Keyed Path	/nsr:get-ns-service-primitive-values
RW.REST URI Path	/input

Fields

Name	Type	Description
nsr_id_ref	LEAFREF	Reference to NSR ID ref
name	STRING	Name of the NS service primitive group

JSON Sample

{
  "nsr_id_ref": "STRING",
  "name": "STRING"
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr_id_ref>STRING</nsr:nsr_id_ref>
  <nsr:name>STRING</nsr:name>
</nsr:input>

nsr:exec-ns-service-primitive

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive
XPath Keyed Path	/nsr:exec-ns-service-primitive
RW.REST URI Path	/input

Fields

Name	Type	Description
name	STRING	Name of the primitive
nsr_id_ref	LEAFREF	Reference to NSR ID ref
triggered-by	ENUM	The primitive is triggered from NS or VNF level
parameter	LIST	List of parameters to the configuration primitive.
parameter-group	LIST	List of NS Primitive parameter groups
vnf-list	LIST	List of VNFs whose primitives are being set.
user-defined-script	STRING	A user defined script.

JSON Sample

{
  "name": "STRING",
  "nsr_id_ref": "STRING",
  "triggered-by": "ns-primitive",
  "parameter": [
    {
      "name": "STRING",
      "value": "STRING"
    }, {
      ...
    }
  ],
  "parameter-group": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnf-list": [
    {
      "member_vnf_index_ref": 0,
      "vnfr-id-ref": "STRING",
      "vnf-primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "user-defined-script": "STRING"
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:name>STRING</nsr:name>
  <nsr:nsr_id_ref>STRING</nsr:nsr_id_ref>
  <nsr:triggered-by>ns-primitive</nsr:triggered-by>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:parameter-group>
  <nsr:vnf-list>
    <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnf-primitive>...</nsr:vnf-primitive>
  </nsr:vnf-list>
  <nsr:user-defined-script>STRING</nsr:user-defined-script>
</nsr:input>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:parameter
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:parameter[nsr:name='STRING']
RW.REST URI Path	/input/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:parameter-group

List of NS Primitive parameter groups

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:parameter-group
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:parameter-group[nsr:name='STRING']
RW.REST URI Path	/input/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
parameter	LIST	List of parameters to the configuration primitive.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/input/parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:vnf-list

List of VNFs whose primitives are being set.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:vnf-list
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:vnf-list[nsr:member_vnf_index_ref='0']
RW.REST URI Path	/input/vnf-list/0

Fields

Name	Type	Description
member_vnf_index_ref	UINT64	Member VNF index
vnfr-id-ref	STRING	A reference to a vnfr. This is a leafref to path
vnf-primitive	LIST	List of service primitives supported by the configuration agent for this VNF.

JSON Config Sample

[
  {
    "member_vnf_index_ref": 0,
    "vnfr-id-ref": "STRING",
    "vnf-primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "member_vnf_index_ref": 0,
    "vnfr-id-ref": "STRING",
    "vnf-primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<nsr:vnf-list xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnf-primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:vnf-primitive>
</nsr:vnf-list>

XML Sample

<nsr:vnf-list xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnf-primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:vnf-primitive>
</nsr:vnf-list>

nsr:vnf-primitive

List of service primitives supported by the configuration agent for this VNF.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:vnf-list/nsr:vnf-primitive
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:vnf-list[nsr:member_vnf_index_ref='0']/nsr:vnf-primitive[nsr:index='0']
RW.REST URI Path	/input/vnf-list/0/vnf-primitive/0

Fields

Name	Type	Description
index	UINT32	index of the service primitive.
name	STRING	Name of the service primitive.
parameter	LIST	List of parameters to the configuration primitive.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

<nsr:vnf-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:vnf-primitive>

XML Sample

<nsr:vnf-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
</nsr:vnf-primitive>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:vnf-list/nsr:vnf-primitive/nsr:parameter

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:vnf-list[nsr:member_vnf_index_ref='0']/nsr:vnf-primitive[nsr:index='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/input/vnf-list/0/vnf-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Config Sample

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

JSON Sample

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

XML Config Sample

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

XML Sample

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

nsr:exec-scale-in

Key Identifiers:

XPath Path	/nsr:exec-scale-in
XPath Keyed Path	/nsr:exec-scale-in
RW.REST URI Path	/input

Fields

Name	Type	Description
nsr-id-ref	LEAFREF	Reference to NSR ID ref
scaling-group-name-ref	STRING	name of the scaling group
instance-id	UINT64	id of the scaling group

JSON Sample

{
  "nsr-id-ref": "STRING",
  "scaling-group-name-ref": "STRING",
  "instance-id": 0
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr-id-ref>STRING</nsr:nsr-id-ref>
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance-id>0</nsr:instance-id>
</nsr:input>

nsr:exec-scale-out

Key Identifiers:

XPath Path	/nsr:exec-scale-out
XPath Keyed Path	/nsr:exec-scale-out
RW.REST URI Path	/input

Fields

Name	Type	Description
nsr-id-ref	LEAFREF	Reference to NSR ID ref
scaling-group-name-ref	STRING	name of the scaling group
instance-id	UINT64	id of the scaling group

JSON Sample

{
  "nsr-id-ref": "STRING",
  "scaling-group-name-ref": "STRING",
  "instance-id": 0
}

XML Sample

<nsr:input xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr-id-ref>STRING</nsr:nsr-id-ref>
  <nsr:scaling-group-name-ref>STRING</nsr:scaling-group-name-ref>
  <nsr:instance-id>0</nsr:instance-id>
</nsr:input>

nsr rpc output

nsr:start-network-service

Key Identifiers:

XPath Path	/nsr:start-network-service
XPath Keyed Path	/nsr:start-network-service
RW.REST URI Path	/output

Fields

Name	Type	Description
nsr-id	STRING	Automatically generated parameter

JSON Sample

{
  "nsr-id": "STRING"
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:nsr-id>STRING</nsr:nsr-id>
</nsr:output>

nsr:get-ns-service-primitive-values

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values
XPath Keyed Path	/nsr:get-ns-service-primitive-values
RW.REST URI Path	/output

Fields

Name	Type	Description
ns-parameter	LIST	Automatically generated parameter
ns-parameter-group	LIST	Automatically generated parameters in parameter group
vnf-primitive-group	LIST	List of service primitives grouped by VNF.

JSON Sample

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

XML Sample

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

nsr:ns-parameter

Automatically generated parameter

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values/nsr:ns-parameter
XPath Keyed Path	/nsr:get-ns-service-primitive-values/nsr:ns-parameter[nsr:name='STRING']
RW.REST URI Path	/output/ns-parameter/STRING

Fields

Name	Type	Description
name	STRING	Parameter name which should be pulled from a parameter pool
value	STRING	Automatically generated value

JSON Sample

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

XML Sample

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

nsr:ns-parameter-group

Automatically generated parameters in parameter group

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values/nsr:ns-parameter-group
XPath Keyed Path	/nsr:get-ns-service-primitive-values/nsr:ns-parameter-group[nsr:name='STRING']
RW.REST URI Path	/output/ns-parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Parameter group name
parameter	LIST	Automatically generated group parameter

JSON Sample

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

XML Sample

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

nsr:parameter

Automatically generated group parameter

Key Identifiers:

XPath Path

/nsr:get-ns-service-primitive-values/nsr:ns-parameter-group/nsr:parameter

XPath Keyed Path

/nsr:get-ns-service-primitive-values/nsr:ns-parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/output/ns-parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Parameter name which should be pulled from a parameter pool
value	STRING	Automatically generated value

JSON Sample

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

XML Sample

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

nsr:vnf-primitive-group

List of service primitives grouped by VNF.

Key Identifiers:

XPath Path	/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group
XPath Keyed Path	/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']
RW.REST URI Path	/output/vnf-primitive-group/0

Fields

Name	Type	Description
member-vnf-index-ref	UINT64	Reference to member-vnf within constituent-vnfds
vnfd-id-ref	STRING	A reference to a vnfd. This is a leafref to path: ../../../../nsd:constituent-vnfd + [nsd:id = current()/../nsd:id-ref] + /nsd:vnfd-id-ref NOTE: confd limitations prevent the use of xpath
primitive	LIST

JSON Sample

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

XML Sample

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

nsr:primitive

Key Identifiers:

XPath Path

/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group/nsr:primitive

XPath Keyed Path

/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']/nsr:primitive[nsr:index='0']

RW.REST URI Path

/output/vnf-primitive-group/0/primitive/0

Fields

Name	Type	Description
index	UINT32	Index of this primitive
name	STRING	Name of the primitive associated with a value pool
parameter	LIST	Automatically generated parameter

JSON Sample

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

XML Sample

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

nsr:parameter

Automatically generated parameter

Key Identifiers:

XPath Path

/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group/nsr:primitive/nsr:parameter

XPath Keyed Path

/nsr:get-ns-service-primitive-values/nsr:vnf-primitive-group[nsr:member-vnf-index-ref='0']/nsr:primitive[nsr:index='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/output/vnf-primitive-group/0/primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Parameter name which should be pulled from a parameter pool
value	STRING	Automatically generated value

JSON Sample

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

XML Sample

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

nsr:exec-ns-service-primitive

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive
XPath Keyed Path	/nsr:exec-ns-service-primitive
RW.REST URI Path	/output

Fields

Name	Type	Description
job-id	UINT64	Job identifier for this RPC
name	STRING	Name of the service primitive
nsr_id_ref	LEAFREF	Reference to NSR ID ref
triggered-by	ENUM	The primitive is triggered from NS or VNF level
create-time	UINT32	Creation timestamp of this config agent JOB. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
job-status-details	STRING	Job status details, in case of any errors
parameter	LIST	List of parameters to the configuration primitive.
parameter-group	LIST	List of NS Primitive parameter groups
vnf-out-list	LIST	List of VNFs whose primitives were set.

JSON Sample

{
  "job-id": 0,
  "name": "STRING",
  "nsr_id_ref": "STRING",
  "triggered-by": "ns-primitive",
  "create-time": 0,
  "job-status-details": "STRING",
  "parameter": [
    {
      "name": "STRING",
      "value": "STRING"
    }, {
      ...
    }
  ],
  "parameter-group": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vnf-out-list": [
    {
      "member_vnf_index_ref": 0,
      "vnfr-id-ref": "STRING",
      "vnf-out-primitive": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:job-id>0</nsr:job-id>
  <nsr:name>STRING</nsr:name>
  <nsr:nsr_id_ref>STRING</nsr:nsr_id_ref>
  <nsr:triggered-by>ns-primitive</nsr:triggered-by>
  <nsr:create-time>0</nsr:create-time>
  <nsr:job-status-details>STRING</nsr:job-status-details>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:parameter-group>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
  </nsr:parameter-group>
  <nsr:vnf-out-list>
    <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
    <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
    <nsr:vnf-out-primitive>...</nsr:vnf-out-primitive>
  </nsr:vnf-out-list>
</nsr:output>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:parameter
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:parameter[nsr:name='STRING']
RW.REST URI Path	/output/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

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

XML Sample

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

nsr:parameter-group

List of NS Primitive parameter groups

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:parameter-group
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:parameter-group[nsr:name='STRING']
RW.REST URI Path	/output/parameter-group/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
parameter	LIST	List of parameters to the configuration primitive.

JSON Sample

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

XML Sample

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

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:parameter-group/nsr:parameter

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:parameter-group[nsr:name='STRING']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/output/parameter-group/STRING/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

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

XML Sample

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

nsr:vnf-out-list

List of VNFs whose primitives were set.

Key Identifiers:

XPath Path	/nsr:exec-ns-service-primitive/nsr:vnf-out-list
XPath Keyed Path	/nsr:exec-ns-service-primitive/nsr:vnf-out-list[nsr:member_vnf_index_ref='0']
RW.REST URI Path	/output/vnf-out-list/0

Fields

Name	Type	Description
member_vnf_index_ref	UINT64	Member VNF index
vnfr-id-ref	STRING	A reference to a vnfr. This is a leafref to path
vnf-out-primitive	LIST	List of service primitives supported by the configuration agent for this VNF.

JSON Sample

[
  {
    "member_vnf_index_ref": 0,
    "vnfr-id-ref": "STRING",
    "vnf-out-primitive": [
      {
        "index": 0,
        "name": "STRING",
        "parameter": [ { ... }, { ... } ],
        "execution-id": "STRING",
        "execution-status": "STRING",
        "execution-error-details": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<nsr:vnf-out-list xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:member_vnf_index_ref>0</nsr:member_vnf_index_ref>
  <nsr:vnfr-id-ref>STRING</nsr:vnfr-id-ref>
  <nsr:vnf-out-primitive>
    <nsr:index>0</nsr:index>
    <nsr:name>STRING</nsr:name>
    <nsr:parameter>...</nsr:parameter>
    <nsr:execution-id>STRING</nsr:execution-id>
    <nsr:execution-status>STRING</nsr:execution-status>
    <nsr:execution-error-details>STRING</nsr:execution-error-details>
  </nsr:vnf-out-primitive>
</nsr:vnf-out-list>

nsr:vnf-out-primitive

List of service primitives supported by the configuration agent for this VNF.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:vnf-out-list/nsr:vnf-out-primitive

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:vnf-out-list[nsr:member_vnf_index_ref='0']/nsr:vnf-out-primitive[nsr:index='0']

RW.REST URI Path

/output/vnf-out-list/0/vnf-out-primitive/0

Fields

Name	Type	Description
index	UINT32	index of the service primitive.
name	STRING	Name of the service primitive.
parameter	LIST	List of parameters to the configuration primitive.
execution-id	STRING	Execution id of this primitive
execution-status	STRING	Status of the execution of this primitive
execution-error-details	STRING	Error details if execution-status is failed

JSON Sample

[
  {
    "index": 0,
    "name": "STRING",
    "parameter": [
      {
        "name": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ],
    "execution-id": "STRING",
    "execution-status": "STRING",
    "execution-error-details": "STRING"
  }, {
    ...
  }
]

XML Sample

<nsr:vnf-out-primitive xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:index>0</nsr:index>
  <nsr:name>STRING</nsr:name>
  <nsr:parameter>
    <nsr:name>STRING</nsr:name>
    <nsr:value>STRING</nsr:value>
  </nsr:parameter>
  <nsr:execution-id>STRING</nsr:execution-id>
  <nsr:execution-status>STRING</nsr:execution-status>
  <nsr:execution-error-details>STRING</nsr:execution-error-details>
</nsr:vnf-out-primitive>

nsr:parameter

List of parameters to the configuration primitive.

Key Identifiers:

XPath Path

/nsr:exec-ns-service-primitive/nsr:vnf-out-list/nsr:vnf-out-primitive/nsr:parameter

XPath Keyed Path

/nsr:exec-ns-service-primitive/nsr:vnf-out-list[nsr:member_vnf_index_ref='0']/nsr:vnf-out-primitive[nsr:index='0']/nsr:parameter[nsr:name='STRING']

RW.REST URI Path

/output/vnf-out-list/0/vnf-out-primitive/0/parameter/STRING

Fields

Name	Type	Description
name	STRING	Name of the parameter.
value	STRING	Value associated with the name.

JSON Sample

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

XML Sample

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

nsr:exec-scale-in

Key Identifiers:

XPath Path	/nsr:exec-scale-in
XPath Keyed Path	/nsr:exec-scale-in
RW.REST URI Path	/output

Fields

Name	Type	Description
instance-id	UINT64	id of the scaling group

JSON Sample

{
  "instance-id": 0
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:instance-id>0</nsr:instance-id>
</nsr:output>

nsr:exec-scale-out

Key Identifiers:

XPath Path	/nsr:exec-scale-out
XPath Keyed Path	/nsr:exec-scale-out
RW.REST URI Path	/output

Fields

Name	Type	Description
instance-id	UINT64	id of the scaling group

JSON Sample

{
  "instance-id": 0
}

XML Sample

<nsr:output xmlns:nsr="urn:ietf:params:xml:ns:yang:nfvo:nsr">
  <nsr:instance-id>0</nsr:instance-id>
</nsr:output>

rw-nsr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwNsr_RwNsr_t_schema
Global Schema Pointer	rw_ypbc_RwNsr_RwNsr_g_schema

rw-nsr notification

rw-nsr:nsm-notification

Notification for NSM Events. The timestamp of this event is automatically expressed in human readble format - 1970-01-01T00:00:00Z

Key Identifiers:

XPath Path	/rw-nsr:nsm-notification
XPath Keyed Path	/rw-nsr:nsm-notification
RW.REST URI Path	/rw-nsr:nsm-notification

Fields

Name	Type	Description
event	STRING	Short name of the event
description	STRING	The description of this event
details	STRING	The detailed description of this event, in case of errors

JSON Sample

{
  "event": "STRING",
  "description": "STRING",
  "details": "STRING"
}

XML Sample

<rw-nsr:nsm-notification xmlns:rw-nsr="http://riftio.com/ns/riftware-1.0/rw-nsr">
  <rw-nsr:event>STRING</rw-nsr:event>
  <rw-nsr:description>STRING</rw-nsr:description>
  <rw-nsr:details>STRING</rw-nsr:details>
</rw-nsr:nsm-notification>