VNF

Represent a VNF instance

Overview

allowedActions enum (DEPLOY | REDEPLOY | RESTART | START | STOP | UNDEPLOY) autogenerated  
associatedVNFMetadataID string
CPUCount integer filterable   orderable  
description string filterable   orderable  
enterpriseID string
isAttachedToDescriptor boolean filterable   orderable  
lastKnownError string filterable  
memoryMB integer filterable   orderable  
metadataID string filterable   orderable  
name string required   filterable   orderable  
NSGatewayID string required   creation only   filterable   orderable  
NSGName string
NSGSystemID string
status enum (BLOCKED | CRASHED | DYING | IDLE | INIT | LAST | PAUSED | PMSUSPENDED | RUNNING | SHUTDOWN | SHUTOFF) filterable   orderable  
storageGB integer filterable   orderable  
taskState enum (DEPLOYING | NONE | STARTING | STOPPING | UNDEPLOYING) filterable   orderable  
vendor string filterable   orderable  
VNFDescriptorID string required   creation only   filterable  
VNFDescriptorName string

API Resource

/vnfs/id
delete get put

Parents

/enterprises/id/vnfs
get post

Children

/vnfs/id/vnfinterfaces
get
/vnfs/id/vnfmetadatas
get
/vnfs/id/jobs
post

Members

This object has no members.

Attributes documentation

allowedActions enum 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

CPUCount integer filterable   orderable  
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
Min length: 1
Max length: 255
SDK attribute: description

enterpriseID string
Discussion

ID of the enterprise that this VNF belongs to


Charateristics

Format: free
SDK attribute: enterpriseID

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 filterable  
Discussion

Last error reported


Charateristics

Format: free
SDK attribute: lastKnownError

memoryMB integer filterable   orderable  
Discussion

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


Charateristics

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

metadataID string filterable   orderable  
Discussion

Id of referenced metadata object


Charateristics

Format: free
SDK attribute: metadataID

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   filterable   orderable  
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
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 filterable   orderable  
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   orderable  
Discussion

Current state of operation/task


Charateristics

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

vendor string filterable   orderable  
Discussion

The vendor for VNF


Charateristics

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

VNFDescriptorID string required   creation only   filterable  
Discussion

The ID of VNF Descriptor from which VNF to be created.


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