vnfr - User documentation

Schema Globals

Global Schema Type	rw_ypbc_Vnfr_Vnfr_t_schema
Global Schema Pointer	rw_ypbc_Vnfr_Vnfr_g_schema

vnfr data

vnfr:vnfr-catalog

Key Identifiers:

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

Fields

Name	Type	Description
vnfr	LIST	Virtual Network Function Record (VNFR).

JSON Sample

{
  "vnfr": [
    {
      "id": "STRING",
      "nsr-id-ref": "STRING",
      "member-vnf-index-ref": 0,
      "dashboard-url": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "description": "STRING",
      "version": "STRING",
      "create-time": 0,
      "uptime": 0,
      "vnfd": { ... },
      "vnf-configuration": { ... },
      "mgmt-interface": { ... },
      "internal-vlr": [ { ... }, { ... } ],
      "connection-point": [ { ... }, { ... } ],
      "vdur": [ { ... }, { ... } ],
      "http-endpoint": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "operational-status": "init",
      "config-status": "configuring",
      "placement-groups-info": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vnfr-catalog xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:vnfr>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:nsr-id-ref>STRING</vnfr:nsr-id-ref>
    <vnfr:member-vnf-index-ref>0</vnfr:member-vnf-index-ref>
    <vnfr:dashboard-url>STRING</vnfr:dashboard-url>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:vendor>STRING</vnfr:vendor>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:version>STRING</vnfr:version>
    <vnfr:create-time>0</vnfr:create-time>
    <vnfr:uptime>0</vnfr:uptime>
    <vnfr:vnfd>...</vnfr:vnfd>
    <vnfr:vnf-configuration>...</vnfr:vnf-configuration>
    <vnfr:mgmt-interface>...</vnfr:mgmt-interface>
    <vnfr:internal-vlr>...</vnfr:internal-vlr>
    <vnfr:connection-point>...</vnfr:connection-point>
    <vnfr:vdur>...</vnfr:vdur>
    <vnfr:http-endpoint>...</vnfr:http-endpoint>
    <vnfr:monitoring-param>...</vnfr:monitoring-param>
    <vnfr:operational-status>init</vnfr:operational-status>
    <vnfr:config-status>configuring</vnfr:config-status>
    <vnfr:placement-groups-info>...</vnfr:placement-groups-info>
  </vnfr:vnfr>
</vnfr:vnfr-catalog>

vnfr:vnfr

Virtual Network Function Record (VNFR).

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING	Identifier for the VNFR.
nsr-id-ref	STRING	NS instance identifier. This is a leafref /nsr:ns-instance-config/nsr:nsr/nsr:id
member-vnf-index-ref	LEAFREF	Reference to member VNF index in Network service.
dashboard-url	STRING	Dashboard URL
name	STRING	VNFR name.
short-name	STRING	VNFR short name.
vendor	STRING	Vendor of the VNFR.
description	STRING	Description of the VNFR.
version	STRING	Version of the VNFR
create-time	UINT32	Creation timestamp of this Virtual Network Function. The timestamp is expressed as seconds since unix epoch - 1970-01-01T00:00:00Z
uptime	UINT32	Active period of this Virtual Network Function. Uptime is expressed in seconds
vnfd	CONTAINER	VNF descriptor used to instantiate this VNF
vnf-configuration	CONTAINER	Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.
mgmt-interface	CONTAINER
internal-vlr	LIST
connection-point	LIST	List for external connection points. Each VNF has one or more external connection points. As the name implies that external connection points are used for connecting the VNF to other VNFs or to external networks. Each VNF exposes these connection points to the orchestrator. The orchestrator can construct network services by connecting the connection points between different VNFs. The NFVO will use VLDs and VNFFGs at the network service level to construct network services.
vdur	LIST	List of Virtual Deployment Units
http-endpoint	LIST	List of http endpoints to be used by monitoring params
monitoring-param	LIST	List of monitoring parameters at the network service level
operational-status	ENUM	The operational status of the VNFR instance init : The VNF has just started. vl-init-phase : The internal VLs in the VNF are being instantiated. vm-init-phase : The VMs for VDUs in the VNF are being instantiated. running : The VNF is in running state. terminate : The VNF is being terminated. vm-terminate-phase : The VMs in the VNF are being terminated. vl-terminate-phase : The internal VLs in the VNF are being terminated. terminated : The VNF is in the terminated state. failed : The VNF instantiation failed
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
placement-groups-info	LIST	Placement groups to which this VDU belongs and its cloud construct

JSON Sample

[
  {
    "id": "STRING",
    "nsr-id-ref": "STRING",
    "member-vnf-index-ref": 0,
    "dashboard-url": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "vendor": "STRING",
    "description": "STRING",
    "version": "STRING",
    "create-time": 0,
    "uptime": 0,
    "vnfd": {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "vendor": "STRING",
      "logo": "STRING",
      "description": "STRING",
      "version": "STRING",
      "vnf-configuration": { ... },
      "mgmt-interface": { ... },
      "internal-vld": [ { ... }, { ... } ],
      "ip-profiles": [ { ... }, { ... } ],
      "connection-point": [ { ... }, { ... } ],
      "vdu": [ { ... }, { ... } ],
      "vdu-dependency": [ { ... }, { ... } ],
      "service-function-chain": "UNAWARE",
      "service-function-type": "STRING",
      "http-endpoint": [ { ... }, { ... } ],
      "monitoring-param": [ { ... }, { ... } ],
      "placement-groups": [ { ... }, { ... } ]
    },
    "vnf-configuration": {
      "netconf": { ... },
      "rest": { ... },
      "script": { ... },
      "juju": { ... },
      "config-access": { ... },
      "config-attributes": { ... },
      "service-primitive": [ { ... }, { ... } ],
      "initial-config-primitive": [ { ... }, { ... } ],
      "config-template": "STRING"
    },
    "mgmt-interface": {
      "ip-address": "UNION_VALUE",
      "port": 0
    },
    "internal-vlr": [
      {
        "vlr-ref": "STRING",
        "internal-connection-point-ref": [ "STRING", ... ]
      }, {
        ...
      }
    ],
    "connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "vlr-ref": "STRING",
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING",
        "connection-point-id": "STRING"
      }, {
        ...
      }
    ],
    "vdur": [
      {
        "id": "STRING",
        "name": "STRING",
        "unique-short-name": "STRING",
        "vdu-id-ref": "STRING",
        "vim-id": "STRING",
        "flavor-id": "STRING",
        "image-id": "STRING",
        "management-ip": "UNION_VALUE",
        "vm-management-ip": "UNION_VALUE",
        "console-url": "STRING",
        "vm-flavor": { ... },
        "guest-epa": { ... },
        "vswitch-epa": { ... },
        "hypervisor-epa": { ... },
        "host-epa": { ... },
        "supplemental-boot-data": { ... },
        "volumes": [ { ... }, { ... } ],
        "alarms": [ { ... }, { ... } ],
        "internal-connection-point": [ { ... }, { ... } ],
        "internal-interface": [ { ... }, { ... } ],
        "external-interface": [ { ... }, { ... } ],
        "operational-status": "init",
        "placement-groups-info": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "http-endpoint": [
      {
        "path": "STRING",
        "https": false,
        "port": 0,
        "username": "STRING",
        "password": "STRING",
        "polling-interval-secs": 2,
        "method": "GET",
        "headers": [ { ... }, { ... } ]
      }, {
        ...
      }
    ],
    "monitoring-param": [
      {
        "id": "STRING",
        "name": "STRING",
        "http-endpoint-ref": "STRING",
        "json-query-method": "NAMEKEY",
        "json-query-params": { ... },
        "description": "STRING",
        "group-tag": "STRING",
        "widget-type": "HISTOGRAM",
        "units": "STRING",
        "value-type": "INT",
        "numeric-constraints": { ... },
        "text-constraints": { ... },
        "value-integer": 0,
        "value-decimal": 0.0,
        "value-string": "STRING"
      }, {
        ...
      }
    ],
    "operational-status": "init",
    "config-status": "configuring",
    "placement-groups-info": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:vnfr xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:nsr-id-ref>STRING</vnfr:nsr-id-ref>
  <vnfr:member-vnf-index-ref>0</vnfr:member-vnf-index-ref>
  <vnfr:dashboard-url>STRING</vnfr:dashboard-url>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:vendor>STRING</vnfr:vendor>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:version>STRING</vnfr:version>
  <vnfr:create-time>0</vnfr:create-time>
  <vnfr:uptime>0</vnfr:uptime>
  <vnfr:vnfd>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:vendor>STRING</vnfr:vendor>
    <vnfr:logo>STRING</vnfr:logo>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:version>STRING</vnfr:version>
    <vnfr:vnf-configuration>...</vnfr:vnf-configuration>
    <vnfr:mgmt-interface>...</vnfr:mgmt-interface>
    <vnfr:internal-vld>...</vnfr:internal-vld>
    <vnfr:ip-profiles>...</vnfr:ip-profiles>
    <vnfr:connection-point>...</vnfr:connection-point>
    <vnfr:vdu>...</vnfr:vdu>
    <vnfr:vdu-dependency>...</vnfr:vdu-dependency>
    <vnfr:service-function-chain>UNAWARE</vnfr:service-function-chain>
    <vnfr:service-function-type>STRING</vnfr:service-function-type>
    <vnfr:http-endpoint>...</vnfr:http-endpoint>
    <vnfr:monitoring-param>...</vnfr:monitoring-param>
    <vnfr:placement-groups>...</vnfr:placement-groups>
  </vnfr:vnfd>
  <vnfr:vnf-configuration>
    <vnfr:netconf>...</vnfr:netconf>
    <vnfr:rest>...</vnfr:rest>
    <vnfr:script>...</vnfr:script>
    <vnfr:juju>...</vnfr:juju>
    <vnfr:config-access>...</vnfr:config-access>
    <vnfr:config-attributes>...</vnfr:config-attributes>
    <vnfr:service-primitive>...</vnfr:service-primitive>
    <vnfr:initial-config-primitive>...</vnfr:initial-config-primitive>
    <vnfr:config-template>STRING</vnfr:config-template>
  </vnfr:vnf-configuration>
  <vnfr:mgmt-interface>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:port>0</vnfr:port>
  </vnfr:mgmt-interface>
  <vnfr:internal-vlr>
    <vnfr:vlr-ref>STRING</vnfr:vlr-ref>
    <vnfr:internal-connection-point-ref>STRING</vnfr:internal-connection-point-ref>
    <vnfr:internal-connection-point-ref>...</vnfr:internal-connection-point-ref>
  </vnfr:internal-vlr>
  <vnfr:connection-point>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
    <vnfr:vlr-ref>STRING</vnfr:vlr-ref>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:mac-address>STRING</vnfr:mac-address>
    <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
  </vnfr:connection-point>
  <vnfr:vdur>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:unique-short-name>STRING</vnfr:unique-short-name>
    <vnfr:vdu-id-ref>STRING</vnfr:vdu-id-ref>
    <vnfr:vim-id>STRING</vnfr:vim-id>
    <vnfr:flavor-id>STRING</vnfr:flavor-id>
    <vnfr:image-id>STRING</vnfr:image-id>
    <vnfr:management-ip>UNION_VALUE</vnfr:management-ip>
    <vnfr:vm-management-ip>UNION_VALUE</vnfr:vm-management-ip>
    <vnfr:console-url>STRING</vnfr:console-url>
    <vnfr:vm-flavor>...</vnfr:vm-flavor>
    <vnfr:guest-epa>...</vnfr:guest-epa>
    <vnfr:vswitch-epa>...</vnfr:vswitch-epa>
    <vnfr:hypervisor-epa>...</vnfr:hypervisor-epa>
    <vnfr:host-epa>...</vnfr:host-epa>
    <vnfr:supplemental-boot-data>...</vnfr:supplemental-boot-data>
    <vnfr:volumes>...</vnfr:volumes>
    <vnfr:alarms>...</vnfr:alarms>
    <vnfr:internal-connection-point>...</vnfr:internal-connection-point>
    <vnfr:internal-interface>...</vnfr:internal-interface>
    <vnfr:external-interface>...</vnfr:external-interface>
    <vnfr:operational-status>init</vnfr:operational-status>
    <vnfr:placement-groups-info>...</vnfr:placement-groups-info>
  </vnfr:vdur>
  <vnfr:http-endpoint>
    <vnfr:path>STRING</vnfr:path>
    <vnfr:https>false</vnfr:https>
    <vnfr:port>0</vnfr:port>
    <vnfr:username>STRING</vnfr:username>
    <vnfr:password>STRING</vnfr:password>
    <vnfr:polling-interval-secs>2</vnfr:polling-interval-secs>
    <vnfr:method>GET</vnfr:method>
    <vnfr:headers>...</vnfr:headers>
  </vnfr:http-endpoint>
  <vnfr:monitoring-param>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:http-endpoint-ref>STRING</vnfr:http-endpoint-ref>
    <vnfr:json-query-method>NAMEKEY</vnfr:json-query-method>
    <vnfr:json-query-params>...</vnfr:json-query-params>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:group-tag>STRING</vnfr:group-tag>
    <vnfr:widget-type>HISTOGRAM</vnfr:widget-type>
    <vnfr:units>STRING</vnfr:units>
    <vnfr:value-type>INT</vnfr:value-type>
    <vnfr:numeric-constraints>...</vnfr:numeric-constraints>
    <vnfr:text-constraints>...</vnfr:text-constraints>
    <vnfr:value-integer>0</vnfr:value-integer>
    <vnfr:value-decimal>0.0</vnfr:value-decimal>
    <vnfr:value-string>STRING</vnfr:value-string>
  </vnfr:monitoring-param>
  <vnfr:operational-status>init</vnfr:operational-status>
  <vnfr:config-status>configuring</vnfr:config-status>
  <vnfr:placement-groups-info>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:requirement>STRING</vnfr:requirement>
    <vnfr:strategy>COLOCATION</vnfr:strategy>
    <vnfr:cloud-type>aws</vnfr:cloud-type>
    <vnfr:availability-zone>...</vnfr:availability-zone>
    <vnfr:server-group>...</vnfr:server-group>
    <vnfr:host-aggregate>...</vnfr:host-aggregate>
    <vnfr:aws-construct/>
    <vnfr:openmano-construct/>
    <vnfr:vsphere-construct/>
    <vnfr:mock-construct/>
    <vnfr:cloudsim-construct/>
  </vnfr:placement-groups-info>
</vnfr:vnfr>

vnfr:vnfd

VNF descriptor used to instantiate this VNF

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING	Identifier for the VNFD.
name	STRING	VNFD name.
short-name	STRING	Short name to appear as label in the UI
vendor	STRING	Vendor of the VNFD.
logo	STRING	Vendor logo for the Virtual Network Function
description	STRING	Description of the VNFD.
version	STRING	Version of the VNFD
vnf-configuration	CONTAINER	Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.
mgmt-interface	CONTAINER	Interface over which the VNF is managed.
internal-vld	LIST	List of Internal Virtual Link Descriptors (VLD). The internal VLD describes the basic topology of the connectivity such as E-LAN, E-Line, E-Tree. between internal VNF components of the system.
ip-profiles	LIST	List of IP Profiles. IP Profile describes the IP characteristics for the Virtual-Link
connection-point	LIST	List for external connection points. Each VNF has one or more external connection points that connect the VNF to other VNFs or to external networks. Each VNF exposes connection points to the orchestrator, which can construct network services by connecting the connection points between different VNFs. The NFVO will use VLDs and VNFFGs at the network service level to construct network services.
vdu	LIST	List of Virtual Deployment Units
vdu-dependency	LIST	List of VDU dependencies.
service-function-chain	ENUM	Type of node in Service Function Chaining Architecture
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
http-endpoint	LIST	List of http endpoints to be used by monitoring params
monitoring-param	LIST	List of monitoring parameters at the network service level
placement-groups	LIST	List of placement groups at VNF level

JSON Sample

{
  "id": "STRING",
  "name": "STRING",
  "short-name": "STRING",
  "vendor": "STRING",
  "logo": "STRING",
  "description": "STRING",
  "version": "STRING",
  "vnf-configuration": {
    "netconf": { ... },
    "rest": { ... },
    "script": { ... },
    "juju": { ... },
    "config-access": { ... },
    "config-attributes": { ... },
    "service-primitive": [ { ... }, { ... } ],
    "initial-config-primitive": [ { ... }, { ... } ],
    "config-template": "STRING"
  },
  "mgmt-interface": {
    "ip-address": "UNION_VALUE",
    "vdu-id": "STRING",
    "cp": "STRING",
    "port": 0,
    "dashboard-params": { ... }
  },
  "internal-vld": [
    {
      "id": "STRING",
      "name": "STRING",
      "short-name": "STRING",
      "description": "STRING",
      "type": "ELAN",
      "root-bandwidth": 0,
      "leaf-bandwidth": 0,
      "internal-connection-point": [ { ... }, { ... } ],
      "provider-network": { ... },
      "vim-network-name": "STRING",
      "ip-profile-ref": "STRING"
    }, {
      ...
    }
  ],
  "ip-profiles": [
    {
      "name": "STRING",
      "description": "STRING",
      "ip-profile-params": { ... }
    }, {
      ...
    }
  ],
  "connection-point": [
    {
      "name": "STRING",
      "id": "STRING",
      "short-name": "STRING",
      "type": "VPORT",
      "port-security-enabled": true
    }, {
      ...
    }
  ],
  "vdu": [
    {
      "id": "STRING",
      "name": "STRING",
      "description": "STRING",
      "count": 0,
      "mgmt-vpci": "STRING",
      "vm-flavor": { ... },
      "guest-epa": { ... },
      "vswitch-epa": { ... },
      "hypervisor-epa": { ... },
      "host-epa": { ... },
      "alarm": [ { ... }, { ... } ],
      "image": "STRING",
      "image-checksum": "STRING",
      "cloud-init": "STRING",
      "cloud-init-file": "STRING",
      "supplemental-boot-data": { ... },
      "internal-connection-point": [ { ... }, { ... } ],
      "internal-interface": [ { ... }, { ... } ],
      "external-interface": [ { ... }, { ... } ],
      "volumes": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "vdu-dependency": [
    {
      "vdu-source-ref": "STRING",
      "vdu-depends-on-ref": "STRING"
    }, {
      ...
    }
  ],
  "service-function-chain": "UNAWARE",
  "service-function-type": "STRING",
  "http-endpoint": [
    {
      "path": "STRING",
      "https": false,
      "port": 0,
      "username": "STRING",
      "password": "STRING",
      "polling-interval-secs": 2,
      "method": "GET",
      "headers": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "monitoring-param": [
    {
      "id": "STRING",
      "name": "STRING",
      "http-endpoint-ref": "STRING",
      "json-query-method": "NAMEKEY",
      "json-query-params": { ... },
      "description": "STRING",
      "group-tag": "STRING",
      "widget-type": "HISTOGRAM",
      "units": "STRING",
      "value-type": "INT",
      "numeric-constraints": { ... },
      "text-constraints": { ... },
      "value-integer": 0,
      "value-decimal": 0.0,
      "value-string": "STRING"
    }, {
      ...
    }
  ],
  "placement-groups": [
    {
      "name": "STRING",
      "requirement": "STRING",
      "strategy": "COLOCATION",
      "member-vdus": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:vnfd xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:vendor>STRING</vnfr:vendor>
  <vnfr:logo>STRING</vnfr:logo>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:version>STRING</vnfr:version>
  <vnfr:vnf-configuration>
    <vnfr:netconf>...</vnfr:netconf>
    <vnfr:rest>...</vnfr:rest>
    <vnfr:script>...</vnfr:script>
    <vnfr:juju>...</vnfr:juju>
    <vnfr:config-access>...</vnfr:config-access>
    <vnfr:config-attributes>...</vnfr:config-attributes>
    <vnfr:service-primitive>...</vnfr:service-primitive>
    <vnfr:initial-config-primitive>...</vnfr:initial-config-primitive>
    <vnfr:config-template>STRING</vnfr:config-template>
  </vnfr:vnf-configuration>
  <vnfr:mgmt-interface>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:vdu-id>STRING</vnfr:vdu-id>
    <vnfr:cp>STRING</vnfr:cp>
    <vnfr:port>0</vnfr:port>
    <vnfr:dashboard-params>...</vnfr:dashboard-params>
  </vnfr:mgmt-interface>
  <vnfr:internal-vld>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:type>ELAN</vnfr:type>
    <vnfr:root-bandwidth>0</vnfr:root-bandwidth>
    <vnfr:leaf-bandwidth>0</vnfr:leaf-bandwidth>
    <vnfr:internal-connection-point>...</vnfr:internal-connection-point>
    <vnfr:provider-network>...</vnfr:provider-network>
    <vnfr:vim-network-name>STRING</vnfr:vim-network-name>
    <vnfr:ip-profile-ref>STRING</vnfr:ip-profile-ref>
  </vnfr:internal-vld>
  <vnfr:ip-profiles>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:ip-profile-params>...</vnfr:ip-profile-params>
  </vnfr:ip-profiles>
  <vnfr:connection-point>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  </vnfr:connection-point>
  <vnfr:vdu>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:count>0</vnfr:count>
    <vnfr:mgmt-vpci>STRING</vnfr:mgmt-vpci>
    <vnfr:vm-flavor>...</vnfr:vm-flavor>
    <vnfr:guest-epa>...</vnfr:guest-epa>
    <vnfr:vswitch-epa>...</vnfr:vswitch-epa>
    <vnfr:hypervisor-epa>...</vnfr:hypervisor-epa>
    <vnfr:host-epa>...</vnfr:host-epa>
    <vnfr:alarm>...</vnfr:alarm>
    <vnfr:image>STRING</vnfr:image>
    <vnfr:image-checksum>STRING</vnfr:image-checksum>
    <vnfr:cloud-init>STRING</vnfr:cloud-init>
    <vnfr:cloud-init-file>STRING</vnfr:cloud-init-file>
    <vnfr:supplemental-boot-data>...</vnfr:supplemental-boot-data>
    <vnfr:internal-connection-point>...</vnfr:internal-connection-point>
    <vnfr:internal-interface>...</vnfr:internal-interface>
    <vnfr:external-interface>...</vnfr:external-interface>
    <vnfr:volumes>...</vnfr:volumes>
  </vnfr:vdu>
  <vnfr:vdu-dependency>
    <vnfr:vdu-source-ref>STRING</vnfr:vdu-source-ref>
    <vnfr:vdu-depends-on-ref>STRING</vnfr:vdu-depends-on-ref>
  </vnfr:vdu-dependency>
  <vnfr:service-function-chain>UNAWARE</vnfr:service-function-chain>
  <vnfr:service-function-type>STRING</vnfr:service-function-type>
  <vnfr:http-endpoint>
    <vnfr:path>STRING</vnfr:path>
    <vnfr:https>false</vnfr:https>
    <vnfr:port>0</vnfr:port>
    <vnfr:username>STRING</vnfr:username>
    <vnfr:password>STRING</vnfr:password>
    <vnfr:polling-interval-secs>2</vnfr:polling-interval-secs>
    <vnfr:method>GET</vnfr:method>
    <vnfr:headers>...</vnfr:headers>
  </vnfr:http-endpoint>
  <vnfr:monitoring-param>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:http-endpoint-ref>STRING</vnfr:http-endpoint-ref>
    <vnfr:json-query-method>NAMEKEY</vnfr:json-query-method>
    <vnfr:json-query-params>...</vnfr:json-query-params>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:group-tag>STRING</vnfr:group-tag>
    <vnfr:widget-type>HISTOGRAM</vnfr:widget-type>
    <vnfr:units>STRING</vnfr:units>
    <vnfr:value-type>INT</vnfr:value-type>
    <vnfr:numeric-constraints>...</vnfr:numeric-constraints>
    <vnfr:text-constraints>...</vnfr:text-constraints>
    <vnfr:value-integer>0</vnfr:value-integer>
    <vnfr:value-decimal>0.0</vnfr:value-decimal>
    <vnfr:value-string>STRING</vnfr:value-string>
  </vnfr:monitoring-param>
  <vnfr:placement-groups>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:requirement>STRING</vnfr:requirement>
    <vnfr:strategy>COLOCATION</vnfr:strategy>
    <vnfr:member-vdus>...</vnfr:member-vdus>
  </vnfr:placement-groups>
</vnfr:vnfd>

vnfr:vnf-configuration

Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration

Fields

Name	Type	Description
netconf	CONTAINER
rest	CONTAINER
script	CONTAINER
juju	CONTAINER
config-access	CONTAINER
config-attributes	CONTAINER	Miscellaneous input parameters to be considered while processing the NSD to apply configuration
service-primitive	LIST	List of service primitives supported by the configuration agent for this VNF.
initial-config-primitive	LIST	Initial set of configuration primitives.
config-template	STRING	Configuration template for each VNF

JSON Sample

{
  "netconf": {
    "target": "running",
    "protocol": "None",
    "port": 0
  },
  "rest": {
    "port": 0
  },
  "script": {
    "script-type": "bash"
  },
  "juju": {
    "charm": "STRING"
  },
  "config-access": {
    "mgmt-ip-address": "UNION_VALUE",
    "username": "STRING",
    "password": "STRING"
  },
  "config-attributes": {
    "config-priority": 0,
    "config-delay": 0
  },
  "service-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "user-defined-script": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "config-template": "STRING"
}

XML Sample

<vnfr:vnf-configuration xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:netconf>
    <vnfr:target>running</vnfr:target>
    <vnfr:protocol>None</vnfr:protocol>
    <vnfr:port>0</vnfr:port>
  </vnfr:netconf>
  <vnfr:rest>
    <vnfr:port>0</vnfr:port>
  </vnfr:rest>
  <vnfr:script>
    <vnfr:script-type>bash</vnfr:script-type>
  </vnfr:script>
  <vnfr:juju>
    <vnfr:charm>STRING</vnfr:charm>
  </vnfr:juju>
  <vnfr:config-access>
    <vnfr:mgmt-ip-address>UNION_VALUE</vnfr:mgmt-ip-address>
    <vnfr:username>STRING</vnfr:username>
    <vnfr:password>STRING</vnfr:password>
  </vnfr:config-access>
  <vnfr:config-attributes>
    <vnfr:config-priority>0</vnfr:config-priority>
    <vnfr:config-delay>0</vnfr:config-delay>
  </vnfr:config-attributes>
  <vnfr:service-primitive>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
  </vnfr:service-primitive>
  <vnfr:initial-config-primitive>
    <vnfr:seq>0</vnfr:seq>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
    <vnfr:parameter>...</vnfr:parameter>
  </vnfr:initial-config-primitive>
  <vnfr:config-template>STRING</vnfr:config-template>
</vnfr:vnf-configuration>

vnfr:netconf

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:netconf

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:netconf

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/netconf

Fields

Name	Type	Description
target	ENUM	Netconf configuration target
protocol	ENUM	Protocol to use for NETCONF, such as ssh
port	UINT16	Port for the NETCONF server.

JSON Sample

{
  "target": "running",
  "protocol": "None",
  "port": 0
}

XML Sample

<vnfr:netconf xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:target>running</vnfr:target>
  <vnfr:protocol>None</vnfr:protocol>
  <vnfr:port>0</vnfr:port>
</vnfr:netconf>

vnfr:rest

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:rest

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:rest

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/rest

Fields

Name	Type	Description
port	UINT16	Port for the REST server.

JSON Sample

{
  "port": 0
}

XML Sample

<vnfr:rest xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:port>0</vnfr:port>
</vnfr:rest>

vnfr:script

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:script

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:script

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/script

Fields

Name	Type	Description
script-type	ENUM	Script type - currently supported : bash, expect

JSON Sample

{
  "script-type": "bash"
}

XML Sample

<vnfr:script xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script-type>bash</vnfr:script-type>
</vnfr:script>

vnfr:juju

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:juju

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/juju

Fields

Name	Type	Description
charm	STRING	Juju charm to use with the VNF.

JSON Sample

{
  "charm": "STRING"
}

XML Sample

<vnfr:juju xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:charm>STRING</vnfr:charm>
</vnfr:juju>

vnfr:config-access

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-access

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-access

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/config-access

Fields

Name	Type	Description
mgmt-ip-address	UNION	IP address to be used to configure this VNF, optional if it is possible to resolve dynamically.
username	STRING	User name for configuration.
password	STRING	Password for configuration access authentication.

JSON Sample

{
  "mgmt-ip-address": "UNION_VALUE",
  "username": "STRING",
  "password": "STRING"
}

XML Sample

<vnfr:config-access xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:mgmt-ip-address>UNION_VALUE</vnfr:mgmt-ip-address>
  <vnfr:username>STRING</vnfr:username>
  <vnfr:password>STRING</vnfr:password>
</vnfr:config-access>

vnfr:config-attributes

Miscellaneous input parameters to be considered while processing the NSD to apply configuration

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-attributes

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:config-attributes

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/config-attributes

Fields

Name	Type	Description
config-priority	UINT64	Configuration priority - order of configuration to be applied to each VNF in this NS. A low number takes precedence over a high number
config-delay	UINT64	Wait (seconds) before applying the configuration to VNF

JSON Sample

{
  "config-priority": 0,
  "config-delay": 0
}

XML Sample

<vnfr:config-attributes xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:config-priority>0</vnfr:config-priority>
  <vnfr:config-delay>0</vnfr:config-delay>
</vnfr:config-attributes>

vnfr:service-primitive

List of service primitives supported by the configuration agent for this VNF.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/service-primitive/STRING

Fields

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

JSON Sample

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

XML Sample

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

vnfr:parameter

List of parameters to the service primitive.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive/vnfr:parameter

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/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

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

vnfr:initial-config-primitive

Initial set of configuration primitives.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/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 Sample

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

XML Sample

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

vnfr:parameter

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive/vnfr:parameter

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vnf-configuration/initial-config-primitive/0/parameter/STRING

Fields

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

JSON Sample

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

XML Sample

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

vnfr:mgmt-interface

Interface over which the VNF is managed.

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:mgmt-interface
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:mgmt-interface
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vnfd/mgmt-interface

Fields

Name	Type	Description
ip-address	UNION
vdu-id	LEAFREF
cp	LEAFREF
port	UINT16	Port for the management interface.
dashboard-params	CONTAINER	Parameters for the VNF dashboard

JSON Sample

{
  "ip-address": "UNION_VALUE",
  "vdu-id": "STRING",
  "cp": "STRING",
  "port": 0,
  "dashboard-params": {
    "path": "STRING",
    "https": true,
    "port": 0
  }
}

XML Sample

<vnfr:mgmt-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:vdu-id>STRING</vnfr:vdu-id>
  <vnfr:cp>STRING</vnfr:cp>
  <vnfr:port>0</vnfr:port>
  <vnfr:dashboard-params>
    <vnfr:path>STRING</vnfr:path>
    <vnfr:https>true</vnfr:https>
    <vnfr:port>0</vnfr:port>
  </vnfr:dashboard-params>
</vnfr:mgmt-interface>

vnfr:dashboard-params

Parameters for the VNF dashboard

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:mgmt-interface/vnfr:dashboard-params

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:mgmt-interface/vnfr:dashboard-params

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/mgmt-interface/dashboard-params

Fields

Name	Type	Description
path	STRING	The HTTP path for the dashboard
https	BOOLEAN	Pick HTTPS instead of HTTP , Default is false
port	UINT16	The HTTP port for the dashboard

JSON Sample

{
  "path": "STRING",
  "https": true,
  "port": 0
}

XML Sample

<vnfr:dashboard-params xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:path>STRING</vnfr:path>
  <vnfr:https>true</vnfr:https>
  <vnfr:port>0</vnfr:port>
</vnfr:dashboard-params>

vnfr:internal-vld

List of Internal Virtual Link Descriptors (VLD). The internal VLD describes the basic topology of the connectivity such as E-LAN, E-Line, E-Tree. between internal VNF components of the system.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/internal-vld/STRING

Fields

Name	Type	Description
id	STRING	Identifier for the VLD
name	STRING	Name of the internal VLD
short-name	STRING	Short name to appear as label in the UI
description	STRING	Description of internal VLD.
type	ENUM
root-bandwidth	UINT64	For ELAN this is the aggregate bandwidth.
leaf-bandwidth	UINT64	For ELAN this is the bandwidth of branches.
internal-connection-point	LIST	List of internal connection points in this VLD
provider-network	CONTAINER	Container for the provider 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	STRING	Named reference to IP-profile object

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "short-name": "STRING",
    "description": "STRING",
    "type": "ELAN",
    "root-bandwidth": 0,
    "leaf-bandwidth": 0,
    "internal-connection-point": [
      {
        "id-ref": "STRING"
      }, {
        ...
      }
    ],
    "provider-network": {
      "physical-network": "STRING",
      "overlay-type": "LOCAL",
      "segmentation_id": 0
    },
    "vim-network-name": "STRING",
    "ip-profile-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-vld xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:type>ELAN</vnfr:type>
  <vnfr:root-bandwidth>0</vnfr:root-bandwidth>
  <vnfr:leaf-bandwidth>0</vnfr:leaf-bandwidth>
  <vnfr:internal-connection-point>
    <vnfr:id-ref>STRING</vnfr:id-ref>
  </vnfr:internal-connection-point>
  <vnfr:provider-network>
    <vnfr:physical-network>STRING</vnfr:physical-network>
    <vnfr:overlay-type>LOCAL</vnfr:overlay-type>
    <vnfr:segmentation_id>0</vnfr:segmentation_id>
  </vnfr:provider-network>
  <vnfr:vim-network-name>STRING</vnfr:vim-network-name>
  <vnfr:ip-profile-ref>STRING</vnfr:ip-profile-ref>
</vnfr:internal-vld>

vnfr:internal-connection-point

List of internal connection points in this VLD

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld/vnfr:internal-connection-point

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id-ref='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/internal-vld/STRING/internal-connection-point/STRING

Fields

Name	Type	Description
id-ref	LEAFREF	reference to the internal connection point id

JSON Sample

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

XML Sample

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

vnfr:provider-network

Container for the provider network.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:internal-vld/vnfr:provider-network

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:internal-vld[vnfr:id='STRING']/vnfr:provider-network

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/internal-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 Sample

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

XML Sample

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

vnfr:ip-profiles

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

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:ip-profiles[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 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 Sample

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

vnfr:ip-profile-params

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params

XPath Keyed Path

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

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 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 Sample

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

vnfr:dns-server

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params/vnfr:dns-server

XPath Keyed Path

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

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

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

XML Sample

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

vnfr:dhcp-params

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:ip-profiles/vnfr:ip-profile-params/vnfr:dhcp-params

XPath Keyed Path

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

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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 Sample

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

XML Sample

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

vnfr:connection-point

List for external connection points. Each VNF has one or more external connection points that connect the VNF to other VNFs or to external networks. Each VNF exposes connection points to the orchestrator, which can construct network services by connecting the connection points between different VNFs. The NFVO will use VLDs and VNFFGs at the network service level to construct network services.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:connection-point

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:connection-point[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/connection-point/STRING

Fields

Name	Type	Description
name	STRING	Name of the connection point
id	STRING	Identifier for the internal connection points
short-name	STRING	Short name to appear as label in the UI
type	ENUM	Type of the connection point.
port-security-enabled	BOOLEAN	Enables the port security for the port

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true
  }, {
    ...
  }
]

XML Sample

<vnfr:connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:id>STRING</vnfr:id>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
</vnfr:connection-point>

vnfr:vdu

List of Virtual Deployment Units

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING	Unique id for the VDU
name	STRING	Unique name for the VDU
description	STRING	Description of the VDU.
count	UINT64	Number of instances of VDU
mgmt-vpci	STRING	Specifies the virtual PCI address. Expressed in the following format dddd:dd:dd.d. For example 0000:00:12.0. This information can be used to pass as metadata during the VM creation.
vm-flavor	CONTAINER
guest-epa	CONTAINER
vswitch-epa	CONTAINER
hypervisor-epa	CONTAINER
host-epa	CONTAINER	Specifies the host level EPA attributes.
alarm	LIST
image	STRING	Image name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here.
image-checksum	STRING	Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL.
cloud-init	STRING	Contents of cloud-init script, provided inline, in cloud-config format
cloud-init-file	STRING	Name of file with contents of cloud-init script in cloud-config format
supplemental-boot-data	CONTAINER
internal-connection-point	LIST	List for internal connection points. Each VNFC has zero or more internal connection points. Internal connection points are used for connecting the VNF with components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points.
internal-interface	LIST	List of internal interfaces for the VNF
external-interface	LIST	List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF.
volumes	LIST

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "count": 0,
    "mgmt-vpci": "STRING",
    "vm-flavor": {
      "vcpu-count": 0,
      "memory-mb": 0,
      "storage-gb": 0
    },
    "guest-epa": {
      "trusted-execution": true,
      "mempage-size": "LARGE",
      "cpu-pinning-policy": "ANY",
      "cpu-thread-pinning-policy": "AVOID",
      "pcie-device": [ { ... }, { ... } ],
      "numa-unaware": [null],
      "numa-node-policy": { ... }
    },
    "vswitch-epa": {
      "ovs-acceleration": "MANDATORY",
      "ovs-offload": "MANDATORY"
    },
    "hypervisor-epa": {
      "type": "PREFER_KVM",
      "version": "STRING"
    },
    "host-epa": {
      "cpu-model": "PREFER_WESTMERE",
      "cpu-arch": "PREFER_X86",
      "cpu-vendor": "PREFER_INTEL",
      "cpu-socket-count": 0,
      "cpu-core-count": 0,
      "cpu-core-thread-count": 0,
      "cpu-feature": [ { ... }, { ... } ],
      "om-cpu-model-string": "STRING",
      "om-cpu-feature": [ { ... }, { ... } ]
    },
    "alarm": [
      {
        "alarm-id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "vdur-id": "STRING",
        "actions": { ... },
        "repeat": true,
        "enabled": true,
        "severity": "LOW",
        "metric": "CPU_UTILIZATION",
        "statistic": "AVERAGE",
        "operation": "GE",
        "value": 0.0,
        "period": 0,
        "evaluations": 0
      }, {
        ...
      }
    ],
    "image": "STRING",
    "image-checksum": "STRING",
    "cloud-init": "STRING",
    "cloud-init-file": "STRING",
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false
    },
    "internal-connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true
      }, {
        ...
      }
    ],
    "internal-interface": [
      {
        "name": "STRING",
        "vdu-internal-connection-point-ref": "STRING",
        "virtual-interface": { ... }
      }, {
        ...
      }
    ],
    "external-interface": [
      {
        "name": "STRING",
        "vnfd-connection-point-ref": "STRING",
        "virtual-interface": { ... }
      }, {
        ...
      }
    ],
    "volumes": [
      {
        "name": "STRING",
        "description": "STRING",
        "size": 0,
        "ephemeral": [null],
        "image": "STRING",
        "image-checksum": "STRING",
        "device-bus": "ide",
        "device-type": "disk"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:vdu xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:count>0</vnfr:count>
  <vnfr:mgmt-vpci>STRING</vnfr:mgmt-vpci>
  <vnfr:vm-flavor>
    <vnfr:vcpu-count>0</vnfr:vcpu-count>
    <vnfr:memory-mb>0</vnfr:memory-mb>
    <vnfr:storage-gb>0</vnfr:storage-gb>
  </vnfr:vm-flavor>
  <vnfr:guest-epa>
    <vnfr:trusted-execution>true</vnfr:trusted-execution>
    <vnfr:mempage-size>LARGE</vnfr:mempage-size>
    <vnfr:cpu-pinning-policy>ANY</vnfr:cpu-pinning-policy>
    <vnfr:cpu-thread-pinning-policy>AVOID</vnfr:cpu-thread-pinning-policy>
    <vnfr:pcie-device>...</vnfr:pcie-device>
    <vnfr:numa-unaware/>
    <vnfr:numa-node-policy>...</vnfr:numa-node-policy>
  </vnfr:guest-epa>
  <vnfr:vswitch-epa>
    <vnfr:ovs-acceleration>MANDATORY</vnfr:ovs-acceleration>
    <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
  </vnfr:vswitch-epa>
  <vnfr:hypervisor-epa>
    <vnfr:type>PREFER_KVM</vnfr:type>
    <vnfr:version>STRING</vnfr:version>
  </vnfr:hypervisor-epa>
  <vnfr:host-epa>
    <vnfr:cpu-model>PREFER_WESTMERE</vnfr:cpu-model>
    <vnfr:cpu-arch>PREFER_X86</vnfr:cpu-arch>
    <vnfr:cpu-vendor>PREFER_INTEL</vnfr:cpu-vendor>
    <vnfr:cpu-socket-count>0</vnfr:cpu-socket-count>
    <vnfr:cpu-core-count>0</vnfr:cpu-core-count>
    <vnfr:cpu-core-thread-count>0</vnfr:cpu-core-thread-count>
    <vnfr:cpu-feature>...</vnfr:cpu-feature>
    <vnfr:om-cpu-model-string>STRING</vnfr:om-cpu-model-string>
    <vnfr:om-cpu-feature>...</vnfr:om-cpu-feature>
  </vnfr:host-epa>
  <vnfr:alarm>
    <vnfr:alarm-id>STRING</vnfr:alarm-id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:vdur-id>STRING</vnfr:vdur-id>
    <vnfr:actions>...</vnfr:actions>
    <vnfr:repeat>true</vnfr:repeat>
    <vnfr:enabled>true</vnfr:enabled>
    <vnfr:severity>LOW</vnfr:severity>
    <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
    <vnfr:statistic>AVERAGE</vnfr:statistic>
    <vnfr:operation>GE</vnfr:operation>
    <vnfr:value>0.0</vnfr:value>
    <vnfr:period>0</vnfr:period>
    <vnfr:evaluations>0</vnfr:evaluations>
  </vnfr:alarm>
  <vnfr:image>STRING</vnfr:image>
  <vnfr:image-checksum>STRING</vnfr:image-checksum>
  <vnfr:cloud-init>STRING</vnfr:cloud-init>
  <vnfr:cloud-init-file>STRING</vnfr:cloud-init-file>
  <vnfr:supplemental-boot-data>
    <vnfr:config-file>...</vnfr:config-file>
    <vnfr:boot-data-drive>false</vnfr:boot-data-drive>
  </vnfr:supplemental-boot-data>
  <vnfr:internal-connection-point>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  </vnfr:internal-connection-point>
  <vnfr:internal-interface>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:vdu-internal-connection-point-ref>STRING</vnfr:vdu-internal-connection-point-ref>
    <vnfr:virtual-interface>...</vnfr:virtual-interface>
  </vnfr:internal-interface>
  <vnfr:external-interface>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:vnfd-connection-point-ref>STRING</vnfr:vnfd-connection-point-ref>
    <vnfr:virtual-interface>...</vnfr:virtual-interface>
  </vnfr:external-interface>
  <vnfr:volumes>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:size>0</vnfr:size>
    <vnfr:ephemeral/>
    <vnfr:image>STRING</vnfr:image>
    <vnfr:image-checksum>STRING</vnfr:image-checksum>
    <vnfr:device-bus>ide</vnfr:device-bus>
    <vnfr:device-type>disk</vnfr:device-type>
  </vnfr:volumes>
</vnfr:vdu>

vnfr:vm-flavor

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vm-flavor

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vm-flavor

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/vm-flavor

Fields

Name	Type	Description
vcpu-count	UINT16	Number of VCPUs for the VM.
memory-mb	UINT64	Amount of memory in MB.
storage-gb	UINT64	Amount of disk space in GB.

JSON Sample

{
  "vcpu-count": 0,
  "memory-mb": 0,
  "storage-gb": 0
}

XML Sample

<vnfr:vm-flavor xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:vcpu-count>0</vnfr:vcpu-count>
  <vnfr:memory-mb>0</vnfr:memory-mb>
  <vnfr:storage-gb>0</vnfr:storage-gb>
</vnfr:vm-flavor>

vnfr:guest-epa

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa

Fields

Name	Type	Description
trusted-execution	BOOLEAN	This VM should be allocated from trusted pool
mempage-size	ENUM	Memory page allocation size. If a VM requires hugepages, it should choose LARGE or SIZE_2MB or SIZE_1GB. If the VM prefers hugepages it should choose PREFER_LARGE. LARGE : Require hugepages (either 2MB or 1GB) SMALL : Doesn't require hugepages SIZE_2MB : Requires 2MB hugepages SIZE_1GB : Requires 1GB hugepages PREFER_LARGE : Application prefers hugepages
cpu-pinning-policy	ENUM	CPU pinning policy describes association between virtual CPUs in guest and the physical CPUs in the host. DEDICATED : Virtual CPUs are pinned to physical CPUs SHARED : Multiple VMs may share the same physical CPUs. ANY : Any policy is acceptable for the VM
cpu-thread-pinning-policy	ENUM	CPU thread pinning policy describes how to place the guest CPUs when the host supports hyper threads: AVOID : Avoids placing a guest on a host with threads. SEPARATE: Places vCPUs on separate cores, and avoids placing two vCPUs on two threads of same core. ISOLATE : Places each vCPU on a different core, and places no vCPUs from a different guest on the same core. PREFER : Attempts to place vCPUs on threads of the same core.
pcie-device	LIST	List of pcie passthrough devices.
numa-unaware	EMPTY
numa-node-policy	CONTAINER	This policy defines NUMA topology of the guest. Specifically identifies if the guest should be run on a host with one NUMA node or multiple NUMA nodes. As an example a guest might need 8 VCPUs and 4 GB of memory. However, it might need the VCPUs and memory distributed across multiple NUMA nodes. In this scenario, NUMA node 1 could run with 6 VCPUs and 3GB, and NUMA node 2 could run with 2 VCPUs and 1GB.

JSON Sample

{
  "trusted-execution": true,
  "mempage-size": "LARGE",
  "cpu-pinning-policy": "ANY",
  "cpu-thread-pinning-policy": "AVOID",
  "pcie-device": [
    {
      "device-id": "STRING",
      "count": 0
    }, {
      ...
    }
  ],
  "numa-unaware": [null],
  "numa-node-policy": {
    "node-cnt": 0,
    "mem-policy": "STRICT",
    "node": [ { ... }, { ... } ]
  }
}

XML Sample

<vnfr:guest-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:trusted-execution>true</vnfr:trusted-execution>
  <vnfr:mempage-size>LARGE</vnfr:mempage-size>
  <vnfr:cpu-pinning-policy>ANY</vnfr:cpu-pinning-policy>
  <vnfr:cpu-thread-pinning-policy>AVOID</vnfr:cpu-thread-pinning-policy>
  <vnfr:pcie-device>
    <vnfr:device-id>STRING</vnfr:device-id>
    <vnfr:count>0</vnfr:count>
  </vnfr:pcie-device>
  <vnfr:numa-unaware/>
  <vnfr:numa-node-policy>
    <vnfr:node-cnt>0</vnfr:node-cnt>
    <vnfr:mem-policy>STRICT</vnfr:mem-policy>
    <vnfr:node>...</vnfr:node>
  </vnfr:numa-node-policy>
</vnfr:guest-epa>

vnfr:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:pcie-device

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:pcie-device[vnfr:device-id='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/pcie-device/STRING

Fields

Name	Type	Description
device-id	STRING	Device identifier.
count	UINT64	Number of devices to attach to the VM.

JSON Sample

[
  {
    "device-id": "STRING",
    "count": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:pcie-device xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:device-id>STRING</vnfr:device-id>
  <vnfr:count>0</vnfr:count>
</vnfr:pcie-device>

vnfr:numa-node-policy

This policy defines NUMA topology of the guest. Specifically identifies if the guest should be run on a host with one NUMA node or multiple NUMA nodes. As an example a guest might need 8 VCPUs and 4 GB of memory. However, it might need the VCPUs and memory distributed across multiple NUMA nodes. In this scenario, NUMA node 1 could run with 6 VCPUs and 3GB, and NUMA node 2 could run with 2 VCPUs and 1GB.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy

Fields

Name	Type	Description
node-cnt	UINT16	The number of NUMA nodes to expose to the VM.
mem-policy	ENUM	This policy specifies how the memory should be allocated in a multi-node scenario. STRICT : The memory must be allocated strictly from the memory attached to the NUMA node. PREFERRED : The memory should be allocated preferentially from the memory attached to the NUMA node
node	LIST

JSON Sample

{
  "node-cnt": 0,
  "mem-policy": "STRICT",
  "node": [
    {
      "id": 0,
      "vcpu": [ { ... }, { ... } ],
      "memory-mb": 0,
      "num-cores": 0,
      "paired-threads": { ... },
      "num-threads": 0
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:numa-node-policy xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:node-cnt>0</vnfr:node-cnt>
  <vnfr:mem-policy>STRICT</vnfr:mem-policy>
  <vnfr:node>
    <vnfr:id>0</vnfr:id>
    <vnfr:vcpu>...</vnfr:vcpu>
    <vnfr:memory-mb>0</vnfr:memory-mb>
    <vnfr:num-cores>0</vnfr:num-cores>
    <vnfr:paired-threads>...</vnfr:paired-threads>
    <vnfr:num-threads>0</vnfr:num-threads>
  </vnfr:node>
</vnfr:numa-node-policy>

vnfr:node

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy/node/0

Fields

Name	Type	Description
id	UINT64	NUMA node identification. Typically it's 0 or 1
vcpu	LIST	List of VCPUs to allocate on this NUMA node.
memory-mb	UINT64	Memory size expressed in MB for this NUMA node.
num-cores	UINT8
paired-threads	CONTAINER
num-threads	UINT8

JSON Sample

[
  {
    "id": 0,
    "vcpu": [
      {
        "id": 0
      }, {
        ...
      }
    ],
    "memory-mb": 0,
    "num-cores": 0,
    "paired-threads": {
      "num-paired-threads": 0,
      "paired-thread-ids": [ { ... }, { ... } ]
    },
    "num-threads": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:node xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>0</vnfr:id>
  <vnfr:vcpu>
    <vnfr:id>0</vnfr:id>
  </vnfr:vcpu>
  <vnfr:memory-mb>0</vnfr:memory-mb>
  <vnfr:num-cores>0</vnfr:num-cores>
  <vnfr:paired-threads>
    <vnfr:num-paired-threads>0</vnfr:num-paired-threads>
    <vnfr:paired-thread-ids>...</vnfr:paired-thread-ids>
  </vnfr:paired-threads>
  <vnfr:num-threads>0</vnfr:num-threads>
</vnfr:node>

vnfr:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:vcpu

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:vcpu[vnfr:id='0']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy/node/0/vcpu/0

Fields

Name	Type	Description
id	UINT64	List of VCPUs ids to allocate on this NUMA node

JSON Sample

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

XML Sample

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

vnfr:paired-threads

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads

Fields

Name	Type	Description
num-paired-threads	UINT8
paired-thread-ids	LIST	List of thread pairs to use in case of paired-thread NUMA

JSON Sample

{
  "num-paired-threads": 0,
  "paired-thread-ids": [
    {
      "thread-a": 0,
      "thread-b": 0
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:paired-threads xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:num-paired-threads>0</vnfr:num-paired-threads>
  <vnfr:paired-thread-ids>
    <vnfr:thread-a>0</vnfr:thread-a>
    <vnfr:thread-b>0</vnfr:thread-b>
  </vnfr:paired-thread-ids>
</vnfr:paired-threads>

vnfr:paired-thread-ids

List of thread pairs to use in case of paired-thread NUMA

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads/vnfr:paired-thread-ids

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads/vnfr:paired-thread-ids[vnfr:thread-a='0']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/guest-epa/numa-node-policy/node/0/paired-threads/paired-thread-ids/0

Fields

Name	Type	Description
thread-a	UINT8
thread-b	UINT8

JSON Sample

[
  {
    "thread-a": 0,
    "thread-b": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:paired-thread-ids xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:thread-a>0</vnfr:thread-a>
  <vnfr:thread-b>0</vnfr:thread-b>
</vnfr:paired-thread-ids>

vnfr:vswitch-epa

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:vswitch-epa

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:vswitch-epa

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/vswitch-epa

Fields

Name	Type	Description
ovs-acceleration	ENUM	Specifies Open vSwitch acceleration mode. MANDATORY: OVS acceleration is required PREFERRED: OVS acceleration is preferred
ovs-offload	ENUM	Specifies Open vSwitch hardware offload mode. MANDATORY: OVS offload is required PREFERRED: OVS offload is preferred

JSON Sample

{
  "ovs-acceleration": "MANDATORY",
  "ovs-offload": "MANDATORY"
}

XML Sample

<vnfr:vswitch-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ovs-acceleration>MANDATORY</vnfr:ovs-acceleration>
  <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
</vnfr:vswitch-epa>

vnfr:hypervisor-epa

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:hypervisor-epa

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:hypervisor-epa

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/hypervisor-epa

Fields

Name	Type	Description
type	ENUM	Specifies the type of hypervisor. KVM: KVM XEN: XEN
version	STRING

JSON Sample

{
  "type": "PREFER_KVM",
  "version": "STRING"
}

XML Sample

<vnfr:hypervisor-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>PREFER_KVM</vnfr:type>
  <vnfr:version>STRING</vnfr:version>
</vnfr:hypervisor-epa>

vnfr:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/host-epa

Fields

Name	Type	Description
cpu-model	ENUM	Host CPU model. Examples include: SandyBridge, IvyBridge
cpu-arch	ENUM	Host CPU architecture.
cpu-vendor	ENUM	Host CPU Vendor.
cpu-socket-count	UINT64	Number of sockets on the host.
cpu-core-count	UINT64	Number of cores on the host.
cpu-core-thread-count	UINT64	Number of threads per cores on the host.
cpu-feature	LIST	List of CPU features.
om-cpu-model-string	STRING	OpenMANO CPU model string
om-cpu-feature	LIST	List of OpenMANO CPU features

JSON Sample

{
  "cpu-model": "PREFER_WESTMERE",
  "cpu-arch": "PREFER_X86",
  "cpu-vendor": "PREFER_INTEL",
  "cpu-socket-count": 0,
  "cpu-core-count": 0,
  "cpu-core-thread-count": 0,
  "cpu-feature": [
    {
      "feature": "PREFER_AES"
    }, {
      ...
    }
  ],
  "om-cpu-model-string": "STRING",
  "om-cpu-feature": [
    {
      "feature": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:host-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:cpu-model>PREFER_WESTMERE</vnfr:cpu-model>
  <vnfr:cpu-arch>PREFER_X86</vnfr:cpu-arch>
  <vnfr:cpu-vendor>PREFER_INTEL</vnfr:cpu-vendor>
  <vnfr:cpu-socket-count>0</vnfr:cpu-socket-count>
  <vnfr:cpu-core-count>0</vnfr:cpu-core-count>
  <vnfr:cpu-core-thread-count>0</vnfr:cpu-core-thread-count>
  <vnfr:cpu-feature>
    <vnfr:feature>PREFER_AES</vnfr:feature>
  </vnfr:cpu-feature>
  <vnfr:om-cpu-model-string>STRING</vnfr:om-cpu-model-string>
  <vnfr:om-cpu-feature>
    <vnfr:feature>STRING</vnfr:feature>
  </vnfr:om-cpu-feature>
</vnfr:host-epa>

vnfr:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa/vnfr:cpu-feature

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa/vnfr:cpu-feature[vnfr:feature='PREFER_AES']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

[
  {
    "feature": "PREFER_AES"
  }, {
    ...
  }
]

XML Sample

<vnfr:cpu-feature xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:feature>PREFER_AES</vnfr:feature>
</vnfr:cpu-feature>

vnfr:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:host-epa/vnfr:om-cpu-feature

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:host-epa/vnfr:om-cpu-feature[vnfr:feature='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

[
  {
    "feature": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:om-cpu-feature xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:feature>STRING</vnfr:feature>
</vnfr:om-cpu-feature>

vnfr:alarm

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING

Fields

Name	Type	Description
alarm-id	STRING	This field is reserved for the identifier assigned by the VIM provider
name	STRING	A human readable string to identify the alarm
description	STRING	A description of this alarm
vdur-id	STRING	The identifier of the VDUR that the alarm is associated with
actions	CONTAINER
repeat	BOOLEAN	This flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed.
enabled	BOOLEAN	This flag indicates whether the alarm has been enabled or disabled.
severity	ENUM	A measure of the importance or urgency of the alarm
metric	ENUM	The metric to be tracked by this alarm.
statistic	ENUM	The type of metric statistic that is tracked by this alarm
operation	ENUM	The relational operator used to define whether an alarm should be triggered in certain scenarios, such as if the metric statistic goes above or below a specified value.
value	DECIMAL64	This value defines the threshold that, if crossed, will trigger the alarm.
period	UINT32	The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic.
evaluations	UINT32	Defines the length of time (seconds) in which metric data are collected in order to evaluate the chosen statistic.

JSON Sample

[
  {
    "alarm-id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "vdur-id": "STRING",
    "actions": {
      "ok": [ { ... }, { ... } ],
      "insufficient-data": [ { ... }, { ... } ],
      "alarm": [ { ... }, { ... } ]
    },
    "repeat": true,
    "enabled": true,
    "severity": "LOW",
    "metric": "CPU_UTILIZATION",
    "statistic": "AVERAGE",
    "operation": "GE",
    "value": 0.0,
    "period": 0,
    "evaluations": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:alarm-id>STRING</vnfr:alarm-id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:vdur-id>STRING</vnfr:vdur-id>
  <vnfr:actions>
    <vnfr:ok>...</vnfr:ok>
    <vnfr:insufficient-data>...</vnfr:insufficient-data>
    <vnfr:alarm>...</vnfr:alarm>
  </vnfr:actions>
  <vnfr:repeat>true</vnfr:repeat>
  <vnfr:enabled>true</vnfr:enabled>
  <vnfr:severity>LOW</vnfr:severity>
  <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
  <vnfr:statistic>AVERAGE</vnfr:statistic>
  <vnfr:operation>GE</vnfr:operation>
  <vnfr:value>0.0</vnfr:value>
  <vnfr:period>0</vnfr:period>
  <vnfr:evaluations>0</vnfr:evaluations>
</vnfr:alarm>

vnfr:actions

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions

Fields

Name	Type	Description
ok	LIST
insufficient-data	LIST
alarm	LIST

JSON Sample

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:actions xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ok>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:ok>
  <vnfr:insufficient-data>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:insufficient-data>
  <vnfr:alarm>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:alarm>
</vnfr:actions>

vnfr:ok

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:ok

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:ok[vnfr:url='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/ok/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:ok xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:ok>

vnfr:insufficient-data

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:insufficient-data

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/insufficient-data/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:insufficient-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:insufficient-data>

vnfr:alarm

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:alarm/vnfr:actions/vnfr:alarm

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:alarm[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:alarm[vnfr:url='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/alarm/STRING/actions/alarm/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:alarm>

vnfr:supplemental-boot-data

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:supplemental-boot-data

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:supplemental-boot-data

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/supplemental-boot-data

Fields

Name	Type	Description
config-file	LIST	List of configuration files to be written on an additional drive
boot-data-drive	BOOLEAN	Some VIMs implement additional drives to host config-files or meta-data

JSON Sample

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false
}

XML Sample

<vnfr:supplemental-boot-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:config-file>
    <vnfr:source>STRING</vnfr:source>
    <vnfr:dest>STRING</vnfr:dest>
  </vnfr:config-file>
  <vnfr:boot-data-drive>false</vnfr:boot-data-drive>
</vnfr:supplemental-boot-data>

vnfr:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:supplemental-boot-data/vnfr:config-file

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:supplemental-boot-data/vnfr:config-file[vnfr:source='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/supplemental-boot-data/config-file/STRING

Fields

Name	Type	Description
source	STRING	Name of the configuration file
dest	STRING	Full path of the destination in the guest

JSON Sample

[
  {
    "source": "STRING",
    "dest": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:config-file xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:source>STRING</vnfr:source>
  <vnfr:dest>STRING</vnfr:dest>
</vnfr:config-file>

vnfr:internal-connection-point

List for internal connection points. Each VNFC has zero or more internal connection points. Internal connection points are used for connecting the VNF with components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-connection-point

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/internal-connection-point/STRING

Fields

Name	Type	Description
name	STRING	Name of the connection point
id	STRING	Identifier for the internal connection points
short-name	STRING	Short name to appear as label in the UI
type	ENUM	Type of the connection point.
port-security-enabled	BOOLEAN	Enables the port security for the port

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
</vnfr:internal-connection-point>

vnfr:internal-interface

List of internal interfaces for the VNF

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-interface

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/internal-interface/STRING

Fields

Name	Type	Description
name	STRING	Name of internal interface. Note that this name has only local significance to the VDU.
vdu-internal-connection-point-ref	LEAFREF
virtual-interface	CONTAINER	Container for the virtual interface properties

JSON Sample

[
  {
    "name": "STRING",
    "vdu-internal-connection-point-ref": "STRING",
    "virtual-interface": {
      "type": "VIRTIO",
      "vpci": "STRING",
      "bandwidth": 0
    }
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:vdu-internal-connection-point-ref>STRING</vnfr:vdu-internal-connection-point-ref>
  <vnfr:virtual-interface>
    <vnfr:type>VIRTIO</vnfr:type>
    <vnfr:vpci>STRING</vnfr:vpci>
    <vnfr:bandwidth>0</vnfr:bandwidth>
  </vnfr:virtual-interface>
</vnfr:internal-interface>

vnfr:virtual-interface

Container for the virtual interface properties

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:internal-interface/vnfr:virtual-interface

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING']/vnfr:virtual-interface

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/internal-interface/STRING/virtual-interface

Fields

Name	Type	Description
type	ENUM	Specifies the type of virtual interface between VM and host. VIRTIO : Use the traditional VIRTIO interface. PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface. SR-IOV : Use SR-IOV interface. E1000 : Emulate E1000 interface. RTL8139 : Emulate RTL8139 interface. PCNET : Emulate PCNET interface. OM-MGMT : Used to specify openmano mgmt external-connection type
vpci	STRING	Specifies the virtual PCI address. Expressed in the following format dddd:dd:dd.d. For example 0000:00:12.0. This information can be used to pass as metadata during the VM creation.
bandwidth	UINT64	Aggregate bandwidth of the NIC.

JSON Sample

{
  "type": "VIRTIO",
  "vpci": "STRING",
  "bandwidth": 0
}

XML Sample

<vnfr:virtual-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>VIRTIO</vnfr:type>
  <vnfr:vpci>STRING</vnfr:vpci>
  <vnfr:bandwidth>0</vnfr:bandwidth>
</vnfr:virtual-interface>

vnfr:external-interface

List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:external-interface

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/external-interface/STRING

Fields

Name	Type	Description
name	STRING	Name of the external interface. Note that this name has only local significance to the VDU.
vnfd-connection-point-ref	LEAFREF	Name of the external connection point.
virtual-interface	CONTAINER	Container for the virtual interface properties

JSON Sample

[
  {
    "name": "STRING",
    "vnfd-connection-point-ref": "STRING",
    "virtual-interface": {
      "type": "VIRTIO",
      "vpci": "STRING",
      "bandwidth": 0
    }
  }, {
    ...
  }
]

XML Sample

<vnfr:external-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:vnfd-connection-point-ref>STRING</vnfr:vnfd-connection-point-ref>
  <vnfr:virtual-interface>
    <vnfr:type>VIRTIO</vnfr:type>
    <vnfr:vpci>STRING</vnfr:vpci>
    <vnfr:bandwidth>0</vnfr:bandwidth>
  </vnfr:virtual-interface>
</vnfr:external-interface>

vnfr:virtual-interface

Container for the virtual interface properties

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:external-interface/vnfr:virtual-interface

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING']/vnfr:virtual-interface

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/external-interface/STRING/virtual-interface

Fields

Name	Type	Description
type	ENUM	Specifies the type of virtual interface between VM and host. VIRTIO : Use the traditional VIRTIO interface. PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface. SR-IOV : Use SR-IOV interface. E1000 : Emulate E1000 interface. RTL8139 : Emulate RTL8139 interface. PCNET : Emulate PCNET interface. OM-MGMT : Used to specify openmano mgmt external-connection type
vpci	STRING	Specifies the virtual PCI address. Expressed in the following format dddd:dd:dd.d. For example 0000:00:12.0. This information can be used to pass as metadata during the VM creation.
bandwidth	UINT64	Aggregate bandwidth of the NIC.

JSON Sample

{
  "type": "VIRTIO",
  "vpci": "STRING",
  "bandwidth": 0
}

XML Sample

<vnfr:virtual-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>VIRTIO</vnfr:type>
  <vnfr:vpci>STRING</vnfr:vpci>
  <vnfr:bandwidth>0</vnfr:bandwidth>
</vnfr:virtual-interface>

vnfr:volumes

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu/vnfr:volumes

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu[vnfr:id='STRING']/vnfr:volumes[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu/STRING/volumes/STRING

Fields

Name	Type	Description
name	STRING	Name of the disk-volumes, e.g. vda, vdb etc
description	STRING	Description for Volume
size	UINT64	Size of disk in GB
ephemeral	EMPTY
image	STRING	Image name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here.
image-checksum	STRING	Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL.
device-bus	ENUM	Type of disk-bus on which this disk is exposed to guest
device-type	ENUM	The type of device as exposed to guest

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "size": 0,
    "ephemeral": [null],
    "image": "STRING",
    "image-checksum": "STRING",
    "device-bus": "ide",
    "device-type": "disk"
  }, {
    ...
  }
]

XML Sample

<vnfr:volumes xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:size>0</vnfr:size>
  <vnfr:ephemeral/>
  <vnfr:image>STRING</vnfr:image>
  <vnfr:image-checksum>STRING</vnfr:image-checksum>
  <vnfr:device-bus>ide</vnfr:device-bus>
  <vnfr:device-type>disk</vnfr:device-type>
</vnfr:volumes>

vnfr:vdu-dependency

List of VDU dependencies.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:vdu-dependency

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:vdu-dependency[vnfr:vdu-source-ref='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/vdu-dependency/STRING

Fields

Name	Type	Description
vdu-source-ref	LEAFREF
vdu-depends-on-ref	LEAFREF	Reference to the VDU on which the source VDU depends.

JSON Sample

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

XML Sample

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

vnfr:http-endpoint

List of http endpoints to be used by monitoring params

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:http-endpoint

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:http-endpoint[vnfr:path='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/http-endpoint/STRING

Fields

Name	Type	Description
path	STRING	The HTTP path on the management server
https	BOOLEAN	Pick HTTPS instead of HTTP , Default is false
port	UINT16	The HTTP port to connect to
username	STRING	The HTTP basic auth username
password	STRING	The HTTP basic auth password
polling-interval-secs	UINT8	The HTTP polling interval in seconds
method	ENUM	Method that the URI should perform. Deafult action is GET.
headers	LIST	Custom HTTP headers to put on HTTP request

JSON Sample

[
  {
    "path": "STRING",
    "https": false,
    "port": 0,
    "username": "STRING",
    "password": "STRING",
    "polling-interval-secs": 2,
    "method": "GET",
    "headers": [
      {
        "key": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:http-endpoint xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:path>STRING</vnfr:path>
  <vnfr:https>false</vnfr:https>
  <vnfr:port>0</vnfr:port>
  <vnfr:username>STRING</vnfr:username>
  <vnfr:password>STRING</vnfr:password>
  <vnfr:polling-interval-secs>2</vnfr:polling-interval-secs>
  <vnfr:method>GET</vnfr:method>
  <vnfr:headers>
    <vnfr:key>STRING</vnfr:key>
    <vnfr:value>STRING</vnfr:value>
  </vnfr:headers>
</vnfr:http-endpoint>

vnfr:headers

Custom HTTP headers to put on HTTP request

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:http-endpoint/vnfr:headers

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:http-endpoint[vnfr:path='STRING']/vnfr:headers[vnfr:key='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/http-endpoint/STRING/headers/STRING

Fields

Name	Type	Description
key	STRING	HTTP header key
value	STRING	HTTP header value

JSON Sample

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

XML Sample

<vnfr:headers xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:key>STRING</vnfr:key>
  <vnfr:value>STRING</vnfr:value>
</vnfr:headers>

vnfr:monitoring-param

List of monitoring parameters at the network service level

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/monitoring-param/STRING

Fields

Name	Type	Description
id	STRING
name	STRING
http-endpoint-ref	LEAFREF
json-query-method	ENUM
json-query-params	CONTAINER
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.)
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

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "http-endpoint-ref": "STRING",
    "json-query-method": "NAMEKEY",
    "json-query-params": {
      "json-path": "STRING",
      "object-path": "STRING"
    },
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "HISTOGRAM",
    "units": "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"
  }, {
    ...
  }
]

XML Sample

<vnfr:monitoring-param xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:http-endpoint-ref>STRING</vnfr:http-endpoint-ref>
  <vnfr:json-query-method>NAMEKEY</vnfr:json-query-method>
  <vnfr:json-query-params>
    <vnfr:json-path>STRING</vnfr:json-path>
    <vnfr:object-path>STRING</vnfr:object-path>
  </vnfr:json-query-params>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:group-tag>STRING</vnfr:group-tag>
  <vnfr:widget-type>HISTOGRAM</vnfr:widget-type>
  <vnfr:units>STRING</vnfr:units>
  <vnfr:value-type>INT</vnfr:value-type>
  <vnfr:numeric-constraints>
    <vnfr:min-value>0</vnfr:min-value>
    <vnfr:max-value>0</vnfr:max-value>
  </vnfr:numeric-constraints>
  <vnfr:text-constraints>
    <vnfr:min-length>0</vnfr:min-length>
    <vnfr:max-length>0</vnfr:max-length>
  </vnfr:text-constraints>
  <vnfr:value-integer>0</vnfr:value-integer>
  <vnfr:value-decimal>0.0</vnfr:value-decimal>
  <vnfr:value-string>STRING</vnfr:value-string>
</vnfr:monitoring-param>

vnfr:json-query-params

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:json-query-params

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:json-query-params

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/monitoring-param/STRING/json-query-params

Fields

Name	Type	Description
json-path	STRING	The jsonpath to use to extract value from JSON structure
object-path	STRING	The objectpath to use to extract value from JSON structure

JSON Sample

{
  "json-path": "STRING",
  "object-path": "STRING"
}

XML Sample

<vnfr:json-query-params xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:json-path>STRING</vnfr:json-path>
  <vnfr:object-path>STRING</vnfr:object-path>
</vnfr:json-query-params>

vnfr:numeric-constraints

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:numeric-constraints

XPath Keyed Path

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

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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

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

vnfr:text-constraints

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:monitoring-param/vnfr:text-constraints

XPath Keyed Path

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

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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

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

vnfr:placement-groups

List of placement groups at VNF level

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:placement-groups

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:placement-groups[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/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-vdus	LIST	List of VDUs that are part of this placement group

JSON Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "member-vdus": [
      {
        "member-vdu-ref": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:placement-groups xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:requirement>STRING</vnfr:requirement>
  <vnfr:strategy>COLOCATION</vnfr:strategy>
  <vnfr:member-vdus>
    <vnfr:member-vdu-ref>STRING</vnfr:member-vdu-ref>
  </vnfr:member-vdus>
</vnfr:placement-groups>

vnfr:member-vdus

List of VDUs that are part of this placement group

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnfd/vnfr:placement-groups/vnfr:member-vdus

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnfd/vnfr:placement-groups[vnfr:name='STRING']/vnfr:member-vdus[vnfr:member-vdu-ref='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnfd/placement-groups/STRING/member-vdus/STRING

Fields

Name	Type	Description
member-vdu-ref	LEAFREF

JSON Sample

[
  {
    "member-vdu-ref": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:member-vdus xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:member-vdu-ref>STRING</vnfr:member-vdu-ref>
</vnfr:member-vdus>

vnfr:vnf-configuration

Information about the VNF configuration. Note: If the NS contains multiple instances of the same VNF, each instance could have a different configuration.

Key Identifiers:

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

Fields

Name	Type	Description
netconf	CONTAINER
rest	CONTAINER
script	CONTAINER
juju	CONTAINER
config-access	CONTAINER
config-attributes	CONTAINER	Miscellaneous input parameters to be considered while processing the NSD to apply configuration
service-primitive	LIST	List of service primitives supported by the configuration agent for this VNF.
initial-config-primitive	LIST	Initial set of configuration primitives.
config-template	STRING	Configuration template for each VNF

JSON Sample

{
  "netconf": {
    "target": "running",
    "protocol": "None",
    "port": 0
  },
  "rest": {
    "port": 0
  },
  "script": {
    "script-type": "bash"
  },
  "juju": {
    "charm": "STRING"
  },
  "config-access": {
    "mgmt-ip-address": "UNION_VALUE",
    "username": "STRING",
    "password": "STRING"
  },
  "config-attributes": {
    "config-priority": 0,
    "config-delay": 0
  },
  "service-primitive": [
    {
      "name": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "initial-config-primitive": [
    {
      "seq": 0,
      "name": "STRING",
      "user-defined-script": "STRING",
      "parameter": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "config-template": "STRING"
}

XML Sample

<vnfr:vnf-configuration xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:netconf>
    <vnfr:target>running</vnfr:target>
    <vnfr:protocol>None</vnfr:protocol>
    <vnfr:port>0</vnfr:port>
  </vnfr:netconf>
  <vnfr:rest>
    <vnfr:port>0</vnfr:port>
  </vnfr:rest>
  <vnfr:script>
    <vnfr:script-type>bash</vnfr:script-type>
  </vnfr:script>
  <vnfr:juju>
    <vnfr:charm>STRING</vnfr:charm>
  </vnfr:juju>
  <vnfr:config-access>
    <vnfr:mgmt-ip-address>UNION_VALUE</vnfr:mgmt-ip-address>
    <vnfr:username>STRING</vnfr:username>
    <vnfr:password>STRING</vnfr:password>
  </vnfr:config-access>
  <vnfr:config-attributes>
    <vnfr:config-priority>0</vnfr:config-priority>
    <vnfr:config-delay>0</vnfr:config-delay>
  </vnfr:config-attributes>
  <vnfr:service-primitive>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:parameter>...</vnfr:parameter>
  </vnfr:service-primitive>
  <vnfr:initial-config-primitive>
    <vnfr:seq>0</vnfr:seq>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:user-defined-script>STRING</vnfr:user-defined-script>
    <vnfr:parameter>...</vnfr:parameter>
  </vnfr:initial-config-primitive>
  <vnfr:config-template>STRING</vnfr:config-template>
</vnfr:vnf-configuration>

vnfr:netconf

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:netconf

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:netconf

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/netconf

Fields

Name	Type	Description
target	ENUM	Netconf configuration target
protocol	ENUM	Protocol to use for NETCONF, such as ssh
port	UINT16	Port for the NETCONF server.

JSON Sample

{
  "target": "running",
  "protocol": "None",
  "port": 0
}

XML Sample

<vnfr:netconf xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:target>running</vnfr:target>
  <vnfr:protocol>None</vnfr:protocol>
  <vnfr:port>0</vnfr:port>
</vnfr:netconf>

vnfr:rest

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:rest
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:rest
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/rest

Fields

Name	Type	Description
port	UINT16	Port for the REST server.

JSON Sample

{
  "port": 0
}

XML Sample

<vnfr:rest xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:port>0</vnfr:port>
</vnfr:rest>

vnfr:script

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:script
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:script
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/script

Fields

Name	Type	Description
script-type	ENUM	Script type - currently supported : bash, expect

JSON Sample

{
  "script-type": "bash"
}

XML Sample

<vnfr:script xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:script-type>bash</vnfr:script-type>
</vnfr:script>

vnfr:juju

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:juju
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:juju
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/juju

Fields

Name	Type	Description
charm	STRING	Juju charm to use with the VNF.

JSON Sample

{
  "charm": "STRING"
}

XML Sample

<vnfr:juju xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:charm>STRING</vnfr:charm>
</vnfr:juju>

vnfr:config-access

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:config-access

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:config-access

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/config-access

Fields

Name	Type	Description
mgmt-ip-address	UNION	IP address to be used to configure this VNF, optional if it is possible to resolve dynamically.
username	STRING	User name for configuration.
password	STRING	Password for configuration access authentication.

JSON Sample

{
  "mgmt-ip-address": "UNION_VALUE",
  "username": "STRING",
  "password": "STRING"
}

XML Sample

<vnfr:config-access xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:mgmt-ip-address>UNION_VALUE</vnfr:mgmt-ip-address>
  <vnfr:username>STRING</vnfr:username>
  <vnfr:password>STRING</vnfr:password>
</vnfr:config-access>

vnfr:config-attributes

Miscellaneous input parameters to be considered while processing the NSD to apply configuration

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:config-attributes

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:config-attributes

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/config-attributes

Fields

Name	Type	Description
config-priority	UINT64	Configuration priority - order of configuration to be applied to each VNF in this NS. A low number takes precedence over a high number
config-delay	UINT64	Wait (seconds) before applying the configuration to VNF

JSON Sample

{
  "config-priority": 0,
  "config-delay": 0
}

XML Sample

<vnfr:config-attributes xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:config-priority>0</vnfr:config-priority>
  <vnfr:config-delay>0</vnfr:config-delay>
</vnfr:config-attributes>

vnfr:service-primitive

List of service primitives supported by the configuration agent for this VNF.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:service-primitive

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/service-primitive/STRING

Fields

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

JSON Sample

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

XML Sample

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

vnfr:parameter

List of parameters to the service primitive.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:service-primitive/vnfr:parameter

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:service-primitive[vnfr:name='STRING']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/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

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

vnfr:initial-config-primitive

Initial set of configuration primitives.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:initial-config-primitive

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/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 Sample

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

XML Sample

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

vnfr:parameter

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vnf-configuration/vnfr:initial-config-primitive/vnfr:parameter

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vnf-configuration/vnfr:initial-config-primitive[vnfr:seq='0']/vnfr:parameter[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vnf-configuration/initial-config-primitive/0/parameter/STRING

Fields

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

JSON Sample

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

XML Sample

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

vnfr:mgmt-interface

Key Identifiers:

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

Fields

Name	Type	Description
ip-address	UNION
port	UINT16

JSON Sample

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

XML Sample

<vnfr:mgmt-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:port>0</vnfr:port>
</vnfr:mgmt-interface>

vnfr:internal-vlr

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:internal-vlr
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:internal-vlr[vnfr:vlr-ref='STRING']
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/internal-vlr/STRING

Fields

Name	Type	Description
vlr-ref	LEAFREF	Reference to a VLR record in the VLR catalog
internal-connection-point-ref	LEAF_LIST

JSON Sample

[
  {
    "vlr-ref": "STRING",
    "internal-connection-point-ref": [ "STRING", ... ]
  }, {
    ...
  }
]

XML Sample

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

vnfr:internal-connection-point-ref

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:internal-vlr/vnfr:internal-connection-point-ref

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:internal-vlr[vnfr:vlr-ref='STRING']/vnfr:internal-connection-point-ref

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/internal-vlr/STRING/internal-connection-point-ref

JSON Sample

[ "STRING", ... ]

XML Sample

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

vnfr:connection-point

List for external connection points. Each VNF has one or more external connection points. As the name implies that external connection points are used for connecting the VNF to other VNFs or to external networks. Each VNF exposes these connection points to the orchestrator. The orchestrator can construct network services by connecting the connection points between different VNFs. The NFVO will use VLDs and VNFFGs at the network service level to construct network services.

Key Identifiers:

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

Fields

Name	Type	Description
name	STRING	Name of the connection point
id	STRING	Identifier for the internal connection points
short-name	STRING	Short name to appear as label in the UI
type	ENUM	Type of the connection point.
port-security-enabled	BOOLEAN	Enables the port security for the port
vlr-ref	LEAFREF	Reference to the VLR associated with this connection point
ip-address	UNION	IP address assigned to the external connection point
mac-address	STRING	MAC address assigned to the external connection point
connection-point-id	STRING

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "vlr-ref": "STRING",
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING",
    "connection-point-id": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:id>STRING</vnfr:id>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  <vnfr:vlr-ref>STRING</vnfr:vlr-ref>
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:mac-address>STRING</vnfr:mac-address>
  <vnfr:connection-point-id>STRING</vnfr:connection-point-id>
</vnfr:connection-point>

vnfr:vdur

List of Virtual Deployment Units

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING	Unique id for the VDU
name	STRING	name of the instantiated VDUR
unique-short-name	STRING	Short Unique name of the VDU This will be of the format NSR name-ShortnedString-VDUname NSR name and VDU name shall be constrained to 10 characters
vdu-id-ref	LEAFREF
vim-id	STRING	Allocated VM resource id
flavor-id	STRING	VIM assigned flavor id
image-id	STRING	VIM assigned image id
management-ip	UNION	Management IP address
vm-management-ip	UNION	VM Private Management IP address
console-url	STRING	Console URL for this VDU, if available
vm-flavor	CONTAINER
guest-epa	CONTAINER
vswitch-epa	CONTAINER
hypervisor-epa	CONTAINER
host-epa	CONTAINER	Specifies the host level EPA attributes.
supplemental-boot-data	CONTAINER
volumes	LIST
alarms	LIST	A list of the alarms that have been created for this VDU
internal-connection-point	LIST	List for internal connection points. Each VNFC has zero or more internal connection points. Internal connection points are used for connecting the VNF components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points.
internal-interface	LIST	List of internal interfaces for the VNF
external-interface	LIST	List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF.
operational-status	ENUM	The operational status of the VDU init : The VDU has just started. vm-init-phase : The VDUs in the VNF is being created in VIM. vm-alloc-pending : The VM alloc is pending in VIM running : The VDU is active in VM terminate : The VDU is being terminated vm-terminate-phase : The VDU in the VNF is being terminated in VIM. terminated : The VDU is in the terminated state. failed : The VDU instantiation failed.
placement-groups-info	LIST	Placement groups to which this VDU belongs and its cloud construct

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "unique-short-name": "STRING",
    "vdu-id-ref": "STRING",
    "vim-id": "STRING",
    "flavor-id": "STRING",
    "image-id": "STRING",
    "management-ip": "UNION_VALUE",
    "vm-management-ip": "UNION_VALUE",
    "console-url": "STRING",
    "vm-flavor": {
      "vcpu-count": 0,
      "memory-mb": 0,
      "storage-gb": 0
    },
    "guest-epa": {
      "trusted-execution": true,
      "mempage-size": "LARGE",
      "cpu-pinning-policy": "ANY",
      "cpu-thread-pinning-policy": "AVOID",
      "pcie-device": [ { ... }, { ... } ],
      "numa-unaware": [null],
      "numa-node-policy": { ... }
    },
    "vswitch-epa": {
      "ovs-acceleration": "MANDATORY",
      "ovs-offload": "MANDATORY"
    },
    "hypervisor-epa": {
      "type": "PREFER_KVM",
      "version": "STRING"
    },
    "host-epa": {
      "cpu-model": "PREFER_WESTMERE",
      "cpu-arch": "PREFER_X86",
      "cpu-vendor": "PREFER_INTEL",
      "cpu-socket-count": 0,
      "cpu-core-count": 0,
      "cpu-core-thread-count": 0,
      "cpu-feature": [ { ... }, { ... } ],
      "om-cpu-model-string": "STRING",
      "om-cpu-feature": [ { ... }, { ... } ]
    },
    "supplemental-boot-data": {
      "config-file": [ { ... }, { ... } ],
      "boot-data-drive": false
    },
    "volumes": [
      {
        "name": "STRING",
        "volume-id": "STRING",
        "description": "STRING",
        "size": 0,
        "ephemeral": [null],
        "image": "STRING",
        "image-checksum": "STRING",
        "device-bus": "ide",
        "device-type": "disk"
      }, {
        ...
      }
    ],
    "alarms": [
      {
        "alarm-id": "STRING",
        "name": "STRING",
        "description": "STRING",
        "vdur-id": "STRING",
        "actions": { ... },
        "repeat": true,
        "enabled": true,
        "severity": "LOW",
        "metric": "CPU_UTILIZATION",
        "statistic": "AVERAGE",
        "operation": "GE",
        "value": 0.0,
        "period": 0,
        "evaluations": 0
      }, {
        ...
      }
    ],
    "internal-connection-point": [
      {
        "name": "STRING",
        "id": "STRING",
        "short-name": "STRING",
        "type": "VPORT",
        "port-security-enabled": true,
        "ip-address": "UNION_VALUE",
        "mac-address": "STRING"
      }, {
        ...
      }
    ],
    "internal-interface": [
      {
        "name": "STRING",
        "vdur-internal-connection-point-ref": "STRING",
        "virtual-interface": { ... }
      }, {
        ...
      }
    ],
    "external-interface": [
      {
        "name": "STRING",
        "vnfd-connection-point-ref": "STRING",
        "virtual-interface": { ... }
      }, {
        ...
      }
    ],
    "operational-status": "init",
    "placement-groups-info": [
      {
        "name": "STRING",
        "requirement": "STRING",
        "strategy": "COLOCATION",
        "cloud-type": "aws",
        "availability-zone": { ... },
        "server-group": { ... },
        "host-aggregate": [ { ... }, { ... } ],
        "aws-construct": [null],
        "openmano-construct": [null],
        "vsphere-construct": [null],
        "mock-construct": [null],
        "cloudsim-construct": [null]
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:vdur xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:unique-short-name>STRING</vnfr:unique-short-name>
  <vnfr:vdu-id-ref>STRING</vnfr:vdu-id-ref>
  <vnfr:vim-id>STRING</vnfr:vim-id>
  <vnfr:flavor-id>STRING</vnfr:flavor-id>
  <vnfr:image-id>STRING</vnfr:image-id>
  <vnfr:management-ip>UNION_VALUE</vnfr:management-ip>
  <vnfr:vm-management-ip>UNION_VALUE</vnfr:vm-management-ip>
  <vnfr:console-url>STRING</vnfr:console-url>
  <vnfr:vm-flavor>
    <vnfr:vcpu-count>0</vnfr:vcpu-count>
    <vnfr:memory-mb>0</vnfr:memory-mb>
    <vnfr:storage-gb>0</vnfr:storage-gb>
  </vnfr:vm-flavor>
  <vnfr:guest-epa>
    <vnfr:trusted-execution>true</vnfr:trusted-execution>
    <vnfr:mempage-size>LARGE</vnfr:mempage-size>
    <vnfr:cpu-pinning-policy>ANY</vnfr:cpu-pinning-policy>
    <vnfr:cpu-thread-pinning-policy>AVOID</vnfr:cpu-thread-pinning-policy>
    <vnfr:pcie-device>...</vnfr:pcie-device>
    <vnfr:numa-unaware/>
    <vnfr:numa-node-policy>...</vnfr:numa-node-policy>
  </vnfr:guest-epa>
  <vnfr:vswitch-epa>
    <vnfr:ovs-acceleration>MANDATORY</vnfr:ovs-acceleration>
    <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
  </vnfr:vswitch-epa>
  <vnfr:hypervisor-epa>
    <vnfr:type>PREFER_KVM</vnfr:type>
    <vnfr:version>STRING</vnfr:version>
  </vnfr:hypervisor-epa>
  <vnfr:host-epa>
    <vnfr:cpu-model>PREFER_WESTMERE</vnfr:cpu-model>
    <vnfr:cpu-arch>PREFER_X86</vnfr:cpu-arch>
    <vnfr:cpu-vendor>PREFER_INTEL</vnfr:cpu-vendor>
    <vnfr:cpu-socket-count>0</vnfr:cpu-socket-count>
    <vnfr:cpu-core-count>0</vnfr:cpu-core-count>
    <vnfr:cpu-core-thread-count>0</vnfr:cpu-core-thread-count>
    <vnfr:cpu-feature>...</vnfr:cpu-feature>
    <vnfr:om-cpu-model-string>STRING</vnfr:om-cpu-model-string>
    <vnfr:om-cpu-feature>...</vnfr:om-cpu-feature>
  </vnfr:host-epa>
  <vnfr:supplemental-boot-data>
    <vnfr:config-file>...</vnfr:config-file>
    <vnfr:boot-data-drive>false</vnfr:boot-data-drive>
  </vnfr:supplemental-boot-data>
  <vnfr:volumes>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:volume-id>STRING</vnfr:volume-id>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:size>0</vnfr:size>
    <vnfr:ephemeral/>
    <vnfr:image>STRING</vnfr:image>
    <vnfr:image-checksum>STRING</vnfr:image-checksum>
    <vnfr:device-bus>ide</vnfr:device-bus>
    <vnfr:device-type>disk</vnfr:device-type>
  </vnfr:volumes>
  <vnfr:alarms>
    <vnfr:alarm-id>STRING</vnfr:alarm-id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:vdur-id>STRING</vnfr:vdur-id>
    <vnfr:actions>...</vnfr:actions>
    <vnfr:repeat>true</vnfr:repeat>
    <vnfr:enabled>true</vnfr:enabled>
    <vnfr:severity>LOW</vnfr:severity>
    <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
    <vnfr:statistic>AVERAGE</vnfr:statistic>
    <vnfr:operation>GE</vnfr:operation>
    <vnfr:value>0.0</vnfr:value>
    <vnfr:period>0</vnfr:period>
    <vnfr:evaluations>0</vnfr:evaluations>
  </vnfr:alarms>
  <vnfr:internal-connection-point>
    <vnfr:id>STRING</vnfr:id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:short-name>STRING</vnfr:short-name>
    <vnfr:type>VPORT</vnfr:type>
    <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
    <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
    <vnfr:mac-address>STRING</vnfr:mac-address>
  </vnfr:internal-connection-point>
  <vnfr:internal-interface>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:vdur-internal-connection-point-ref>STRING</vnfr:vdur-internal-connection-point-ref>
    <vnfr:virtual-interface>...</vnfr:virtual-interface>
  </vnfr:internal-interface>
  <vnfr:external-interface>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:vnfd-connection-point-ref>STRING</vnfr:vnfd-connection-point-ref>
    <vnfr:virtual-interface>...</vnfr:virtual-interface>
  </vnfr:external-interface>
  <vnfr:operational-status>init</vnfr:operational-status>
  <vnfr:placement-groups-info>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:requirement>STRING</vnfr:requirement>
    <vnfr:strategy>COLOCATION</vnfr:strategy>
    <vnfr:cloud-type>aws</vnfr:cloud-type>
    <vnfr:availability-zone>...</vnfr:availability-zone>
    <vnfr:server-group>...</vnfr:server-group>
    <vnfr:host-aggregate>...</vnfr:host-aggregate>
    <vnfr:aws-construct/>
    <vnfr:openmano-construct/>
    <vnfr:vsphere-construct/>
    <vnfr:mock-construct/>
    <vnfr:cloudsim-construct/>
  </vnfr:placement-groups-info>
</vnfr:vdur>

vnfr:vm-flavor

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vm-flavor
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vm-flavor
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/vm-flavor

Fields

Name	Type	Description
vcpu-count	UINT16	Number of VCPUs for the VM.
memory-mb	UINT64	Amount of memory in MB.
storage-gb	UINT64	Amount of disk space in GB.

JSON Sample

{
  "vcpu-count": 0,
  "memory-mb": 0,
  "storage-gb": 0
}

XML Sample

<vnfr:vm-flavor xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:vcpu-count>0</vnfr:vcpu-count>
  <vnfr:memory-mb>0</vnfr:memory-mb>
  <vnfr:storage-gb>0</vnfr:storage-gb>
</vnfr:vm-flavor>

vnfr:guest-epa

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa

Fields

Name	Type	Description
trusted-execution	BOOLEAN	This VM should be allocated from trusted pool
mempage-size	ENUM	Memory page allocation size. If a VM requires hugepages, it should choose LARGE or SIZE_2MB or SIZE_1GB. If the VM prefers hugepages it should choose PREFER_LARGE. LARGE : Require hugepages (either 2MB or 1GB) SMALL : Doesn't require hugepages SIZE_2MB : Requires 2MB hugepages SIZE_1GB : Requires 1GB hugepages PREFER_LARGE : Application prefers hugepages
cpu-pinning-policy	ENUM	CPU pinning policy describes association between virtual CPUs in guest and the physical CPUs in the host. DEDICATED : Virtual CPUs are pinned to physical CPUs SHARED : Multiple VMs may share the same physical CPUs. ANY : Any policy is acceptable for the VM
cpu-thread-pinning-policy	ENUM	CPU thread pinning policy describes how to place the guest CPUs when the host supports hyper threads: AVOID : Avoids placing a guest on a host with threads. SEPARATE: Places vCPUs on separate cores, and avoids placing two vCPUs on two threads of same core. ISOLATE : Places each vCPU on a different core, and places no vCPUs from a different guest on the same core. PREFER : Attempts to place vCPUs on threads of the same core.
pcie-device	LIST	List of pcie passthrough devices.
numa-unaware	EMPTY
numa-node-policy	CONTAINER	This policy defines NUMA topology of the guest. Specifically identifies if the guest should be run on a host with one NUMA node or multiple NUMA nodes. As an example a guest might need 8 VCPUs and 4 GB of memory. However, it might need the VCPUs and memory distributed across multiple NUMA nodes. In this scenario, NUMA node 1 could run with 6 VCPUs and 3GB, and NUMA node 2 could run with 2 VCPUs and 1GB.

JSON Sample

{
  "trusted-execution": true,
  "mempage-size": "LARGE",
  "cpu-pinning-policy": "ANY",
  "cpu-thread-pinning-policy": "AVOID",
  "pcie-device": [
    {
      "device-id": "STRING",
      "count": 0
    }, {
      ...
    }
  ],
  "numa-unaware": [null],
  "numa-node-policy": {
    "node-cnt": 0,
    "mem-policy": "STRICT",
    "node": [ { ... }, { ... } ]
  }
}

XML Sample

<vnfr:guest-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:trusted-execution>true</vnfr:trusted-execution>
  <vnfr:mempage-size>LARGE</vnfr:mempage-size>
  <vnfr:cpu-pinning-policy>ANY</vnfr:cpu-pinning-policy>
  <vnfr:cpu-thread-pinning-policy>AVOID</vnfr:cpu-thread-pinning-policy>
  <vnfr:pcie-device>
    <vnfr:device-id>STRING</vnfr:device-id>
    <vnfr:count>0</vnfr:count>
  </vnfr:pcie-device>
  <vnfr:numa-unaware/>
  <vnfr:numa-node-policy>
    <vnfr:node-cnt>0</vnfr:node-cnt>
    <vnfr:mem-policy>STRICT</vnfr:mem-policy>
    <vnfr:node>...</vnfr:node>
  </vnfr:numa-node-policy>
</vnfr:guest-epa>

vnfr:pcie-device

List of pcie passthrough devices.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:pcie-device

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:pcie-device[vnfr:device-id='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/pcie-device/STRING

Fields

Name	Type	Description
device-id	STRING	Device identifier.
count	UINT64	Number of devices to attach to the VM.

JSON Sample

[
  {
    "device-id": "STRING",
    "count": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:pcie-device xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:device-id>STRING</vnfr:device-id>
  <vnfr:count>0</vnfr:count>
</vnfr:pcie-device>

vnfr:numa-node-policy

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy

Fields

Name	Type	Description
node-cnt	UINT16	The number of NUMA nodes to expose to the VM.
mem-policy	ENUM	This policy specifies how the memory should be allocated in a multi-node scenario. STRICT : The memory must be allocated strictly from the memory attached to the NUMA node. PREFERRED : The memory should be allocated preferentially from the memory attached to the NUMA node
node	LIST

JSON Sample

{
  "node-cnt": 0,
  "mem-policy": "STRICT",
  "node": [
    {
      "id": 0,
      "vcpu": [ { ... }, { ... } ],
      "memory-mb": 0,
      "num-cores": 0,
      "paired-threads": { ... },
      "num-threads": 0
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:numa-node-policy xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:node-cnt>0</vnfr:node-cnt>
  <vnfr:mem-policy>STRICT</vnfr:mem-policy>
  <vnfr:node>
    <vnfr:id>0</vnfr:id>
    <vnfr:vcpu>...</vnfr:vcpu>
    <vnfr:memory-mb>0</vnfr:memory-mb>
    <vnfr:num-cores>0</vnfr:num-cores>
    <vnfr:paired-threads>...</vnfr:paired-threads>
    <vnfr:num-threads>0</vnfr:num-threads>
  </vnfr:node>
</vnfr:numa-node-policy>

vnfr:node

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy/node/0

Fields

Name	Type	Description
id	UINT64	NUMA node identification. Typically it's 0 or 1
vcpu	LIST	List of VCPUs to allocate on this NUMA node.
memory-mb	UINT64	Memory size expressed in MB for this NUMA node.
num-cores	UINT8
paired-threads	CONTAINER
num-threads	UINT8

JSON Sample

[
  {
    "id": 0,
    "vcpu": [
      {
        "id": 0
      }, {
        ...
      }
    ],
    "memory-mb": 0,
    "num-cores": 0,
    "paired-threads": {
      "num-paired-threads": 0,
      "paired-thread-ids": [ { ... }, { ... } ]
    },
    "num-threads": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:node xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>0</vnfr:id>
  <vnfr:vcpu>
    <vnfr:id>0</vnfr:id>
  </vnfr:vcpu>
  <vnfr:memory-mb>0</vnfr:memory-mb>
  <vnfr:num-cores>0</vnfr:num-cores>
  <vnfr:paired-threads>
    <vnfr:num-paired-threads>0</vnfr:num-paired-threads>
    <vnfr:paired-thread-ids>...</vnfr:paired-thread-ids>
  </vnfr:paired-threads>
  <vnfr:num-threads>0</vnfr:num-threads>
</vnfr:node>

vnfr:vcpu

List of VCPUs to allocate on this NUMA node.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:vcpu

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:vcpu[vnfr:id='0']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy/node/0/vcpu/0

Fields

Name	Type	Description
id	UINT64	List of VCPUs ids to allocate on this NUMA node

JSON Sample

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

XML Sample

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

vnfr:paired-threads

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy/node/0/paired-threads

Fields

Name	Type	Description
num-paired-threads	UINT8
paired-thread-ids	LIST	List of thread pairs to use in case of paired-thread NUMA

JSON Sample

{
  "num-paired-threads": 0,
  "paired-thread-ids": [
    {
      "thread-a": 0,
      "thread-b": 0
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:paired-threads xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:num-paired-threads>0</vnfr:num-paired-threads>
  <vnfr:paired-thread-ids>
    <vnfr:thread-a>0</vnfr:thread-a>
    <vnfr:thread-b>0</vnfr:thread-b>
  </vnfr:paired-thread-ids>
</vnfr:paired-threads>

vnfr:paired-thread-ids

List of thread pairs to use in case of paired-thread NUMA

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node/vnfr:paired-threads/vnfr:paired-thread-ids

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:guest-epa/vnfr:numa-node-policy/vnfr:node[vnfr:id='0']/vnfr:paired-threads/vnfr:paired-thread-ids[vnfr:thread-a='0']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/guest-epa/numa-node-policy/node/0/paired-threads/paired-thread-ids/0

Fields

Name	Type	Description
thread-a	UINT8
thread-b	UINT8

JSON Sample

[
  {
    "thread-a": 0,
    "thread-b": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:paired-thread-ids xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:thread-a>0</vnfr:thread-a>
  <vnfr:thread-b>0</vnfr:thread-b>
</vnfr:paired-thread-ids>

vnfr:vswitch-epa

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:vswitch-epa
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:vswitch-epa
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/vswitch-epa

Fields

Name	Type	Description
ovs-acceleration	ENUM	Specifies Open vSwitch acceleration mode. MANDATORY: OVS acceleration is required PREFERRED: OVS acceleration is preferred
ovs-offload	ENUM	Specifies Open vSwitch hardware offload mode. MANDATORY: OVS offload is required PREFERRED: OVS offload is preferred

JSON Sample

{
  "ovs-acceleration": "MANDATORY",
  "ovs-offload": "MANDATORY"
}

XML Sample

<vnfr:vswitch-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ovs-acceleration>MANDATORY</vnfr:ovs-acceleration>
  <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
</vnfr:vswitch-epa>

vnfr:hypervisor-epa

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:hypervisor-epa

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:hypervisor-epa

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/hypervisor-epa

Fields

Name	Type	Description
type	ENUM	Specifies the type of hypervisor. KVM: KVM XEN: XEN
version	STRING

JSON Sample

{
  "type": "PREFER_KVM",
  "version": "STRING"
}

XML Sample

<vnfr:hypervisor-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>PREFER_KVM</vnfr:type>
  <vnfr:version>STRING</vnfr:version>
</vnfr:hypervisor-epa>

vnfr:host-epa

Specifies the host level EPA attributes.

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/host-epa

Fields

Name	Type	Description
cpu-model	ENUM	Host CPU model. Examples include: SandyBridge, IvyBridge
cpu-arch	ENUM	Host CPU architecture.
cpu-vendor	ENUM	Host CPU Vendor.
cpu-socket-count	UINT64	Number of sockets on the host.
cpu-core-count	UINT64	Number of cores on the host.
cpu-core-thread-count	UINT64	Number of threads per cores on the host.
cpu-feature	LIST	List of CPU features.
om-cpu-model-string	STRING	OpenMANO CPU model string
om-cpu-feature	LIST	List of OpenMANO CPU features

JSON Sample

{
  "cpu-model": "PREFER_WESTMERE",
  "cpu-arch": "PREFER_X86",
  "cpu-vendor": "PREFER_INTEL",
  "cpu-socket-count": 0,
  "cpu-core-count": 0,
  "cpu-core-thread-count": 0,
  "cpu-feature": [
    {
      "feature": "PREFER_AES"
    }, {
      ...
    }
  ],
  "om-cpu-model-string": "STRING",
  "om-cpu-feature": [
    {
      "feature": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:host-epa xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:cpu-model>PREFER_WESTMERE</vnfr:cpu-model>
  <vnfr:cpu-arch>PREFER_X86</vnfr:cpu-arch>
  <vnfr:cpu-vendor>PREFER_INTEL</vnfr:cpu-vendor>
  <vnfr:cpu-socket-count>0</vnfr:cpu-socket-count>
  <vnfr:cpu-core-count>0</vnfr:cpu-core-count>
  <vnfr:cpu-core-thread-count>0</vnfr:cpu-core-thread-count>
  <vnfr:cpu-feature>
    <vnfr:feature>PREFER_AES</vnfr:feature>
  </vnfr:cpu-feature>
  <vnfr:om-cpu-model-string>STRING</vnfr:om-cpu-model-string>
  <vnfr:om-cpu-feature>
    <vnfr:feature>STRING</vnfr:feature>
  </vnfr:om-cpu-feature>
</vnfr:host-epa>

vnfr:cpu-feature

List of CPU features.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa/vnfr:cpu-feature

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa/vnfr:cpu-feature[vnfr:feature='PREFER_AES']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/host-epa/cpu-feature/PREFER_AES

Fields

Name	Type	Description
feature	ENUM	CPU feature.

JSON Sample

[
  {
    "feature": "PREFER_AES"
  }, {
    ...
  }
]

XML Sample

<vnfr:cpu-feature xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:feature>PREFER_AES</vnfr:feature>
</vnfr:cpu-feature>

vnfr:om-cpu-feature

List of OpenMANO CPU features

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:host-epa/vnfr:om-cpu-feature

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:host-epa/vnfr:om-cpu-feature[vnfr:feature='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/host-epa/om-cpu-feature/STRING

Fields

Name	Type	Description
feature	STRING	CPU feature

JSON Sample

[
  {
    "feature": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:om-cpu-feature xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:feature>STRING</vnfr:feature>
</vnfr:om-cpu-feature>

vnfr:supplemental-boot-data

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:supplemental-boot-data

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:supplemental-boot-data

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/supplemental-boot-data

Fields

Name	Type	Description
config-file	LIST	List of configuration files to be written on an additional drive
boot-data-drive	BOOLEAN	Some VIMs implement additional drives to host config-files or meta-data

JSON Sample

{
  "config-file": [
    {
      "source": "STRING",
      "dest": "STRING"
    }, {
      ...
    }
  ],
  "boot-data-drive": false
}

XML Sample

<vnfr:supplemental-boot-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:config-file>
    <vnfr:source>STRING</vnfr:source>
    <vnfr:dest>STRING</vnfr:dest>
  </vnfr:config-file>
  <vnfr:boot-data-drive>false</vnfr:boot-data-drive>
</vnfr:supplemental-boot-data>

vnfr:config-file

List of configuration files to be written on an additional drive

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:supplemental-boot-data/vnfr:config-file

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:supplemental-boot-data/vnfr:config-file[vnfr:source='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/supplemental-boot-data/config-file/STRING

Fields

Name	Type	Description
source	STRING	Name of the configuration file
dest	STRING	Full path of the destination in the guest

JSON Sample

[
  {
    "source": "STRING",
    "dest": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:config-file xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:source>STRING</vnfr:source>
  <vnfr:dest>STRING</vnfr:dest>
</vnfr:config-file>

vnfr:volumes

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:volumes

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:volumes[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/volumes/STRING

Fields

Name	Type	Description
name	STRING	Name of the disk-volumes, e.g. vda, vdb etc
volume-id	STRING	VIM assigned volume id
description	STRING	Description for Volume
size	UINT64	Size of disk in GB
ephemeral	EMPTY
image	STRING	Image name for the software image. If the image name is found within the VNF package it will be uploaded to all VIM accounts during onboarding process. Otherwise, the image must be added to the VIM account with the same name as entered here.
image-checksum	STRING	Image md5sum for the software image. The md5sum, if provided, along with the image name uniquely identifies an image uploaded to the CAL.
device-bus	ENUM	Type of disk-bus on which this disk is exposed to guest
device-type	ENUM	The type of device as exposed to guest

JSON Sample

[
  {
    "name": "STRING",
    "volume-id": "STRING",
    "description": "STRING",
    "size": 0,
    "ephemeral": [null],
    "image": "STRING",
    "image-checksum": "STRING",
    "device-bus": "ide",
    "device-type": "disk"
  }, {
    ...
  }
]

XML Sample

<vnfr:volumes xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:volume-id>STRING</vnfr:volume-id>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:size>0</vnfr:size>
  <vnfr:ephemeral/>
  <vnfr:image>STRING</vnfr:image>
  <vnfr:image-checksum>STRING</vnfr:image-checksum>
  <vnfr:device-bus>ide</vnfr:device-bus>
  <vnfr:device-type>disk</vnfr:device-type>
</vnfr:volumes>

vnfr:alarms

A list of the alarms that have been created for this VDU

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING

Fields

Name	Type	Description
alarm-id	STRING	This field is reserved for the identifier assigned by the VIM provider
name	STRING	A human readable string to identify the alarm
description	STRING	A description of this alarm
vdur-id	STRING	The identifier of the VDUR that the alarm is associated with
actions	CONTAINER
repeat	BOOLEAN	This flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed.
enabled	BOOLEAN	This flag indicates whether the alarm has been enabled or disabled.
severity	ENUM	A measure of the importance or urgency of the alarm
metric	ENUM	The metric to be tracked by this alarm.
statistic	ENUM	The type of metric statistic that is tracked by this alarm
operation	ENUM	The relational operator used to define whether an alarm should be triggered in certain scenarios, such as if the metric statistic goes above or below a specified value.
value	DECIMAL64	This value defines the threshold that, if crossed, will trigger the alarm.
period	UINT32	The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic.
evaluations	UINT32	Defines the length of time (seconds) in which metric data are collected in order to evaluate the chosen statistic.

JSON Sample

[
  {
    "alarm-id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "vdur-id": "STRING",
    "actions": {
      "ok": [ { ... }, { ... } ],
      "insufficient-data": [ { ... }, { ... } ],
      "alarm": [ { ... }, { ... } ]
    },
    "repeat": true,
    "enabled": true,
    "severity": "LOW",
    "metric": "CPU_UTILIZATION",
    "statistic": "AVERAGE",
    "operation": "GE",
    "value": 0.0,
    "period": 0,
    "evaluations": 0
  }, {
    ...
  }
]

XML Sample

<vnfr:alarms xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:alarm-id>STRING</vnfr:alarm-id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:vdur-id>STRING</vnfr:vdur-id>
  <vnfr:actions>
    <vnfr:ok>...</vnfr:ok>
    <vnfr:insufficient-data>...</vnfr:insufficient-data>
    <vnfr:alarm>...</vnfr:alarm>
  </vnfr:actions>
  <vnfr:repeat>true</vnfr:repeat>
  <vnfr:enabled>true</vnfr:enabled>
  <vnfr:severity>LOW</vnfr:severity>
  <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
  <vnfr:statistic>AVERAGE</vnfr:statistic>
  <vnfr:operation>GE</vnfr:operation>
  <vnfr:value>0.0</vnfr:value>
  <vnfr:period>0</vnfr:period>
  <vnfr:evaluations>0</vnfr:evaluations>
</vnfr:alarms>

vnfr:actions

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING/actions

Fields

Name	Type	Description
ok	LIST
insufficient-data	LIST
alarm	LIST

JSON Sample

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<vnfr:actions xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ok>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:ok>
  <vnfr:insufficient-data>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:insufficient-data>
  <vnfr:alarm>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:alarm>
</vnfr:actions>

vnfr:ok

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:ok

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:ok[vnfr:url='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING/actions/ok/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:ok xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:ok>

vnfr:insufficient-data

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:insufficient-data

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING/actions/insufficient-data/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:insufficient-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:insufficient-data>

vnfr:alarm

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:alarms/vnfr:actions/vnfr:alarm

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:alarms[vnfr:alarm-id='STRING']/vnfr:actions/vnfr:alarm[vnfr:url='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/alarms/STRING/actions/alarm/STRING

Fields

Name	Type	Description
url	STRING

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:alarm>

vnfr:internal-connection-point

List for internal connection points. Each VNFC has zero or more internal connection points. Internal connection points are used for connecting the VNF components internal to the VNF. If a VNF has only one VNFC, it may not have any internal connection points.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-connection-point

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-connection-point[vnfr:id='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/internal-connection-point/STRING

Fields

Name	Type	Description
name	STRING	Name of the connection point
id	STRING	Identifier for the internal connection points
short-name	STRING	Short name to appear as label in the UI
type	ENUM	Type of the connection point.
port-security-enabled	BOOLEAN	Enables the port security for the port
ip-address	UNION	IP address assigned to the internal connection point
mac-address	STRING	MAC address assigned to the internal connection point

JSON Sample

[
  {
    "name": "STRING",
    "id": "STRING",
    "short-name": "STRING",
    "type": "VPORT",
    "port-security-enabled": true,
    "ip-address": "UNION_VALUE",
    "mac-address": "STRING"
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-connection-point xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:short-name>STRING</vnfr:short-name>
  <vnfr:type>VPORT</vnfr:type>
  <vnfr:port-security-enabled>true</vnfr:port-security-enabled>
  <vnfr:ip-address>UNION_VALUE</vnfr:ip-address>
  <vnfr:mac-address>STRING</vnfr:mac-address>
</vnfr:internal-connection-point>

vnfr:internal-interface

List of internal interfaces for the VNF

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-interface

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/internal-interface/STRING

Fields

Name	Type	Description
name	STRING	Name of internal interface. Note that this name has only local significance to the VDU.
vdur-internal-connection-point-ref	LEAFREF
virtual-interface	CONTAINER	Container for the virtual interface properties

JSON Sample

[
  {
    "name": "STRING",
    "vdur-internal-connection-point-ref": "STRING",
    "virtual-interface": {
      "type": "VIRTIO",
      "bandwidth": 0,
      "ovs-offload": "MANDATORY",
      "vendor-id": "STRING",
      "datapath-library": "STRING",
      "provider-network-name": "STRING"
    }
  }, {
    ...
  }
]

XML Sample

<vnfr:internal-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:vdur-internal-connection-point-ref>STRING</vnfr:vdur-internal-connection-point-ref>
  <vnfr:virtual-interface>
    <vnfr:type>VIRTIO</vnfr:type>
    <vnfr:bandwidth>0</vnfr:bandwidth>
    <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
    <vnfr:vendor-id>STRING</vnfr:vendor-id>
    <vnfr:datapath-library>STRING</vnfr:datapath-library>
    <vnfr:provider-network-name>STRING</vnfr:provider-network-name>
  </vnfr:virtual-interface>
</vnfr:internal-interface>

vnfr:virtual-interface

Container for the virtual interface properties

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:internal-interface/vnfr:virtual-interface

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:internal-interface[vnfr:name='STRING']/vnfr:virtual-interface

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/internal-interface/STRING/virtual-interface

Fields

Name	Type	Description
type	ENUM	Specifies the type of virtual interface between VM and host. VIRTIO : Use the traditional VIRTIO interface. PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface. SR-IOV : Use SR-IOV interface.
bandwidth	UINT64	Aggregate bandwidth of the NIC.
ovs-offload	ENUM	Defines if the NIC supports OVS offload. MANDATORY : OVS offload support in the NIC is mandatory. PREFERRED : OVS offload support in the NIC is preferred.
vendor-id	STRING	Specifies the vendor specific id for the device. This is used when a NIC from specific HW vendor is required.
datapath-library	STRING	Specifies the name and version of the datapath library the NIC is expected to support.
provider-network-name	STRING	Name of the provider network to which this NIC is attached.

JSON Sample

{
  "type": "VIRTIO",
  "bandwidth": 0,
  "ovs-offload": "MANDATORY",
  "vendor-id": "STRING",
  "datapath-library": "STRING",
  "provider-network-name": "STRING"
}

XML Sample

<vnfr:virtual-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>VIRTIO</vnfr:type>
  <vnfr:bandwidth>0</vnfr:bandwidth>
  <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
  <vnfr:vendor-id>STRING</vnfr:vendor-id>
  <vnfr:datapath-library>STRING</vnfr:datapath-library>
  <vnfr:provider-network-name>STRING</vnfr:provider-network-name>
</vnfr:virtual-interface>

vnfr:external-interface

List of external interfaces for the VNF. The external interfaces enable sending traffic to and from VNF.

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:external-interface

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/external-interface/STRING

Fields

Name	Type	Description
name	STRING	Name of the external interface. Note that this name has only local significance.
vnfd-connection-point-ref	LEAFREF	Name of the external connection point.
virtual-interface	CONTAINER	Container for the virtual interface properties

JSON Sample

[
  {
    "name": "STRING",
    "vnfd-connection-point-ref": "STRING",
    "virtual-interface": {
      "type": "VIRTIO",
      "bandwidth": 0,
      "ovs-offload": "MANDATORY",
      "vendor-id": "STRING",
      "datapath-library": "STRING",
      "provider-network-name": "STRING"
    }
  }, {
    ...
  }
]

XML Sample

<vnfr:external-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:vnfd-connection-point-ref>STRING</vnfr:vnfd-connection-point-ref>
  <vnfr:virtual-interface>
    <vnfr:type>VIRTIO</vnfr:type>
    <vnfr:bandwidth>0</vnfr:bandwidth>
    <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
    <vnfr:vendor-id>STRING</vnfr:vendor-id>
    <vnfr:datapath-library>STRING</vnfr:datapath-library>
    <vnfr:provider-network-name>STRING</vnfr:provider-network-name>
  </vnfr:virtual-interface>
</vnfr:external-interface>

vnfr:virtual-interface

Container for the virtual interface properties

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:external-interface/vnfr:virtual-interface

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:external-interface[vnfr:name='STRING']/vnfr:virtual-interface

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/external-interface/STRING/virtual-interface

Fields

Name	Type	Description
type	ENUM	Specifies the type of virtual interface between VM and host. VIRTIO : Use the traditional VIRTIO interface. PCI-PASSTHROUGH : Use PCI-PASSTHROUGH interface. SR-IOV : Use SR-IOV interface.
bandwidth	UINT64	Aggregate bandwidth of the NIC.
ovs-offload	ENUM	Defines if the NIC supports OVS offload. MANDATORY : OVS offload support in the NIC is mandatory. PREFERRED : OVS offload support in the NIC is preferred.
vendor-id	STRING	Specifies the vendor specific id for the device. This is used when a NIC from specific HW vendor is required.
datapath-library	STRING	Specifies the name and version of the datapath library the NIC is expected to support.
provider-network-name	STRING	Name of the provider network to which this NIC is attached.

JSON Sample

{
  "type": "VIRTIO",
  "bandwidth": 0,
  "ovs-offload": "MANDATORY",
  "vendor-id": "STRING",
  "datapath-library": "STRING",
  "provider-network-name": "STRING"
}

XML Sample

<vnfr:virtual-interface xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:type>VIRTIO</vnfr:type>
  <vnfr:bandwidth>0</vnfr:bandwidth>
  <vnfr:ovs-offload>MANDATORY</vnfr:ovs-offload>
  <vnfr:vendor-id>STRING</vnfr:vendor-id>
  <vnfr:datapath-library>STRING</vnfr:datapath-library>
  <vnfr:provider-network-name>STRING</vnfr:provider-network-name>
</vnfr:virtual-interface>

vnfr:placement-groups-info

Placement groups to which this VDU belongs and its cloud construct

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/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.
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 Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "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 Sample

<vnfr:placement-groups-info xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:requirement>STRING</vnfr:requirement>
  <vnfr:strategy>COLOCATION</vnfr:strategy>
  <vnfr:cloud-type>aws</vnfr:cloud-type>
  <vnfr:availability-zone>
    <vnfr:name>STRING</vnfr:name>
  </vnfr:availability-zone>
  <vnfr:server-group>
    <vnfr:name>STRING</vnfr:name>
  </vnfr:server-group>
  <vnfr:host-aggregate>
    <vnfr:metadata-key>STRING</vnfr:metadata-key>
    <vnfr:metadata-value>STRING</vnfr:metadata-value>
  </vnfr:host-aggregate>
  <vnfr:aws-construct/>
  <vnfr:openmano-construct/>
  <vnfr:vsphere-construct/>
  <vnfr:mock-construct/>
  <vnfr:cloudsim-construct/>
</vnfr:placement-groups-info>

vnfr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:availability-zone

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:availability-zone

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

vnfr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:server-group

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:server-group

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

vnfr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:vdur/vnfr:placement-groups-info/vnfr:host-aggregate

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:vdur[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:host-aggregate[vnfr:metadata-key='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/vdur/STRING/placement-groups-info/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 Sample

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

XML Sample

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

vnfr:http-endpoint

List of http endpoints to be used by monitoring params

Key Identifiers:

XPath Path	/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:http-endpoint
XPath Keyed Path	/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:http-endpoint[vnfr:path='STRING']
RW.REST URI Path	/vnfr:vnfr-catalog/vnfr/STRING/http-endpoint/STRING

Fields

Name	Type	Description
path	STRING	The HTTP path on the management server
https	BOOLEAN	Pick HTTPS instead of HTTP , Default is false
port	UINT16	The HTTP port to connect to
username	STRING	The HTTP basic auth username
password	STRING	The HTTP basic auth password
polling-interval-secs	UINT8	The HTTP polling interval in seconds
method	ENUM	Method that the URI should perform. Deafult action is GET.
headers	LIST	Custom HTTP headers to put on HTTP request

JSON Sample

[
  {
    "path": "STRING",
    "https": false,
    "port": 0,
    "username": "STRING",
    "password": "STRING",
    "polling-interval-secs": 2,
    "method": "GET",
    "headers": [
      {
        "key": "STRING",
        "value": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<vnfr:http-endpoint xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:path>STRING</vnfr:path>
  <vnfr:https>false</vnfr:https>
  <vnfr:port>0</vnfr:port>
  <vnfr:username>STRING</vnfr:username>
  <vnfr:password>STRING</vnfr:password>
  <vnfr:polling-interval-secs>2</vnfr:polling-interval-secs>
  <vnfr:method>GET</vnfr:method>
  <vnfr:headers>
    <vnfr:key>STRING</vnfr:key>
    <vnfr:value>STRING</vnfr:value>
  </vnfr:headers>
</vnfr:http-endpoint>

vnfr:headers

Custom HTTP headers to put on HTTP request

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:http-endpoint/vnfr:headers

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:http-endpoint[vnfr:path='STRING']/vnfr:headers[vnfr:key='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/http-endpoint/STRING/headers/STRING

Fields

Name	Type	Description
key	STRING	HTTP header key
value	STRING	HTTP header value

JSON Sample

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

XML Sample

<vnfr:headers xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:key>STRING</vnfr:key>
  <vnfr:value>STRING</vnfr:value>
</vnfr:headers>

vnfr:monitoring-param

List of monitoring parameters at the network service level

Key Identifiers:

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

Fields

Name	Type	Description
id	STRING
name	STRING
http-endpoint-ref	LEAFREF
json-query-method	ENUM
json-query-params	CONTAINER
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.)
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

JSON Sample

[
  {
    "id": "STRING",
    "name": "STRING",
    "http-endpoint-ref": "STRING",
    "json-query-method": "NAMEKEY",
    "json-query-params": {
      "json-path": "STRING",
      "object-path": "STRING"
    },
    "description": "STRING",
    "group-tag": "STRING",
    "widget-type": "HISTOGRAM",
    "units": "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"
  }, {
    ...
  }
]

XML Sample

<vnfr:monitoring-param xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:id>STRING</vnfr:id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:http-endpoint-ref>STRING</vnfr:http-endpoint-ref>
  <vnfr:json-query-method>NAMEKEY</vnfr:json-query-method>
  <vnfr:json-query-params>
    <vnfr:json-path>STRING</vnfr:json-path>
    <vnfr:object-path>STRING</vnfr:object-path>
  </vnfr:json-query-params>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:group-tag>STRING</vnfr:group-tag>
  <vnfr:widget-type>HISTOGRAM</vnfr:widget-type>
  <vnfr:units>STRING</vnfr:units>
  <vnfr:value-type>INT</vnfr:value-type>
  <vnfr:numeric-constraints>
    <vnfr:min-value>0</vnfr:min-value>
    <vnfr:max-value>0</vnfr:max-value>
  </vnfr:numeric-constraints>
  <vnfr:text-constraints>
    <vnfr:min-length>0</vnfr:min-length>
    <vnfr:max-length>0</vnfr:max-length>
  </vnfr:text-constraints>
  <vnfr:value-integer>0</vnfr:value-integer>
  <vnfr:value-decimal>0.0</vnfr:value-decimal>
  <vnfr:value-string>STRING</vnfr:value-string>
</vnfr:monitoring-param>

vnfr:json-query-params

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:monitoring-param/vnfr:json-query-params

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:monitoring-param[vnfr:id='STRING']/vnfr:json-query-params

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/monitoring-param/STRING/json-query-params

Fields

Name	Type	Description
json-path	STRING	The jsonpath to use to extract value from JSON structure
object-path	STRING	The objectpath to use to extract value from JSON structure

JSON Sample

{
  "json-path": "STRING",
  "object-path": "STRING"
}

XML Sample

<vnfr:json-query-params xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:json-path>STRING</vnfr:json-path>
  <vnfr:object-path>STRING</vnfr:object-path>
</vnfr:json-query-params>

vnfr:numeric-constraints

Key Identifiers:

XPath Path

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

XPath Keyed Path

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

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/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

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

vnfr:text-constraints

Key Identifiers:

XPath Path

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

XPath Keyed Path

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

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/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

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

vnfr:placement-groups-info

Placement groups to which this VDU belongs and its cloud construct

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/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.
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 Sample

[
  {
    "name": "STRING",
    "requirement": "STRING",
    "strategy": "COLOCATION",
    "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 Sample

<vnfr:placement-groups-info xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:name>STRING</vnfr:name>
  <vnfr:requirement>STRING</vnfr:requirement>
  <vnfr:strategy>COLOCATION</vnfr:strategy>
  <vnfr:cloud-type>aws</vnfr:cloud-type>
  <vnfr:availability-zone>
    <vnfr:name>STRING</vnfr:name>
  </vnfr:availability-zone>
  <vnfr:server-group>
    <vnfr:name>STRING</vnfr:name>
  </vnfr:server-group>
  <vnfr:host-aggregate>
    <vnfr:metadata-key>STRING</vnfr:metadata-key>
    <vnfr:metadata-value>STRING</vnfr:metadata-value>
  </vnfr:host-aggregate>
  <vnfr:aws-construct/>
  <vnfr:openmano-construct/>
  <vnfr:vsphere-construct/>
  <vnfr:mock-construct/>
  <vnfr:cloudsim-construct/>
</vnfr:placement-groups-info>

vnfr:availability-zone

Name of the Availability Zone

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:availability-zone

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:availability-zone

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING/availability-zone

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

vnfr:server-group

Name of the Affinity/Anti-Affinity Server Group

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:server-group

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:server-group

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/STRING/server-group

Fields

Name	Type	Description
name	STRING

JSON Sample

{
  "name": "STRING"
}

XML Sample

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

vnfr:host-aggregate

Name of the Host Aggregate

Key Identifiers:

XPath Path

/vnfr:vnfr-catalog/vnfr:vnfr/vnfr:placement-groups-info/vnfr:host-aggregate

XPath Keyed Path

/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id='STRING']/vnfr:placement-groups-info[vnfr:name='STRING']/vnfr:host-aggregate[vnfr:metadata-key='STRING']

RW.REST URI Path

/vnfr:vnfr-catalog/vnfr/STRING/placement-groups-info/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 Sample

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

XML Sample

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

vnfr rpc input

vnfr:create-alarm

Key Identifiers:

XPath Path	/vnfr:create-alarm
XPath Keyed Path	/vnfr:create-alarm
RW.REST URI Path	/input

Fields

Name	Type	Description
cloud-account	STRING
vdur-id	STRING
alarm	CONTAINER

JSON Sample

{
  "cloud-account": "STRING",
  "vdur-id": "STRING",
  "alarm": {
    "alarm-id": "STRING",
    "name": "STRING",
    "description": "STRING",
    "vdur-id": "STRING",
    "actions": { ... },
    "repeat": true,
    "enabled": true,
    "severity": "LOW",
    "metric": "CPU_UTILIZATION",
    "statistic": "AVERAGE",
    "operation": "GE",
    "value": 0.0,
    "period": 0,
    "evaluations": 0
  }
}

XML Sample

<vnfr:input xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:cloud-account>STRING</vnfr:cloud-account>
  <vnfr:vdur-id>STRING</vnfr:vdur-id>
  <vnfr:alarm>
    <vnfr:alarm-id>STRING</vnfr:alarm-id>
    <vnfr:name>STRING</vnfr:name>
    <vnfr:description>STRING</vnfr:description>
    <vnfr:vdur-id>STRING</vnfr:vdur-id>
    <vnfr:actions>...</vnfr:actions>
    <vnfr:repeat>true</vnfr:repeat>
    <vnfr:enabled>true</vnfr:enabled>
    <vnfr:severity>LOW</vnfr:severity>
    <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
    <vnfr:statistic>AVERAGE</vnfr:statistic>
    <vnfr:operation>GE</vnfr:operation>
    <vnfr:value>0.0</vnfr:value>
    <vnfr:period>0</vnfr:period>
    <vnfr:evaluations>0</vnfr:evaluations>
  </vnfr:alarm>
</vnfr:input>

vnfr:alarm

Key Identifiers:

XPath Path	/vnfr:create-alarm/vnfr:alarm
XPath Keyed Path	/vnfr:create-alarm/vnfr:alarm
RW.REST URI Path	/input/alarm

Fields

Name	Type	Description
alarm-id	STRING	This field is reserved for the identifier assigned by the VIM provider
name	STRING	A human readable string to identify the alarm
description	STRING	A description of this alarm
vdur-id	STRING	The identifier of the VDUR that the alarm is associated with
actions	CONTAINER
repeat	BOOLEAN	This flag indicates whether the alarm should be repeatedly emitted while the associated threshold has been crossed.
enabled	BOOLEAN	This flag indicates whether the alarm has been enabled or disabled.
severity	ENUM	A measure of the importance or urgency of the alarm
metric	ENUM	The metric to be tracked by this alarm.
statistic	ENUM	The type of metric statistic that is tracked by this alarm
operation	ENUM	The relational operator used to define whether an alarm should be triggered in certain scenarios, such as if the metric statistic goes above or below a specified value.
value	DECIMAL64	This value defines the threshold that, if crossed, will trigger the alarm.
period	UINT32	The period defines the length of time (seconds) that the metric data are collected over in oreder to evaluate the chosen statistic.
evaluations	UINT32	Defines the length of time (seconds) in which metric data are collected in order to evaluate the chosen statistic.

JSON Config Sample

{
  "alarm-id": "STRING",
  "name": "STRING",
  "description": "STRING",
  "vdur-id": "STRING",
  "actions": {
    "ok": [ { ... }, { ... } ],
    "insufficient-data": [ { ... }, { ... } ],
    "alarm": [ { ... }, { ... } ]
  },
  "repeat": true,
  "enabled": true,
  "severity": "LOW",
  "metric": "CPU_UTILIZATION",
  "statistic": "AVERAGE",
  "operation": "GE",
  "value": 0.0,
  "period": 0,
  "evaluations": 0
}

JSON Sample

{
  "alarm-id": "STRING",
  "name": "STRING",
  "description": "STRING",
  "vdur-id": "STRING",
  "actions": {
    "ok": [ { ... }, { ... } ],
    "insufficient-data": [ { ... }, { ... } ],
    "alarm": [ { ... }, { ... } ]
  },
  "repeat": true,
  "enabled": true,
  "severity": "LOW",
  "metric": "CPU_UTILIZATION",
  "statistic": "AVERAGE",
  "operation": "GE",
  "value": 0.0,
  "period": 0,
  "evaluations": 0
}

XML Config Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:alarm-id>STRING</vnfr:alarm-id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:vdur-id>STRING</vnfr:vdur-id>
  <vnfr:actions>
    <vnfr:ok>...</vnfr:ok>
    <vnfr:insufficient-data>...</vnfr:insufficient-data>
    <vnfr:alarm>...</vnfr:alarm>
  </vnfr:actions>
  <vnfr:repeat>true</vnfr:repeat>
  <vnfr:enabled>true</vnfr:enabled>
  <vnfr:severity>LOW</vnfr:severity>
  <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
  <vnfr:statistic>AVERAGE</vnfr:statistic>
  <vnfr:operation>GE</vnfr:operation>
  <vnfr:value>0.0</vnfr:value>
  <vnfr:period>0</vnfr:period>
  <vnfr:evaluations>0</vnfr:evaluations>
</vnfr:alarm>

XML Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:alarm-id>STRING</vnfr:alarm-id>
  <vnfr:name>STRING</vnfr:name>
  <vnfr:description>STRING</vnfr:description>
  <vnfr:vdur-id>STRING</vnfr:vdur-id>
  <vnfr:actions>
    <vnfr:ok>...</vnfr:ok>
    <vnfr:insufficient-data>...</vnfr:insufficient-data>
    <vnfr:alarm>...</vnfr:alarm>
  </vnfr:actions>
  <vnfr:repeat>true</vnfr:repeat>
  <vnfr:enabled>true</vnfr:enabled>
  <vnfr:severity>LOW</vnfr:severity>
  <vnfr:metric>CPU_UTILIZATION</vnfr:metric>
  <vnfr:statistic>AVERAGE</vnfr:statistic>
  <vnfr:operation>GE</vnfr:operation>
  <vnfr:value>0.0</vnfr:value>
  <vnfr:period>0</vnfr:period>
  <vnfr:evaluations>0</vnfr:evaluations>
</vnfr:alarm>

vnfr:actions

Key Identifiers:

XPath Path	/vnfr:create-alarm/vnfr:alarm/vnfr:actions
XPath Keyed Path	/vnfr:create-alarm/vnfr:alarm/vnfr:actions
RW.REST URI Path	/input/alarm/actions

Fields

Name	Type	Description
ok	LIST
insufficient-data	LIST
alarm	LIST

JSON Config Sample

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "ok": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "insufficient-data": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ],
  "alarm": [
    {
      "url": "STRING"
    }, {
      ...
    }
  ]
}

XML Config Sample

<vnfr:actions xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ok>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:ok>
  <vnfr:insufficient-data>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:insufficient-data>
  <vnfr:alarm>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:alarm>
</vnfr:actions>

XML Sample

<vnfr:actions xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:ok>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:ok>
  <vnfr:insufficient-data>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:insufficient-data>
  <vnfr:alarm>
    <vnfr:url>STRING</vnfr:url>
  </vnfr:alarm>
</vnfr:actions>

vnfr:ok

Key Identifiers:

XPath Path	/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:ok
XPath Keyed Path	/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:ok[vnfr:url='STRING']
RW.REST URI Path	/input/alarm/actions/ok/STRING

Fields

Name	Type	Description
url	STRING

JSON Config Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<vnfr:ok xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:ok>

XML Sample

<vnfr:ok xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:ok>

vnfr:insufficient-data

Key Identifiers:

XPath Path	/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:insufficient-data
XPath Keyed Path	/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:insufficient-data[vnfr:url='STRING']
RW.REST URI Path	/input/alarm/actions/insufficient-data/STRING

Fields

Name	Type	Description
url	STRING

JSON Config Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<vnfr:insufficient-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:insufficient-data>

XML Sample

<vnfr:insufficient-data xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:insufficient-data>

vnfr:alarm

Key Identifiers:

XPath Path	/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:alarm
XPath Keyed Path	/vnfr:create-alarm/vnfr:alarm/vnfr:actions/vnfr:alarm[vnfr:url='STRING']
RW.REST URI Path	/input/alarm/actions/alarm/STRING

Fields

Name	Type	Description
url	STRING

JSON Config Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "url": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:alarm>

XML Sample

<vnfr:alarm xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:url>STRING</vnfr:url>
</vnfr:alarm>

vnfr:destroy-alarm

Key Identifiers:

XPath Path	/vnfr:destroy-alarm
XPath Keyed Path	/vnfr:destroy-alarm
RW.REST URI Path	/input

Fields

Name	Type	Description
cloud-account	STRING
alarm-id	STRING

JSON Sample

{
  "cloud-account": "STRING",
  "alarm-id": "STRING"
}

XML Sample

<vnfr:input xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:cloud-account>STRING</vnfr:cloud-account>
  <vnfr:alarm-id>STRING</vnfr:alarm-id>
</vnfr:input>

vnfr rpc output

vnfr:create-alarm

Key Identifiers:

XPath Path	/vnfr:create-alarm
XPath Keyed Path	/vnfr:create-alarm
RW.REST URI Path	/output

Fields

Name	Type	Description
alarm-id	STRING

JSON Sample

{
  "alarm-id": "STRING"
}

XML Sample

<vnfr:output xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr">
  <vnfr:alarm-id>STRING</vnfr:alarm-id>
</vnfr:output>

vnfr:destroy-alarm

Key Identifiers:

XPath Path	/vnfr:destroy-alarm
XPath Keyed Path	/vnfr:destroy-alarm
RW.REST URI Path	/output

JSON Sample

{
}

XML Sample

<vnfr:output xmlns:vnfr="urn:ietf:params:xml:ns:yang:nfvo:vnfr"/>