# machine-images ## machine-images add-tags **Usage** ```none usage: symp machine-images add-tags [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--project-id PROJECT_ID] [--system-tag] machine_image_id --tags [--tags ...] ``` **Description** Add tags to a machine image. **Mandatory** ```none positional arguments: machine_image_id ID of image to which to add the tags --tags Tags to add to the machine image ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --project-id PROJECT_ID Project ID --system-tag System tag, will be added to all provided tags ``` ## machine-images bdms add-from-file **Usage** ```none usage: symp machine-images bdms add-from-file [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--storage-pool STORAGE_POOL] [--volume-size-gib VOLUME_SIZE_GIB] [--bus-type BUS_TYPE] [--disk-type DISK_TYPE] [--file FILE] machine_image_id boot_index ``` **Description** Add bdm from file to image. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: machine_image_id boot_index ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --storage-pool STORAGE_POOL --volume-size-gib VOLUME_SIZE_GIB --bus-type BUS_TYPE --disk-type DISK_TYPE --file FILE ``` ## machine-images bdms add-from-snapshot **Usage** ```none usage: symp machine-images bdms add-from-snapshot [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--duplicate-snapshot] machine_image_id block_device_mapping boot_index ``` **Description** Add bdm from snapshot to image. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: machine_image_id block_device_mapping - The mapping of the new machine image to its different snapshots. The format is a JSON string containing a list of blocks. Each of the blocks is a dictionary with the following keys: snapshot_id, volume_size_gib, storage_pool, bus_type and disk_type. - The value of bus_type must be either "virtio" or "ide", - The value of disk_type must be either "disk" or "cdrom" - The value of storage_pool indicates the ID of a storage pool. If it is not given, the machine image is created in the default storage pool. For example, [{"snapshot_id": , "volume_size_gib": #, "storage_pool": , "bus_type": "virtio"|"ide", "disk_type": "disk"|"cdrom"}, {...}] boot_index Boot index for the bdm ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --duplicate-snapshot Duplicate snapshot before creating the bdm ``` ## machine-images bdms add-from-url **Usage** ```none usage: symp machine-images bdms add-from-url [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] machine_image_id block_device_mapping boot_index ``` **Description** Add bdm from url to image. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: machine_image_id block_device_mapping - The mapping of the new machine image to its different snapshots. The format is a JSON string containing a list of blocks. Each of the blocks is a dictionary with the following keys: url, auth, no_verify_ssl, storage_pool, bus_type, disk_type. - The value of auth should contain a list with two elements: username and a password. If it is omitted the URL is accessed without any authentication. - The value of no_verify_ssl is boolean (true or false) - The value of storage_pool indicates the ID of a storage pool. If it is not given, the machine image is created in the default storage pool - The bus_type must be either "virtio" or "ide" - The disk_type must be either "disk" or "cdrom" For example, [{"url": , "auth": , "no_verify_ssl": true|false, "storage_pool": , "bus_type": "virtio"|"ide", "disk_type": "disk"|"cdrom"}, {...}] boot_index Boot index for the bdm ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## machine-images create-machine-image-from-file **Usage** ```none usage: symp machine-images create-machine-image-from-file [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--machine-image-id MACHINE_IMAGE_ID] [--description DESCRIPTION] [--guest-os GUEST_OS] [--scope SCOPE] [--project-id PROJECT_ID] [--tags [TAGS [TAGS ...]]] [--os-type-id OS_TYPE_ID] [--storage-pool STORAGE_POOL] [--volume-size-gib VOLUME_SIZE_GIB] [--bus-type BUS_TYPE] [--disk-type DISK_TYPE] [--firmware FIRMWARE] [--file FILE] name ``` **Description** Creates a new machine image from file. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: name Name of the machine image ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --machine-image-id MACHINE_IMAGE_ID --description DESCRIPTION --guest-os GUEST_OS --scope SCOPE --project-id PROJECT_ID --tags [TAGS [TAGS ...]] --os-type-id OS_TYPE_ID --storage-pool STORAGE_POOL --volume-size-gib VOLUME_SIZE_GIB --bus-type BUS_TYPE --disk-type DISK_TYPE --firmware FIRMWARE --file FILE ``` ## machine-images create-machine-image-from-snapshot **Usage** ```none usage: symp machine-images create-machine-image-from-snapshot [-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--machine-image-id MACHINE_IMAGE_ID] [--description DESCRIPTION] [--guest-os GUEST_OS] [--scope SCOPE] [--project-id PROJECT_ID] [--tags [TAGS [TAGS ...]]] [--os-type-id OS_TYPE_ID] [--firmware FIRMWARE] [--duplicate-snapshot] name block_device_mapping ``` **Description** Creates a new machine image from existing snapshot(s). **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: name Name of the machine image block_device_mapping - The mapping of the new machine image to its different snapshots. The format is a JSON string containing a list of blocks. Each of the blocks is a dictionary with the following keys: snapshot_id, volume_size_gib, storage_pool, bus_type and disk_type. - The value of bus_type must be either "virtio" or "ide", - The value of disk_type must be either "disk" or "cdrom" - The value of storage_pool indicates the ID of a storage pool. If it is not given, the machine image is created in the default storage pool. For example, [{"snapshot_id": , "volume_size_gib": #, "storage_pool": , "bus_type": "virtio"|"ide", "disk_type": "disk"|"cdrom"}, {...}] ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --machine-image-id MACHINE_IMAGE_ID ID of the machine image, shouldn't collide with existing ones --description DESCRIPTION Description of the machine image --guest-os GUEST_OS Guest OS of the machine image --scope SCOPE Scope of the machine image --project-id PROJECT_ID Project ID of the machine image --tags [TAGS [TAGS ...]] Tags to add to the machine image --os-type-id OS_TYPE_ID OS type ID of the machine image --firmware FIRMWARE Firmware of the machine image --duplicate-snapshot Duplicate snapshot before creating the image ``` ## machine-images create-machine-image-from-vm **Usage** ```none usage: symp machine-images create-machine-image-from-vm [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--machine-image-id MACHINE_IMAGE_ID] [--description DESCRIPTION] [--guest-os GUEST_OS] [--scope SCOPE] [--project-id PROJECT_ID] [--tags [TAGS [TAGS ...]]] [--os-type-id OS_TYPE_ID] [--block-device-mapping BLOCK_DEVICE_MAPPING] [--no-reboot] name vm_id ``` **Description** Creates a new machine image from existing VM. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: name Name of the machine image vm_id ID of the VM ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --machine-image-id MACHINE_IMAGE_ID ID of the machine image, shouldn't collide with existing ones --description DESCRIPTION Description of the machine image --guest-os GUEST_OS Guest OS of the machine image --scope SCOPE Scope of the machine image --project-id PROJECT_ID Project ID of the machine image --tags [TAGS [TAGS ...]] Tags to add to the machine image --os-type-id OS_TYPE_ID OS type ID of the machine image --block-device-mapping BLOCK_DEVICE_MAPPING - A list of modifications to the VM's block devices. Each of the blocks can contains only those attributes which are to be different in the machine image, and the rest of the attributes are taken from the block devices of the VM. The format is a JSON string containing a list of blocks. Each of the blocks is a dictionary with the following keys: snapshot_id, volume_size_gib, storage_pool, bus_type, disk_type, no_device. - The value of bus_type (if given) must be either "virtio" or "ide", - The value of disk_type (if given) must be either "disk" or "cdrom". - If no_device is specified then the block is skipped, and will not be part of the machine image. The value given is ignored. For example: [{"snapshot_id": , "volume_size_gib": #, "storage_pool": , "bus_type": "virtio"|"ide", "disk_type": "disk"|"cdrom"}, {"no_device":true}, {...}] or [{"volume_size_gib" #}, {"no_device":true}, {"disk_bus": "ide"}] --no-reboot Do not reboot the VM before creating the image ``` ## machine-images delete **Usage** ```none usage: symp machine-images delete [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--override-protection OVERRIDE_PROTECTION] [--delete-image-snapshot DELETE_IMAGE_SNAPSHOT] machine_image_id ``` **Description** Deletes a machine image with the given ID. **Mandatory** ```none positional arguments: machine_image_id ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --override-protection OVERRIDE_PROTECTION --delete-image-snapshot DELETE_IMAGE_SNAPSHOT ``` ## machine-images get **Usage** ```none usage: symp machine-images get [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] machine_image_id ``` **Description** Returns machine image with the given ID. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: machine_image_id ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## machine-images import-machine-image-from-url **Usage** ```none usage: symp machine-images import-machine-image-from-url [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--machine-image-id MACHINE_IMAGE_ID] [--description DESCRIPTION] [--guest-os GUEST_OS] [--scope SCOPE] [--project-id PROJECT_ID] [--tags [TAGS [TAGS ...]]] [--os-type-id OS_TYPE_ID] [--firmware FIRMWARE] name block_device_mapping ``` **Description** Imports a new machine image from URL. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: name Name of the machine image block_device_mapping - The mapping of the new machine image to its different snapshots. The format is a JSON string containing a list of blocks. Each of the blocks is a dictionary with the following keys: url, auth, no_verify_ssl, storage_pool, bus_type, disk_type. - The value of auth should contain a list with two elements: username and a password. If it is omitted the URL is accessed without any authentication. - The value of no_verify_ssl is boolean (true or false) - The value of storage_pool indicates the ID of a storage pool. If it is not given, the machine image is created in the default storage pool - The bus_type must be either "virtio" or "ide" - The disk_type must be either "disk" or "cdrom" For example, [{"url": , "auth": , "no_verify_ssl": true|false, "storage_pool": , "bus_type": "virtio"|"ide", "disk_type": "disk"|"cdrom"}, {...}] ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --machine-image-id MACHINE_IMAGE_ID ID of the machine image, shouldn't collide with existing ones --description DESCRIPTION Description of the machine image --guest-os GUEST_OS Guest OS of the machine image --scope SCOPE Scope of the machine image --project-id PROJECT_ID Project ID of the machine image --tags [TAGS [TAGS ...]] Tags to add to the machine image --os-type-id OS_TYPE_ID OS type ID of the machine image --firmware FIRMWARE ``` ## machine-images list **Usage** ```none usage: symp machine-images list [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] [--id [ID [ID ...]]] [--user-id [USER_ID [USER_ID ...]]] [--project-id [PROJECT_ID [PROJECT_ID ...]]] [--account-id [ACCOUNT_ID [ACCOUNT_ID ...]]] [--name [NAME [NAME ...]]] [--description [DESCRIPTION [DESCRIPTION ...]]] [--firmware [FIRMWARE [FIRMWARE ...]]] [--guest-os [GUEST_OS [GUEST_OS ...]]] [--block-device-mapping-snapshot-id [BLOCK_DEVICE_MAPPING_SNAPSHOT_ID [BLOCK_DEVICE_MAPPING_SNAPSHOT_ID ...]]] [--block-device-mapping-volume-size-gib [BLOCK_DEVICE_MAPPING_VOLUME_SIZE_GIB [BLOCK_DEVICE_MAPPING_VOLUME_SIZE_GIB ...]]] [--block-device-mapping-bus-type [BLOCK_DEVICE_MAPPING_BUS_TYPE [BLOCK_DEVICE_MAPPING_BUS_TYPE ...]]] [--block-device-mapping-disk-type [BLOCK_DEVICE_MAPPING_DISK_TYPE [BLOCK_DEVICE_MAPPING_DISK_TYPE ...]]] [--state [STATE [STATE ...]]] [--scope [SCOPE [SCOPE ...]]] [--tag-keys [TAG_KEYS [TAG_KEYS ...]]] [--tag-values [TAG_VALUES [TAG_VALUES ...]]] [--tag [TAG [TAG ...]]] [--with-tags] ``` **Description** Returns all machine images. **Returns** Returns list: Successful Response **Optional** ```none optional arguments: -h, --help show this help message and exit --id [ID [ID ...]] Filter images by id, multiple allowed --user-id [USER_ID [USER_ID ...]] Filter images by user id, multiple allowed --project-id [PROJECT_ID [PROJECT_ID ...]] Filter images by project id, multiple allowed --account-id [ACCOUNT_ID [ACCOUNT_ID ...]] Filter images by account id, multiple allowed --name [NAME [NAME ...]] Filter images by name, multiple allowed --description [DESCRIPTION [DESCRIPTION ...]] Filter images by description, multiple allowed --firmware [FIRMWARE [FIRMWARE ...]] Filter images by firmware, multiple allowed --guest-os [GUEST_OS [GUEST_OS ...]] Filter images by guest_os, multiple allowed --block-device-mapping-snapshot-id [BLOCK_DEVICE_MAPPING_SNAPSHOT_ID [BLOCK_DEVICE_MAPPING_SNAPSHOT_ID ...]] Filter images by bdm snapshot id, multiple allowed --block-device-mapping-volume-size-gib [BLOCK_DEVICE_MAPPING_VOLUME_SIZE_GIB [BLOCK_DEVICE_MAPPING_VOLUME_SIZE_GIB ...]] Filter images by bdm volume size, multiple allowed --block-device-mapping-bus-type [BLOCK_DEVICE_MAPPING_BUS_TYPE [BLOCK_DEVICE_MAPPING_BUS_TYPE ...]] Filter images by bdm bus type, multiple allowed --block-device-mapping-disk-type [BLOCK_DEVICE_MAPPING_DISK_TYPE [BLOCK_DEVICE_MAPPING_DISK_TYPE ...]] Filter images by bdm disk type, multiple allowed --state [STATE [STATE ...]] Filter images by state, multiple allowed --scope [SCOPE [SCOPE ...]] Filter images by scope, multiple allowed --tag-keys [TAG_KEYS [TAG_KEYS ...]] Filter images by tag keys --tag-values [TAG_VALUES [TAG_VALUES ...]] Filter images by tag values --tag [TAG [TAG ...]] Filter images by tag, multiple allowed --with-tags Return response with tags ``` ## machine-images list-tags **Usage** ```none usage: symp machine-images list-tags [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] ``` **Description** List tags of all machine images (restricted by user scope). **Returns** Returns list: Successful Response **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## machine-images os-types add **Usage** ```none usage: symp machine-images os-types add [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] type distro version display_name ``` **Description** Add new OS-type to the system. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: type The type of the OS-type: linux, windows, or other (the default) distro The distro of the OS-type version The version of the OS-type display_name The display name of the OS-type ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## machine-images os-types delete **Usage** ```none usage: symp machine-images os-types delete [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] os_type_id ``` **Description** Deletes an OS-type with the given ID. **Mandatory** ```none positional arguments: os_type_id ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## machine-images os-types detect **Usage** ```none usage: symp machine-images os-types detect [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] volume_id ``` **Description** Detect OS-Type. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: volume_id ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## machine-images os-types find-closest-match **Usage** ```none usage: symp machine-images os-types find-closest-match [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--distro DISTRO] [--version VERSION] os_type ``` **Description** Find the closest matching OS type based on the provided type, distro, and version. If no match is found, the default OS type is returned. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: os_type ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --distro DISTRO --version VERSION ``` ## machine-images os-types get **Usage** ```none usage: symp machine-images os-types get [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] os_type_id ``` **Description** Get OS-type by ID. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: os_type_id ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## machine-images os-types list **Usage** ```none usage: symp machine-images os-types list [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] [--ids [IDS [IDS ...]]] [--types [TYPES [TYPES ...]]] [--distros [DISTROS [DISTROS ...]]] [--versions [VERSIONS [VERSIONS ...]]] ``` **Description** Returns all OS-types **Returns** Returns list: Successful Response **Optional** ```none optional arguments: -h, --help show this help message and exit --ids [IDS [IDS ...]] --types [TYPES [TYPES ...]] --distros [DISTROS [DISTROS ...]] --versions [VERSIONS [VERSIONS ...]] ``` ## machine-images os-types update **Usage** ```none usage: symp machine-images os-types update [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] os_type_id display_name ``` **Description** Updates an OS-type with the given ID. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: os_type_id display_name The display name of the OS-type ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## machine-images remove-tags **Usage** ```none usage: symp machine-images remove-tags [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--project-id PROJECT_ID] [--system-tag] machine_image_id --tags [--tags ...] ``` **Description** Remove tags from a machine image. **Mandatory** ```none positional arguments: machine_image_id ID of image to which to add the tags --tags List of tags to remove ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --project-id PROJECT_ID --system-tag ``` ## machine-images update **Usage** ```none usage: symp machine-images update [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--name NAME] [--description DESCRIPTION] [--firmware FIRMWARE] [--guest-os GUEST_OS] [--scope SCOPE] [--override-protection] [--os-type-id OS_TYPE_ID] machine_image_id ``` **Description** Update machine image’s parameters. **Returns** Returns dict: Successful Response **Mandatory** ```none positional arguments: machine_image_id ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --name NAME Update name of the machine image --description DESCRIPTION Update description of the machine image --firmware FIRMWARE Update firmware of the machine image --guest-os GUEST_OS Update guest OS of the machine image --scope SCOPE Update scope of the machine image --override-protection Override protection of managed machine image --os-type-id OS_TYPE_ID Update OS type ID of the machine image ```