vm¶
vm analyze constraints¶
Usage
usage: symp vm analyze constraints
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Checks what can be done to enable a VM that is currently not able to run on the cluster, to start running.
Returns
Returns list: List of scored suggestions that will enable the VM to run on the cluster
Mandatory
positional arguments:
vm_id The ID of the VM to be analyzed. The VM must be shutoff
Optional
optional arguments:
-h, --help show this help message and exit
vm cancel-migration¶
Usage
usage: symp vm cancel-migration
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Cancel migration of a migrating instance. The action will cause the VM to stop migrating immediately.
Returns
Returns dict: The VM
Mandatory
positional arguments:
vm_id The VM to migrate
Optional
optional arguments:
-h, --help show this help message and exit
vm create¶
Usage
usage: symp vm create
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--image-id IMAGE_ID] [--vcpus VCPUS] [--ram RAM]
[--project-id PROJECT_ID] [--disk-size DISK_SIZE]
[--net-id NET_ID] [--profile PROFILE]
[--restart-on-failure] [--tags [TAGS [TAGS ...]]]
[--boot-volumes BOOT_VOLUMES]
[--volumes-to-attach [VOLUMES_TO_ATTACH [VOLUMES_TO_ATTACH ...]]]
[--user-data USER_DATA] [--metadata METADATA]
[--powerup]
[--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]]
[--security-group-ids [SECURITY_GROUP_IDS [SECURITY_GROUP_IDS ...]]]
[--key-pair KEY_PAIR] [--key-map KEY_MAP]
[--instance-type INSTANCE_TYPE]
[--hw-firmware-type HW_FIRMWARE_TYPE]
[--networks NETWORKS] [--guest-os GUEST_OS]
[--pool POOL] [--disable-delete]
[--instance-profile INSTANCE_PROFILE]
[--availability-zone AVAILABILITY_ZONE]
[--protection-group-id PROTECTION_GROUP_ID] [--bdm BDM]
[--dryrun] [--os-type-id OS_TYPE_ID]
name
Description
Creates a VM workload.
Returns
Returns dict: Details of the newly created VM
Mandatory
positional arguments:
name The name of the VM to be created
Optional
optional arguments:
-h, --help show this help message and exit
--image-id IMAGE_ID Image ID from which to create the VM. Either --image-id or --boot-volumes
must be defined
--vcpus VCPUS The number of vCPUs in the VM
--ram RAM The amount of RAM (MiB) in the VM
--project-id PROJECT_ID
Create the VM in the given project instead of the one logged-in to. Only available
for system admins of the default domain
--disk-size DISK_SIZE
Amount of disk space (GB) in the VM (only if greater than the disk space of the source
Image or boot volume)
--net-id NET_ID The ID of the network to which to attach the VM
--profile PROFILE Sets the SLA profile of the VM to one of the following profiles: spot, 'on demand',
reserved). Default: on demand
--restart-on-failure Restarts the VM if it fails
--tags [TAGS [TAGS ...]]
One or more tags with which to categorize the VM
--boot-volumes BOOT_VOLUMES
Defines the boot volume of the new VM. If there is more than one boot volume it also
indicates the volumes' boot order. Two formats are supported
For a CLI call: the volumes are represented by id=xx:disk_bus=xx:device_type=xx,...
For an API call: the volumes are represented by '[{"id": "xx", "disk_bus": "xx",
"device_type": "xx"},...]'.
Either --boot-volumes or --image-id must be defined
--volumes-to-attach [VOLUMES_TO_ATTACH [VOLUMES_TO_ATTACH ...]]
The ID of one or more additional volumes to be attached to the VM
--user-data USER_DATA
A base64 encoded cloud-init script to use upon launch of the VM
--metadata METADATA Extra metadata to apply to the new VM
--powerup Whether the VM should be powered up upon creation
--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]
The name or ID of one or more security groups to be assigned to the default
VPC network or net_id, upon creation of the VM
If security groups are defined via this argument, then they cannot also be
defined via --security-group-ids or --networks
If security groups have not been defined either via the --security-groups
or --security-group-ids arguments, then the default security groups
of the default VPC network will be assigned
--security-group-ids [SECURITY_GROUP_IDS [SECURITY_GROUP_IDS ...]]
The ID of one or more security groups to be assigned to the default
VPC network or net_id, upon creation of the VM.
If security groups are defined by this argument, then they cannot be
defined via --security-group or --networks.
If security groups have not been defined either via the
--security-group-ids or --security-groups arguments,
then the default security groups of the default VPC network
will be assigned
--key-pair KEY_PAIR The name of a key pair to attach to the VM
--key-map KEY_MAP Sets the default keyboard language for the VM. Default: en-us (Deprecated)
--instance-type INSTANCE_TYPE
The name of the instance type of the VM. This overrides any defined --ram, --vcpus
and --disk-size
--hw-firmware-type HW_FIRMWARE_TYPE
Sets the hardware firmware type of the VM as either bios or uefi. Default: bios
--networks NETWORKS One or more networks to which to attach the VM as defined by the following
parameters: '[{"port_id": "xx"},..]' or '[{"net_id": "xx", "ipv4": "xx",
"mac": "xx", "security_groups": "[xx]", "security_group_ids": "[xx]",
"port_security_enabled": "xx", "dns_name": "xx", "device_index": "xx"}]'
The parameter 'security-groups' will access security groups that have been defined
for the project for which the VM is created, either by name or ID.
The parameter 'security-group-ids' will access these security groups by ID only.
When this argument --networks is used, then the arguments --security-groups and
--security-group-ids cannot be used
--guest-os GUEST_OS Sets the guest OS type as either linux, windows, or solaris
--pool POOL The pool in which to create the VM. The image must to be in this pool.
Use the 'image copy-to-pools' API to copy the image to the pool
--disable-delete Prevents deletion of the VM. (VM deletion can be re-enabled later.)
--instance-profile INSTANCE_PROFILE
The ID of an instance profile to attach to the VM
--availability-zone AVAILABILITY_ZONE
The name of an availability zone the VM will be created in
--protection-group-id PROTECTION_GROUP_ID
The ID of the protection group responsible for creating this VM snapshot
--bdm BDM A list of block device mappings for the VM.
Each of the items in the list is a dictionary with optional keys 'snapshot_id',
'boot_index', 'volume_size_gib', 'storage_pool', 'disk_type' and 'bus_type'.
If 'boot_index' is specified, then 'disk_type' and 'bus_type' must be specified as well.
The values of 'boot_index' in the BDM, if specified, must be sequential and start with 0
(although they do not need to be ordered this way in the input). 'disk_type', if specified,
must be either 'disk' or 'cdrom'. 'bus_type', if specified, must be either
'ide' or 'virtio'. If not specified, the defaults are 'disk' and 'virtio'.
This parameter is mutually exclusive with both boot_volumes and volumes_to_attach
parameters.
Example:
[{"snapshot_id":"ca166313-7050-42d6-87da-7e3e70f611e6","boot_index":0,"disk_type":"disk","bus_type":"ide"},
{"snapshot_id":"9a7fed24-b69a-43dc-85ab-21b318c685ac"}]
--dryrun If true, verify parameters without creating an actual VM
--os-type-id OS_TYPE_ID
If given, will create the new server with this operating system id
as the vm provided os type
vm force-complete-migration¶
Usage
usage: symp vm force-complete-migration
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Force complete migration of an instance during migration. The action will migrate the VM to migrate immediately. The VM will stop during the migration completion.
Returns
Returns dict: The VM
Mandatory
positional arguments:
vm_id The VM to migrate
Optional
optional arguments:
-h, --help show this help message and exit
vm get¶
Usage
usage: symp vm get
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Gets the details of a specific VM.
Returns
Returns dict: The details of a specific VM
Mandatory
positional arguments:
vm_id The ID of the VM
Optional
optional arguments:
-h, --help show this help message and exit
vm get-console-output¶
Usage
usage: symp vm get-console-output
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Show the console output for a VM.
Returns
Returns dict: The console output
Mandatory
positional arguments:
vm_id The ID of the VM
Optional
optional arguments:
-h, --help show this help message and exit
vm get-password-data¶
Usage
usage: symp vm get-password-data
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Get the encrypted Windows password for a VM.
Returns
Returns dict: The encrypted password data
Mandatory
positional arguments:
vm_id The ID of the VM
Optional
optional arguments:
-h, --help show this help message and exit
vm guest-reboot¶
Usage
usage: symp vm guest-reboot
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--override-protection]
vm_id
Description
Reboot VM using ACPI reboot signal.
Returns
Returns dict: The VM object
Mandatory
positional arguments:
vm_id The ID of the VM to reboot
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will reboot the VM even if the VM is protected,
e.g. an internal resource. Allowed only for admins
vm list¶
Usage
usage: symp vm list
[-h] [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--detailed]
[--tag [TAG [TAG ...]]] [--id [ID [ID ...]]]
[--project [PROJECT [PROJECT ...]]]
[--image [IMAGE [IMAGE ...]]]
[--status [STATUS [STATUS ...]]]
[--key-pair [KEY_PAIR [KEY_PAIR ...]]]
[--bdm-device-name [BDM_DEVICE_NAME [BDM_DEVICE_NAME ...]]]
[--bdm-volume-id [BDM_VOLUME_ID [BDM_VOLUME_ID ...]]]
[--host-name [HOST_NAME [HOST_NAME ...]]]
[--instance-type [INSTANCE_TYPE [INSTANCE_TYPE ...]]]
[--created [CREATED [CREATED ...]]]
[--name [NAME [NAME ...]]] [--show-recently-deleted]
[--migration-enabled MIGRATION_ENABLED]
[--availability-zone [AVAILABILITY_ZONE [AVAILABILITY_ZONE ...]]]
[--private-dns-name [PRIVATE_DNS_NAME [PRIVATE_DNS_NAME ...]]]
[--tag-key [TAG_KEY [TAG_KEY ...]]]
[--is-managed-resource IS_MANAGED_RESOURCE]
Description
List VMs.
Returns
Returns list: List of VMs
Optional
optional arguments:
-h, --help show this help message and exit
--detailed Show detailed list
--tag [TAG [TAG ...]]
Filter VMs by attached tags
--id [ID [ID ...]] Filter by VM ID
--project [PROJECT [PROJECT ...]]
Filter VM by project ID
--image [IMAGE [IMAGE ...]]
Filter by VM image ID
--status [STATUS [STATUS ...]]
Filter by VM status
--key-pair [KEY_PAIR [KEY_PAIR ...]]
Filter by VM key-pair name
--bdm-device-name [BDM_DEVICE_NAME [BDM_DEVICE_NAME ...]]
Filter by VM block device mapping device name
--bdm-volume-id [BDM_VOLUME_ID [BDM_VOLUME_ID ...]]
Filter by block device mapping volume ID
--host-name [HOST_NAME [HOST_NAME ...]]
Filter by host that the VM is running on
--instance-type [INSTANCE_TYPE [INSTANCE_TYPE ...]]
Filter by VM instance type
--created [CREATED [CREATED ...]]
Filter by VM created time
--name [NAME [NAME ...]]
Filter by VM name
--show-recently-deleted
Show also VMs that were recently deleted
--migration-enabled MIGRATION_ENABLED
Filter by the ability of a VM to migrate
--availability-zone [AVAILABILITY_ZONE [AVAILABILITY_ZONE ...]]
Filter VMs by availability zone
--private-dns-name [PRIVATE_DNS_NAME [PRIVATE_DNS_NAME ...]]
Filter by the VM's private DNS name of its primary port
--tag-key [TAG_KEY [TAG_KEY ...]]
Filter by the tag key regardless of the tag value
--is-managed-resource IS_MANAGED_RESOURCE
List only managed or not managed resources, or all if omitted
vm list-metadata¶
Usage
usage: symp vm list-metadata
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Returns all metadata of a VM.
Returns
Returns dict: Metadata
Mandatory
positional arguments:
vm_id ID of the VM
Optional
optional arguments:
-h, --help show this help message and exit
vm list-sla-profiles¶
Usage
usage: symp vm list-sla-profiles
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
List SLA profiles in the system.
Returns
Returns list: List of SLA profiles and their details
Optional
optional arguments:
-h, --help show this help message and exit
vm live-migrate¶
Usage
usage: symp vm live-migrate
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id hostname
Description
Migrate VM to another node.
Returns
Returns dict: The VM
Mandatory
positional arguments:
vm_id The VM to migrate
hostname Destination node hostname
Optional
optional arguments:
-h, --help show this help message and exit
vm network-replace¶
Usage
usage: symp vm network-replace
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--ipv4 IPV4] [--mac MAC]
[--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]]
[--security-group-ids [SECURITY_GROUP_IDS [SECURITY_GROUP_IDS ...]]]
[--port-security-enabled PORT_SECURITY_ENABLED]
[--dns-name DNS_NAME]
[--device-index DEVICE_INDEX]
vm_id port_id new_network_id
Description
Replace the network on the provided network interface with the provided new network.
Returns
Returns: The VM object
Mandatory
positional arguments:
vm_id The VM ID to replace the network on
port_id The port (network interface) ID from which the network should be detached
new_network_id The new network ID to attach to the VM
Optional
optional arguments:
-h, --help show this help message and exit
--ipv4 IPV4 Address to allocate to the VM
--mac MAC MAC address to allocate to VM
--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]
A list of security group names to assign to the VM upon attachment,
if unspecified the default security group for tenant is used
--security-group-ids [SECURITY_GROUP_IDS [SECURITY_GROUP_IDS ...]]
A list of security groups ids to assign to the VM upon attachment,
if unspecified the default security group for tenant is used
--port-security-enabled PORT_SECURITY_ENABLED
Optional, if specified overrides whether port security
(anti-spoofing and security groups) is enabled, otherwise
inherited from port_security_enabled setting of network
--dns-name DNS_NAME Host name to be published by the network local DNS server
--device-index DEVICE_INDEX
The index at which to attach the port to the VM
vm networks attach¶
Usage
usage: symp vm networks attach
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--ipv4 IPV4] [--mac MAC]
[--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]]
[--security-group-ids [SECURITY_GROUP_IDS [SECURITY_GROUP_IDS ...]]]
[--port-security-enabled PORT_SECURITY_ENABLED]
[--dns-name DNS_NAME]
[--device-index DEVICE_INDEX]
vm_id network_id
Description
Attach the VM to the network.
Returns
Returns dict: The VM’s object
Mandatory
positional arguments:
vm_id The ID of the VM to attach
network_id The ID of the network to attach the VM to
Optional
optional arguments:
-h, --help show this help message and exit
--ipv4 IPV4 Address to allocate to the VM
--mac MAC MAC address to allocate to the VM
--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]
A list of security groups to assign to the VM upon attachment,
if unspecified the default security group for tenant is used
if security_groups are given then can't get security_group_ids
--security-group-ids [SECURITY_GROUP_IDS [SECURITY_GROUP_IDS ...]]
A list of security groups to assign to the VM upon attachment,
if unspecified the default security group for tenant is used
if security_group_ids are given then can't get security_groups
--port-security-enabled PORT_SECURITY_ENABLED
Optional, if specified overrides whether port security
(anti-spoofing and security groups) is enabled, otherwise
inherited from port_security_enabled setting of network
--dns-name DNS_NAME Host name to be published by the network local DNS server
--device-index DEVICE_INDEX
The index at which to attach the port to the VM
vm networks detach¶
Usage
usage: symp vm networks detach
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id network_id
Description
Detach the VM from the network.
Returns
Returns dict: The VM’s object
Mandatory
positional arguments:
vm_id The ID of the VM that need to be detached
network_id The ID of the VM that need to be detached
Optional
optional arguments:
-h, --help show this help message and exit
vm pause¶
Usage
usage: symp vm pause
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Pause VM.
Returns
Returns dict: The VM object
Mandatory
positional arguments:
vm_id The ID of the VM to pause
Optional
optional arguments:
-h, --help show this help message and exit
vm port attach¶
Usage
usage: symp vm port attach
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--device-index DEVICE_INDEX]
vm_id port_id
Description
Attach a port (network interface) to a given VM.
Returns
Returns: The VM info
Mandatory
positional arguments:
vm_id The VM to attach the port to
port_id The port to attach to the VM
Optional
optional arguments:
-h, --help show this help message and exit
--device-index DEVICE_INDEX
The index at which to attach the port to the VM
vm port detach¶
Usage
usage: symp vm port detach
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
port_id
Description
Detach a port (network interface) from a VM.
Returns
Returns: The VM info
Mandatory
positional arguments:
port_id The port to detach from the VM
Optional
optional arguments:
-h, --help show this help message and exit
vm reboot¶
Usage
usage: symp vm reboot
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--hard] [--override-protection]
vm_id
Description
Reboot VM - Shutdown the VM (Soft will wait for the VM to shut down gracefully) and start it.
Returns
Returns dict: The VM object
Mandatory
positional arguments:
vm_id The ID of the VM to reboot
Optional
optional arguments:
-h, --help show this help message and exit
--hard Do hard reboot
--override-protection
If True, will reboot the VM even if the VM is protected,
e.g. an internal resource. Allowed only for admins
vm rebuild¶
Usage
usage: symp vm rebuild
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--newname NEWNAME] [--user-data USER_DATA]
[--delete-source-boot-volume]
vm_id new_image_id
Description
Create a new boot volume for the VM, from the given image.
Returns
Returns dict: The VM
Mandatory
positional arguments:
vm_id ID of the requested VM
new_image_id The ID of the image to create the new boot-volume from
Optional
optional arguments:
-h, --help show this help message and exit
--newname NEWNAME An optional new name for the VM
--user-data USER_DATA
New user data for the VM
--delete-source-boot-volume
A flag to indicate whether to delete the VM's original boot volume
vm remove¶
Usage
usage: symp vm remove
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--force] [--sync] [--override-protection]
vm_id
Description
Delete a VM.
Returns
Returns dict: The VM’s object
Mandatory
positional arguments:
vm_id The ID of the VM
Optional
optional arguments:
-h, --help show this help message and exit
--force If True, will delete also if the VM is powered-on
--sync Make the operation synchronous, meaning only return when the
VM is deleted. For backward-compatibility
--override-protection
If True, will delete even if the VM is protected from deletion
e.g. an internal resource. Allowed only for admins
vm rename¶
Usage
usage: symp vm rename
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id newname
Description
Rename VM.
Returns
Returns dict: The VM object
Mandatory
positional arguments:
vm_id The ID of the VM to reboot
newname The new name VM name
Optional
optional arguments:
-h, --help show this help message and exit
vm reset-migration¶
Usage
usage: symp vm reset-migration
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--override-protection]
vm_id
Description
Reset the VM state to active in case it has been in migrating state for more than 5 minutes.
Returns
Returns dict: The VM
Mandatory
positional arguments:
vm_id The VM to reset
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will reset migration state even if the VM is protected,
e.g. an internal resource. Allowed only for admins
vm resize¶
Usage
usage: symp vm resize
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--vcpus VCPUS] [--ram RAM] [--disk-size DISK_SIZE]
[--instance-type INSTANCE_TYPE] [--volume-id VOLUME_ID]
vm_id
Description
Re-size the VM and one if its volumes.
Returns
Returns dict: The re-sized VM
Mandatory
positional arguments:
vm_id The ID of the VM that need to be re-sized
Optional
optional arguments:
-h, --help show this help message and exit
--vcpus VCPUS The requested amount of vCPUs to update
--ram RAM The requested size of ram to update
--disk-size DISK_SIZE
The requested size of disk to update, in GB
--instance-type INSTANCE_TYPE
The instance type to update (instead of ram, vcpus, disk above)
--volume-id VOLUME_ID
ID of an attached volume to extend. If omitted, the boot volume will get extended
vm restore¶
Usage
usage: symp vm restore
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--powerup] [--name NAME] [--new-addresses]
[--instance-type INSTANCE_TYPE] [--networks NETWORKS]
[--disk-size DISK_SIZE] [--vcpus VCPUS] [--ram RAM]
[--profile PROFILE] [--restart-on-failure]
[--tags [TAGS [TAGS ...]]] [--metadata METADATA]
[--key-pair KEY_PAIR]
[--hw-firmware-type HW_FIRMWARE_TYPE] [--pool POOL]
[--disable-delete]
[--instance-profile INSTANCE_PROFILE]
vm_snapshot_id
Description
Restore a VM from a VM snapshot.
Returns
Returns dict: Details of the newly created VM
Mandatory
positional arguments:
vm_snapshot_id ID of the VM snapshot to restore from
Optional
optional arguments:
-h, --help show this help message and exit
--powerup Whether the VM should be powered up upon creation
--name NAME If given, overrides the name of the instance in the instance snapshot
--new-addresses If given, use the network definitions from the VM snapshot, but generate new IPv4 and MAC addresses
--instance-type INSTANCE_TYPE
Override the instance type in the VM snapshot. This overrides any defined --ram, --vcpus
and --disk_size
--networks NETWORKS If given, overrides network definitions in the VM snapshot. Format is same as --networks in vm create
--disk-size DISK_SIZE
Override the amount of disk space (GB) in the VM Snapshot (only if greater than the disk space of the source
Image or boot volume)
--vcpus VCPUS Override the number of vCPUs in the VM snapshot
--ram RAM Override the amount of RAM (MiB) in the VM snapshot
--profile PROFILE Overrides the SLA profile of the VM to one of the following profiles: spot, 'on demand',
reserved
--restart-on-failure Override the restart_on_failure attribute in the VM snapshot
--tags [TAGS [TAGS ...]]
Override the tags in the VM snapshot
--metadata METADATA Override the metadata in the VM snapshot
--key-pair KEY_PAIR Override the name of a key pair in the VM snapshot
--hw-firmware-type HW_FIRMWARE_TYPE
Override the hardware firmware type of the VM as either bios or uefi
--pool POOL Override pool in which to create the VM
--disable-delete Override the disable_delete attribute in the VM snapshot
--instance-profile INSTANCE_PROFILE
Override ID of an instance profile to attach to the VM
vm start¶
Usage
usage: symp vm start
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--disk-bus DISK_BUS] [--virtio-volatile-volume]
[--dryrun] [--override-protection]
vm_id
Description
Start VM.
Returns
Returns dict: The VM object
Mandatory
positional arguments:
vm_id The ID of the VM to start
Optional
optional arguments:
-h, --help show this help message and exit
--disk-bus DISK_BUS Disk bus emulation for the boot volume
--virtio-volatile-volume
If given, an extra volume will be created that is deleted on shutdown
--dryrun Do not start the VM, instead analyze constraints on starting it
--override-protection
If true, powerup VM even if it's internal
vm stop¶
Usage
usage: symp vm stop
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--clean] [--force] [--override-protection] [--terminate]
[--delete-boot-volume-on-terminate]
vm_id
Description
Stop VM.
Returns
Returns dict: The VM object
Mandatory
positional arguments:
vm_id The ID of the VM to stop
Optional
optional arguments:
-h, --help show this help message and exit
--clean Gracefully shutdown the server before deleting it. If force is set, this parameter is
set to false automatically
--force Force VM shutdown
--override-protection
If True, will stop even if the VM is protected from deletion as internal
resources. Allowed only for admins
--terminate Delete the VM after shutoff
--delete-boot-volume-on-terminate
When the instance is termintaed should we delete the boot volume
vm tag add¶
Usage
usage: symp vm tag add
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id --tags [--tags ...]
Description
Add tags to a VM.
Mandatory
positional arguments:
vm_id ID of VM to which to add the tags
--tags List of tags to add to VM
Optional
optional arguments:
-h, --help show this help message and exit
vm tag remove¶
Usage
usage: symp vm tag remove
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id --tags [--tags ...]
Description
Remove a tag from a VM.
Mandatory
positional arguments:
vm_id ID of VM to which to add the tags
--tags Tags to remove from VM
Optional
optional arguments:
-h, --help show this help message and exit
vm unpause¶
Usage
usage: symp vm unpause
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Resume paused VM.
Returns
Returns dict: The VM object
Mandatory
positional arguments:
vm_id The ID of the VM to resume
Optional
optional arguments:
-h, --help show this help message and exit
vm update¶
Usage
usage: symp vm update
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--restart-on-failure RESTART_ON_FAILURE]
[--key-map KEY_MAP]
[--hw-firmware-type HW_FIRMWARE_TYPE]
[--disable-delete DISABLE_DELETE]
[--instance-profile INSTANCE_PROFILE]
[--src-dst-check SRC_DST_CHECK]
[--security-group-ids [SECURITY_GROUP_IDS [SECURITY_GROUP_IDS ...]]]
[--os-type-id OS_TYPE_ID]
[--vnc-admin-access VNC_ADMIN_ACCESS]
vm_id
Description
Update VM’s attributes.
Returns
Returns dict: The updated VM
Mandatory
positional arguments:
vm_id ID of the requested VM
Optional
optional arguments:
-h, --help show this help message and exit
--restart-on-failure RESTART_ON_FAILURE
Whether to restart the VM when it dies
--key-map KEY_MAP Default keyboard of the VM (Deprecated)
--hw-firmware-type HW_FIRMWARE_TYPE
Hardware firmware type (BIOS, UEFI)
--disable-delete DISABLE_DELETE
Whether to disallow deletion of the VM
--instance-profile INSTANCE_PROFILE
Id of instance profile to update
--src-dst-check SRC_DST_CHECK
Set this flag on the VM port
--security-group-ids [SECURITY_GROUP_IDS [SECURITY_GROUP_IDS ...]]
List of security group ids to assign to the VM port
--os-type-id OS_TYPE_ID
OS-type-id of the VM to be updated
--vnc-admin-access VNC_ADMIN_ACCESS
Allow admin access to VM's VNC console
vm update-metadata¶
Usage
usage: symp vm update-metadata
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id metadata
Description
Update VM metadata - replace current metadata for a VM.
Returns
Returns dict: Metadata
Mandatory
positional arguments:
vm_id ID of the VM
metadata A dictionary of all metadata (key-value)
Optional
optional arguments:
-h, --help show this help message and exit
vm vnc get-link¶
Usage
usage: symp vm vnc get-link
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id
Description
Get the VM’s VNC console.
Returns
Returns str: VNC console
Mandatory
positional arguments:
vm_id ID of the requested VM
Optional
optional arguments:
-h, --help show this help message and exit
vm volumes attach¶
Usage
usage: symp vm volumes attach
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--device-name DEVICE_NAME]
vm_id volume_id
Description
Attach a volume to a VM.
Returns
Returns dict: Details of the VM
Mandatory
positional arguments:
vm_id The VM ID to attach the volume to
volume_id The volume ID to attach
Optional
optional arguments:
-h, --help show this help message and exit
--device-name DEVICE_NAME
The device name (/dev/hd1|sd1|vd1|xvd1|ubd1)
vm volumes detach¶
Usage
usage: symp vm volumes detach
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_id volume_id
Description
Detach a volume from a VM.
Returns
Returns dict: Details of the VM
Mandatory
positional arguments:
vm_id The VM ID to detach the volume from
volume_id The volume ID to detach
Optional
optional arguments:
-h, --help show this help message and exit
vm-snapshot create¶
Usage
usage: symp vm-snapshot create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--enable-incremental-backup]
[--description DESCRIPTION]
name vm_id
Description
Create a VM snapshot.
Returns
Returns dict: Details of the new VM snapshot
Mandatory
positional arguments:
name Name for the VM snapshot
vm_id VM ID to snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--enable-incremental-backup
Allows creating incremental backups to a remote target
--description DESCRIPTION
Description for the VM snapshot
vm-snapshot create-from-remote-vm¶
Usage
usage: symp vm-snapshot create-from-remote-vm
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--name NAME]
[--description DESCRIPTION]
remote_vm_snapshot_id pool_id
Description
Create VM snapshot from a remote VM snapshot.
Returns
Returns dict: Details of the local VM snapshot
Mandatory
positional arguments:
remote_vm_snapshot_id
ID of a remote VM snapshot to create from
pool_id The pool to create the VM's volumes in
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name of the new local VM snapshot. The default name is the remote VM snapshot name
--description DESCRIPTION
Description of the new local VM snapshot
vm-snapshot delete¶
Usage
usage: symp vm-snapshot delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--force]
vm_snapshot_id
Description
Delete local VM snapshot.
Mandatory
positional arguments:
vm_snapshot_id The ID of the VM snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--force If True, will delete also if the VM-snapshot is in creating state
vm-snapshot get¶
Usage
usage: symp vm-snapshot get
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
vm_snapshot_id
Description
Retrieve VM snapshot metadata.
Returns
Returns dict: Details of the VM snapshot
Mandatory
positional arguments:
vm_snapshot_id The ID of the VM snapshot
Optional
optional arguments:
-h, --help show this help message and exit
vm-snapshot list¶
Usage
usage: symp vm-snapshot list
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]]
[--project-ids [PROJECT_IDS [PROJECT_IDS ...]]]
[--user-ids [USER_IDS [USER_IDS ...]]]
[--names [NAMES [NAMES ...]]]
[--statuses [STATUSES [STATUSES ...]]]
[--source-vm-ids [SOURCE_VM_IDS [SOURCE_VM_IDS ...]]]
[--protection-group-ids [PROTECTION_GROUP_IDS [PROTECTION_GROUP_IDS ...]]]
[--ids [IDS [IDS ...]]] [--detailed]
Description
List VM snapshots.
Returns
Returns list: List of VM snapshots
Optional
optional arguments:
-h, --help show this help message and exit
--account-ids [ACCOUNT_IDS [ACCOUNT_IDS ...]]
Return VM snapshots with any of the specified account IDs
--project-ids [PROJECT_IDS [PROJECT_IDS ...]]
Return VM snapshots with any of the specified project IDs
--user-ids [USER_IDS [USER_IDS ...]]
Return VM snapshots with any of the specified user IDs
--names [NAMES [NAMES ...]]
Return VM snapshots with any of the specified names
--statuses [STATUSES [STATUSES ...]]
Return VM snapshots with any of the specified statuses
--source-vm-ids [SOURCE_VM_IDS [SOURCE_VM_IDS ...]]
Return VM snapshots with any of the specified source VM IDs
--protection-group-ids [PROTECTION_GROUP_IDS [PROTECTION_GROUP_IDS ...]]
Return VM snapshots created by any of the specified protection group IDs
--ids [IDS [IDS ...]]
Return VM snapshots with any of the specified ID
--detailed Also return the parameters of the VM itself
vm-snapshot update¶
Usage
usage: symp vm-snapshot update
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--name NAME] [--description DESCRIPTION]
vm_snapshot_id
Description
Update the VM snapshot.
Returns
Returns dict: Details of the new VM snapshot
Mandatory
positional arguments:
vm_snapshot_id The ID of the VM snapshot
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name for the VM snapshot
--description DESCRIPTION
Description for the VM snapshot