Get Deployment Status - NFVIS API

{"type":"api","title":"Get Deployment Status","meta":{"id":"/apps/pubhub/media/nfvis-api/e3678dda6abe6c2a26c7698d553a4574e3f45071/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"title":"NFVIS API","description":"NFVIS RESTCONF API Documentation","version":"4.14.1"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/{nfvis_ip}/restconf","schemes":["https"],"securityDefinitions":{"basicAuth":{"type":"basic"}}},"spec":{"tags":["VM Lifecycle Management - Deployment"],"summary":"Get Deployment Status","description":"Retrieve deployment status and details. tenant-name is admin.","operationId":"data_vmlc_vm_lifecycle_opdata_tenants_tenant_tenant_name_deployments_deployments_deployment_name_get","produces":["application/yang-data+json"],"parameters":[{"name":"tenant-name","in":"path","description":"","required":true,"type":"string","format":"string","$$ref":"#/parameters/tenant-name"},{"name":"deployments-deployment_name","in":"path","description":"Name of the deployment","required":true,"type":"string","format":"string","$$ref":"#/parameters/deployments-deployment_name"},{"name":"content","in":"query","description":"controlling descendant nodes in response","required":false,"type":"string","format":"enumeration","default":"config","enum":["config","nonconfig","all"],"$$ref":"#/parameters/content"}],"responses":{"200":{"description":"List of deployments","schema":{"type":"object","properties":{"vmlc:deployments":{"type":"array","description":"List of deployments (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"deployment_name":{"description":"Name of the deployment (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"deployment_id":{"description":"Internal Deployment ID for the service (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vm_group":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"Group Name (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"flavor":{"description":"Flavor (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"image":{"description":"Image (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"bootup_time":{"description":"Time in seconds that this VM takes to perform a cold boot. This will\nbe the time that ESC waits before deciding that the VM is\nun-bootable. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"supported_export_type":{"description":"The type of export that this VM can support. Values include\n'none', 'cold' and 'live' (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"none","enum":["none","cold","live"]},"vm_instance":{"type":"array","description":"List of running VMs in this group (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"A name of the VM (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"generated_name":{"description":"ESC generated name of the VM (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vm_id":{"description":"UUID of the VM (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vim_id":{"description":"ESC defined id of the VIM where this VM is deployed (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vim_project":{"description":"Name of the target project (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vim_project_id":{"description":"External ID for the project (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"host_id":{"description":"ID of the host where this VM is running (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"hostname":{"description":"Hostname where this VM is running. This is sometimes\nreferred to a hypervisor name. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vdc":{"description":"VMware vCloud Director org virtual data center. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"software_version":{"description":"Software version of the VM (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vm_restore":{"description":"Details of the VM backup source archive used for this deployment (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vm_restored_from":{"description":"path to backup archive used for this VM instance deployment (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}},"ngio":{"description":"Signifies whether VM was deployed with NGIO (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"ENABLED","enum":["ENABLED","DISABLED"]},"interfaces":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"interface":{"type":"array","description":"Interface running information (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"nicid":{"description":"ID of the interface specified during configuration (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"model":{"description":"In case of virtual: e1000, virtio etc. In case of passthrough:\nModel of the NIC. This will be specific to the data center. Data\ncenters may have NICs that support virtual functions from\ndifferent vendors, like Intel, Cisco etc. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"e1000","enum":["e1000","ne2k_pci","virtio","i82551","i82557b","i82559er","rtl8139","pcnet"]},"type":{"description":"Interface Type: virtual/passthru (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vim_interface_name":{"description":"User specified name for the interface on the VIM (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"port_id":{"description":"Port identifier (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"admin_state_up":{"description":"The administrative state of the resource, which is up (true) or down (false). (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"network":{"description":"Network to which this interface is attached (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"subnet":{"description":"Sub Network to which this interface is attached (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"ip_address":{"description":"IP address for this interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"public_ip_address":{"description":"Public IP address for this interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"mac_address":{"description":"MAC address for this interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"port_security_enabled":{"description":"Whether the port security is enabled at port level (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"netmask":{"description":"Netmask of the subnet (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"gateway":{"description":"Gateway of the subnet (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"security_groups":{"description":"List of delimiter-separated security groups for the interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"port_forwards":{"description":"This section contains teh forwarded prts on this interface (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"port_forward":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"port_type":{"description":"Purpose of the forwarded port. For example ssh, telnet, etc. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"port_number":{"description":"The external port number for this interface (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"source_bridge":{"description":"Bridge that will be used to access the server externally. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}},"binding_profile":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"property":{"type":"array","description":"Binding profile property (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"Property name (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"value":{"description":"Property value (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}},"address":{"type":"array","description":"list of address (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"address_id":{"description":"Id for the address in address list. (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"subnet":{"description":"Sub network to which this interface is attached (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"ip_address":{"description":"IP address for this interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"},"prefix":{"description":"Prefix of the subnet (CIDR) (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"gateway":{"description":"Gateway of the subnet (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"}}}}}}}}},"volumes":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"volume":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"volid":{"description":"Volumes will be presented to the VM sorted by volume ID (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"display_name":{"description":"Display name of the Volume (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"external_id":{"description":"UUID of the volume in the VIM. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"bus":{"description":"Block device bus to be used: ide, scsi, virtio (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"type":{"description":"Type of the volume attached. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"size":{"description":"Size of the Volume with unit. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"boot_index":{"description":"Specify the boot order for bootable volumes. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"image":{"description":"Name or UUID of the source image (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"format":{"description":"Format of the disk to create. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"qcow2","enum":["qcow2","raw","vmdk"]},"device_type":{"description":"Type of device being attached to the VM. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"disk","enum":["disk","cdrom"]},"storage_location":{"description":"Location of the storage volume. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"mount_path":{"description":"Location of the storage volume mount path in a container. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}}}}},"shared_ip":{"type":"array","description":"Shared Ip is the ip address that is shared by all the VM\nin the vm_group on a particular nicid (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"nicid":{"description":"Interface where the static_ip property is applied. (leaf)","x-yang":{"type":"leaf"},"type":"integer","format":"uint16"},"ip_address":{"description":"shared IP address for this interface (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"union"}}}}}}},"state_machine":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"state":{"description":"State in which service is currently in (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"SERVICE_UNDEF_STATE","enum":["SERVICE_UNDEF_STATE","SERVICE_DEPLOYING_STATE","SERVICE_INERT_STATE","SERVICE_ACTIVE_STATE","SERVICE_UNDEPLOYING_STATE","SERVICE_STOPPING_STATE","SERVICE_STOPPED_STATE","SERVICE_STARTING_STATE","SERVICE_REBOOTING_STATE","SERVICE_ERROR_STATE"]},"vm_state_machines":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"vm_state_machine":{"type":"array","description":"(list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"vm_name":{"description":"Name uniquely identifies a VM (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"state":{"description":"State in which VM is currently in (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"VM_UNDEF_STATE","enum":["VM_UNDEF_STATE","VM_DEPLOYING_STATE","VM_MONITOR_UNSET_STATE","VM_MONITOR_DISABLED_STATE","VM_STOPPING_STATE","VM_SHUTOFF_STATE","VM_STARTING_STATE","VM_REBOOTING_STATE","VM_INERT_STATE","VM_ALIVE_STATE","VM_UNDEPLOYING_STATE","VM_ERROR_STATE"]}}}}}}}}}}}},"$$ref":"#/definitions/data_vmlc_vm_lifecycle_opdata_tenants_tenant_tenant-name_deployments_deployments-deployment_name"}},"204":{"description":"No Content","$$ref":"#/responses/204"},"400":{"description":"Bad Request","$$ref":"#/responses/400"},"401":{"description":"Unauthorized","$$ref":"#/responses/401"},"404":{"description":"Not Found","$$ref":"#/responses/404"},"405":{"description":"Method Not Allowed","$$ref":"#/responses/405"},"409":{"description":"Conflict","$$ref":"#/responses/409"}},"security":[{"basicAuth":[]}],"__originalOperationId":"data_vmlc_vm_lifecycle_opdata_tenants_tenant_tenant_name_deployments_deployments_deployment_name_get","consumes":["application/yang-data+json"],"method":"get","path":"/data/vmlc:vm_lifecycle/opdata/tenants/tenant={tenant-name}/deployments={deployments-deployment_name}"}}