VNF

Instantiation of a VNF on a specified Network Services Gateway that has the resources to manage a VNF.

Overview

allowedActions list (DEPLOY | REDEPLOY | RESTART | START | STOP | UNDEPLOY) autogenerated  
associatedVNFMetadataID string
associatedVNFThresholdPolicyID string
CPUCount integer
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
isAttachedToDescriptor boolean filterable   orderable  
lastKnownError string
lastUpdatedBy string autogenerated  
lastUserAction enum (DEPLOY | NONE | REDEPLOY | RESTART | START | STOP | UNDEPLOY) read only   filterable  
memoryMB integer
name string required   filterable   orderable  
NSGatewayID string required   creation only  
NSGName string
NSGSystemID string filterable  
status enum (BLOCKED | CRASHED | DYING | IDLE | INIT | LAST | PAUSED | PMSUSPENDED | RUNNING | SHUTDOWN | SHUTOFF) filterable   orderable  
storageGB integer
taskState enum (DEPLOYING | NONE | STARTING | STOPPING | UNDEPLOYING) filterable  
type enum (FIREWALL | THREAT_PREVENTION | WAN_OPT) read only   filterable  
vendor string
VNFDescriptorID string
VNFDescriptorName string

API Resource

/vnfs/id
delete get put

Parents

/enterprises/id/vnfs
get post
/nsgateways/id/vnfs
get

Children

/vnfs/id/metadatas
get post
/vnfs/id/globalmetadatas
get post put
/vnfs/id/vnfinterfaces
get
/vnfs/id/vnfmetadatas
get
/vnfs/id/vnfthresholdpolicies
get
/vnfs/id/jobs
post

Members

This object has no members.

Attributes documentation

allowedActions list autogenerated  
Discussion

Action allowed to performed on VNF based on current status and taskState

Charateristics

Allowed values: DEPLOY, REDEPLOY, RESTART, START, STOP, UNDEPLOY
SDK attribute: allowedActions

associatedVNFMetadataID string
Discussion

VNF metadata associated to VNF instance.

Charateristics

Format: free
SDK attribute: associatedVNFMetadataID

associatedVNFThresholdPolicyID string
Discussion

VNF threshold policy associated to VNF instance

Charateristics

Format: free
SDK attribute: associatedVNFThresholdPolicyID

CPUCount integer
Discussion

Number of CPUs to be allocated for this VNF instance

Charateristics

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

description string filterable   orderable  
Discussion

Description of the VNF Instance

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

enterpriseID string
Discussion

ID of the enterprise that this VNF belongs to

Charateristics

Format: free
SDK attribute: enterpriseID

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

isAttachedToDescriptor boolean filterable   orderable  
Discussion

This specifies if VNF instance is using VNF descriptor or it is decoupled from it

Charateristics

Default value: true
SDK attribute: isAttachedToDescriptor

lastKnownError string
Discussion

Last error reported

Charateristics

Format: free
SDK attribute: lastKnownError

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUserAction enum read only   filterable  
Discussion

Last action perform by user

Charateristics

Allowed values: DEPLOY, NONE, REDEPLOY, RESTART, START, STOP, UNDEPLOY
SDK attribute: lastUserAction

memoryMB integer
Discussion

Memory (in MB) to be allocated for this VNF instance.

Charateristics

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

name string required   filterable   orderable  
Discussion

Name of the VNF

Charateristics

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

NSGatewayID string required   creation only  
Discussion

The NSG instance id where VNF is deployed

Charateristics

Format: free
SDK attribute: NSGatewayID

NSGName string
Discussion

The NSG name where VNF is deployed

Charateristics

Format: free
SDK attribute: NSGName

NSGSystemID string filterable  
Discussion

The NSG system id where VNF is deployed

Charateristics

Format: free
SDK attribute: NSGSystemID

status enum filterable   orderable  
Discussion

State/Status of the VNF

Charateristics

Allowed values: BLOCKED, CRASHED, DYING, IDLE, INIT, LAST, PAUSED, PMSUSPENDED, RUNNING, SHUTDOWN, SHUTOFF
SDK attribute: status

storageGB integer
Discussion

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

Charateristics

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

taskState enum filterable  
Discussion

Current state of operation/task

Charateristics

Allowed values: DEPLOYING, NONE, STARTING, STOPPING, UNDEPLOYING
SDK attribute: taskState

type enum read only   filterable  
Discussion

Type of virtual network function

Charateristics

Allowed values: FIREWALL, THREAT_PREVENTION, WAN_OPT
SDK attribute: type

vendor string
Discussion

The vendor for VNF

Charateristics

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

VNFDescriptorID string
Discussion

The ID of VNF Descriptor from which VNF to be created. This is required on creation and can be removed on moidification of VNF instance.

Charateristics

Format: free
SDK attribute: VNFDescriptorID

VNFDescriptorName string
Discussion

The Name of VNF Descriptor from which this VNF instance is created.

Charateristics

Format: free
SDK attribute: VNFDescriptorName