{"type":"api","title":"Create an Image","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 - Image"],"summary":"Create an Image","description":"Create a new image","operationId":"data_vmlc_vm_lifecycle_images_post","produces":["application/yang-data+json"],"parameters":[{"name":"images","in":"body","description":"","required":true,"schema":{"type":"object","properties":{"vmlc:image":{"type":"array","description":"List of images (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"Name of the image (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"src":{"description":"URL of the VM image from where it can be downloaded by ESC (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"certificate_validation":{"description":"Used to enable certificate validation on image registration (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"certificate_file":{"description":"Certificate file used to validate src downloads over https connections (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"size":{"description":"Size of the image specified by URL above. If unsure, leave it blank (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"int32"},"sizeunit":{"description":"Size unit. MiB/GiB/TiB/PiB/EiB (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"MiB","enum":["MiB","GiB","TiB","PiB"]},"disk_format":{"description":"Format of the disk: qcow2, raw, vmdk (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"qcow2","enum":["qcow2","raw","vmdk"]},"container_format":{"description":" (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"serial_console":{"description":" (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"e1000_net":{"description":"True if image has e1000 drivers (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"virtio_net":{"description":"True if image has VIRTIO drivers (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"disk_bus":{"description":"Root disk bus: ide, scsi, virtio (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"ide","enum":["ide","scsi","virtio"]},"visibility":{"description":"Specifies whether image should be created as public or private (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"properties":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"property":{"type":"array","description":"Storage location for additional Image properties. (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"name":{"description":"Property key, for example maximum VCPUs supported by this VNF image. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"type":{"description":"Type of property. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"value":{"type":"array","x-yang":{"type":"leaf-list"},"items":{"description":"One or more values (leaf-list)","type":"string","format":"string"}}}}}}},"credentials":{"description":"(non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"username":{"description":"username of the remote server access (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"password":{"description":"password for server access (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}},"metadata":{"description":"Metadata properties are described in this section (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"src":{"description":"URL of the metadata file from where it can be downloaded by ESC (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"checksum":{"description":"SHA checksum for the file (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"checksum_algorithm":{"description":"Algorithm to use to validate the provided checksum (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"sha256sum","enum":["sha256sum","sha512sum"]}}},"remove_src_on_completion":{"description":"TRUE if image source file should be deleted after image registration is complete. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"checksum":{"description":"SHA checksum for the file (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"checksum_algorithm":{"description":"Algorithm to use to validate the provided checksum (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"sha256sum","enum":["sha256sum","sha512sum"]},"locators":{"description":"Contains VIM-specific resource locator properties for VMWARE multi VDC\nsupport in single VIM deployments. (non-presence)","type":"object","x-yang":{"type":"container","is_presence":"false"},"properties":{"datacenter":{"description":"Specifies the name of the target datacenter of the resource. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"switch_name":{"description":"Specifies the name of the target switch for a network resource (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}},"locator":{"description":"Information to identify the target VIM and VIM related config to\nrealize the configuration like deployment. (presence)","type":"object","x-yang":{"type":"container","is_presence":"true"},"properties":{"vim_id":{"description":"Specifies the ESC defined id of the target VIM to apply the\nconfiguration. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vim_project":{"description":"Specifies the name of the target project to apply the configuration. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vim_region":{"description":"Specifies the name of the target region to apply the configuration. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"vim_vdc":{"description":"Specifies the name of the target vDC to apply the configuration. (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}}},"$$ref":"#/definitions/data_vmlc_vm_lifecycle_images-post"},"$$ref":"#/parameters/data_vmlc_vm_lifecycle_images-post"}],"responses":{"201":{"description":"container images created"},"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_images_post","consumes":["application/yang-data+json"],"method":"post","path":"/data/vmlc:vm_lifecycle/images"}}