# instance ## instance type access-add **Usage** ```none usage: symp instance type access-add [-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] instance_type project_id ``` **Description** Add a project to the access list of instance type. **Returns** Returns list: Access list of the instance type **Mandatory** ```none positional arguments: instance_type Name of instance type project_id ID of project to add access for ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance type access-list **Usage** ```none usage: symp instance type access-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] instance_type ``` **Description** Get the list of tenants that have access to the instance type. **Returns** Returns list: Access list of the instance type **Mandatory** ```none positional arguments: instance_type Name of instance type ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance type access-remove **Usage** ```none usage: symp instance type access-remove [-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] instance_type project_id ``` **Description** Remove a project from the access list of instance type. **Returns** Returns list: Access list of the instance type **Mandatory** ```none positional arguments: instance_type Name of instance type project_id ID of project to remove access for ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance type alias create **Usage** ```none usage: symp instance type alias create [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] instance_type_name instance_type_alias ``` **Description** Create instance type alias mapping. **Returns** Returns dict: Details of new instance type **Mandatory** ```none positional arguments: instance_type_name The name of the Zadara instance type instance_type_alias The alias name of the AWS instance type ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance type alias delete **Usage** ```none usage: symp instance type alias 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 ...]]] [--uuid UUID] [--instance-type-alias INSTANCE_TYPE_ALIAS] ``` **Description** Delete instance type alias mapping by either providing the mapping’s uuid or by its Alias name, but not both. **Returns** Returns str: The uuid of the deleted instance type alias mapping **Optional** ```none optional arguments: -h, --help show this help message and exit --uuid UUID The uuid of the instance type alias mapping (optional) --instance-type-alias INSTANCE_TYPE_ALIAS The name of the AWS instance type alias (optional) ``` ## instance type alias get **Usage** ```none usage: symp instance type alias 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 ...]]] [--uuid UUID] [--instance-type-alias INSTANCE_TYPE_ALIAS] ``` **Description** Get instance type alias mapping by either providing the mapping’s uuid or by its Alias name, but not both. **Returns** Returns dict: Details of instance type alias mapping **Optional** ```none optional arguments: -h, --help show this help message and exit --uuid UUID The uuid of the instance type alias mapping (optional) --instance-type-alias INSTANCE_TYPE_ALIAS The name of the AWS instance type alias (optional) ``` ## instance type alias list **Usage** ```none usage: symp instance type alias 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] ``` **Description** List instance type alias mapping. **Returns** Returns list: List of instance type alias mapping **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance type alias update **Usage** ```none usage: symp instance type alias 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 ...]]] [--instance-type-alias INSTANCE_TYPE_ALIAS] [--instance-type-name INSTANCE_TYPE_NAME] uuid ``` **Description** Update the AWS instance type alias record. Can update either the alias name, the instance type name or both. **Returns** Returns dict: Details of updated instance type alias mapping **Mandatory** ```none positional arguments: uuid The uuid of the instance type alias mapping ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --instance-type-alias INSTANCE_TYPE_ALIAS The updated name of the AWS instance type alias --instance-type-name INSTANCE_TYPE_NAME The updated name of the zCompute instance type ``` ## instance type create **Usage** ```none usage: symp instance type create [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--is-public] [--pci-device-requests PCI_DEVICE_REQUESTS] [--sockets SOCKETS] [--cores CORES] [--threads THREADS] name memory_mb vcpus ``` **Description** Create a new instance type. **Returns** Returns dict: Details of new instance type **Mandatory** ```none positional arguments: name A unique name for the instance type memory_mb Amount of memory in MiB vcpus Number of vCPUs ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --is-public Whether instance type is public --pci-device-requests PCI_DEVICE_REQUESTS JSON based List of PCI devices where each contains vendor_id, device_id and count --sockets SOCKETS Number of CPU sockets, defaults to Number of vCPUs --cores CORES Number of CPU cores per socket, defaults to 1 --threads THREADS Number of threads per CPU core, defaults to 1 ``` ## instance type delete **Usage** ```none usage: symp instance type 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 ...]]] instance_type ``` **Description** Deletes the specified instance type. **Mandatory** ```none positional arguments: instance_type Name of instance type ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance type get **Usage** ```none usage: symp instance type 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 ...]]] instance_type ``` **Description** Returns details of the specified instance type. **Returns** Returns dict: Details of instance type **Mandatory** ```none positional arguments: instance_type Name of instance type ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance type list **Usage** ```none usage: symp instance type 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] [--show-disabled] [--marker MARKER] [--limit LIMIT] ``` **Description** Returns all instance types. **Returns** Returns list: Instance types **Optional** ```none optional arguments: -h, --help show this help message and exit --show-disabled By default, disabled instance types are not shown (relevant for admin only) --marker MARKER Begin returning flavors that appear later in the flavor list than that represented by this flavor id (optional) --limit LIMIT Maximum number of flavors to return (optional) ``` ## instance type tag **Usage** ```none usage: symp instance type tag [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] instance_type --tags [--tags ...] ``` **Description** Assigns tags to an instance_type and updates existing VM’s with the needed tags. **Mandatory** ```none positional arguments: instance_type Name of instance type --tags List of tags to add ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance-profile add-role **Usage** ```none usage: symp instance-profile add-role [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] instance_profile_id role_id ``` **Description** Adds the specified role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased. You can remove the existing role and then add a different role to an instance profile. **Mandatory** ```none positional arguments: instance_profile_id The ID of the instance profile to update role_id The ID of the role to add ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance-profile create **Usage** ```none usage: symp instance-profile create [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--path PATH] [--project-id PROJECT_ID] name ``` **Description** Creates a new instance profile. **Returns** Returns dict: A structure containing details about the new instance profile **Mandatory** ```none positional arguments: name The name of the instance profile to create ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --path PATH The path to the instance profile --project-id PROJECT_ID The ID of the project in which the instance-profile will be created (for admin only) ``` ## instance-profile get **Usage** ```none usage: symp instance-profile 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 ...]]] instance_profile_id ``` **Description** Retrieves information about the specified instance profile. **Returns** Returns dict: A structure containing details about the instance profile **Mandatory** ```none positional arguments: instance_profile_id The ID of the instance-profile to get ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance-profile list **Usage** ```none usage: symp instance-profile 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] [--name NAME] [--project-id PROJECT_ID] ``` **Description** Lists the instance profiles. **Returns** Returns list: The instance profiles **Optional** ```none optional arguments: -h, --help show this help message and exit --name NAME Only list instance profiles with the given name --project-id PROJECT_ID ID of project to list instance profiles for (only for admin) ``` ## instance-profile remove **Usage** ```none usage: symp instance-profile remove [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] instance_profile_id ``` **Description** Deletes the specified instance profile. The instance profile must not have an associated role. **Mandatory** ```none positional arguments: instance_profile_id The ID of the instance-profile to remove ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## instance-profile remove-role **Usage** ```none usage: symp instance-profile remove-role [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] instance_profile_id role_id ``` **Description** Removes the specified role from the specified instance profile. **Mandatory** ```none positional arguments: instance_profile_id The ID of the instance profile to update role_id The ID of the role to remove ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ```