VNFDescriptor

The behavioral and deployment information of a VNF is defined in the VNF descriptor template. The template is based on the libvirt domain XML and is on-boarded in a VNF catalog. The resource requirements for CPU, memory and storage are defined in this screen and the rest of the template is inherited from the VNF Metadata object.

Overview

associatedVNFThresholdPolicyID string
CPUCount integer filterable   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
memoryMB integer required   filterable   orderable  
metadataID string required  
name string required   filterable   orderable  
storageGB integer required   filterable   orderable  
type enum (FIREWALL | WAN_OPT) filterable  
vendor string filterable   orderable  
visible boolean filterable   orderable  

API Resource

/vnfdescriptors/id
delete get put

Parents

/vnfcatalogs/id/vnfdescriptors
get post put

Children

/vnfdescriptors/id/metadatas
get post
/vnfdescriptors/id/globalmetadatas
get post put
/vnfdescriptors/id/vnfinterfacedescriptors
get post put

Members

This object has no members.

Attributes documentation

associatedVNFThresholdPolicyID string
Discussion

The Id of referenced VNF threshold policy

Charateristics

Format: free
SDK attribute: associatedVNFThresholdPolicyID

CPUCount integer filterable   orderable  
Discussion

Number of CPUs to be allocated VNF instance when deployed

Charateristics

Min value: 1
Max value: 16
SDK attribute: CPUCount

description string filterable   orderable  
Discussion

A description of the VNF Descriptor

Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

memoryMB integer required   filterable   orderable  
Discussion

Memory (in MB) to be allocated for VNF instance when deployed

Charateristics

Min value: 128
Max value: 16384
SDK attribute: memoryMB

metadataID string required  
Discussion

Id of referenced Metadata Object

Charateristics

Format: free
SDK attribute: metadataID

name string required   filterable   orderable  
Discussion

Name of the VNF Descriptor

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

storageGB integer required   filterable   orderable  
Discussion

Disk storage (in GB) to be allocated VNF instance when deployed

Charateristics

Min value: 1
Max value: 200
SDK attribute: storageGB

type enum filterable  
Discussion

Type of virtual network function

Charateristics

Allowed values: FIREWALL, WAN_OPT
Default value: FIREWALL
SDK attribute: type

vendor string filterable   orderable  
Discussion

The vendor generating this VNF Descriptor

Charateristics

Format: free
Max length: 255
SDK attribute: vendor

visible boolean filterable   orderable  
Discussion

Controls if descriptor visible in catalog to create new VNF

Charateristics

Default value: true
SDK attribute: visible