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


  • vnf_descriptor_id (Mandatory): 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.
  • vnf_descriptor_name: The Name of VNF Descriptor from which this VNF instance is created.
  • cpu_count: Number of CPUs to be allocated for this VNF instance
  • nsg_name: The NSG name where VNF is deployed
  • nsg_system_id: The NSG system id where VNF is deployed
  • ns_gateway_id (Mandatory): The NSG instance id where VNF is deployed
  • name (Mandatory): Name of the VNF
  • task_state: Current state of operation/task
  • last_known_error: Last error reported
  • last_updated_by: ID of the user who last updated the object.
  • last_updated_date: Time stamp when this object was last updated.
  • last_user_action: Last action perform by user
  • memory_mb: Memory (in MB) to be allocated for this VNF instance.
  • vendor: The vendor for VNF
  • description: Description of the VNF Instance
  • allowed_actions: Action allowed to performed on VNF based on current status and taskState
  • embedded_metadata: 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.
  • enterprise_id: ID of the enterprise that this VNF belongs to
  • entity_scope: Specify if scope of entity is Data center or Enterprise level
  • creation_date: Time stamp when this object was created.
  • is_attached_to_descriptor: This specifies if VNF instance is using VNF descriptor or it is decoupled from it
  • associated_vnf_metadata_id: VNF metadata associated to VNF instance.
  • associated_vnf_threshold_policy_id: VNF threshold policy associated to VNF instance
  • status: State/Status of the VNF
  • storage_gb: Disk storage (in GB) to be allocated for deployed VNF instance
  • owner: Identifies the user that has created this object.
  • external_id: External object ID. Used for integration with third party systems
  • type: Type of virtual network function


class fetcher
nupermission.NUPermission permissions
numetadata.NUMetadata metadatas
nuglobalmetadata.NUGlobalMetadata global_metadatas
nuvnfinterface.NUVNFInterface vnf_interfaces
nuvnfmetadata.NUVNFMetadata vnf_metadatas
nuvnfthresholdpolicy.NUVNFThresholdPolicy vnf_threshold_policies
nujob.NUJob jobs