list-vm-types¶

Description¶

Lists the available virtual machine types and their metadata for a given cloud credential and region.

Synopsis¶

  list-vm-types
[--credential-name <value>]
[--credential-crn <value>]
[--region <value>]
[--platform-variant <value>]
[--availability-zone <value>]
[--resource-type <value>]
[--architecture <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--credential-name (string)

The name of the credential. Either this or credential-crn must be provided.

--credential-crn (string)

The CRN of the credential. Either this or credential-name must be provided.

--region (string)

The region to list VM types for.

--platform-variant (string)

The variant of the cloud platform.

--availability-zone (string)

The availability zone.

--resource-type (string)

The resource type to filter by.

--architecture (string)

The CPU architecture to filter by.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

vmTypes -> (array)

List of VM type entries per cloud platform.

item -> (object)

VM types grouped by platform.

platform -> (string)

The cloud platform (e.g., AWS, AZURE, GCP).

virtualMachines -> (array)

The list of available VM types for the platform.

item -> (object)

A VM type.

name -> (string)

The name of the VM type.

vmTypeMetadata -> (object)

Metadata about a VM type, including volume configurations and properties.

configs -> (array)

The list of volume parameter configurations.

( … recursive … )

properties -> (map)

Additional properties of the VM type.

key -> (string)

value -> (string)

defaultVirtualMachine -> (object)

A VM type.

name -> (string)

The name of the VM type.

vmTypeMetadata -> (object)

Metadata about a VM type, including volume configurations and properties.

configs -> (array)

The list of volume parameter configurations.

item -> (object)

Volume parameter configuration for a VM type.

volumeParameterType -> (string)

The type of volume parameter (e.g., SSD, MAGNETIC).

minimumSize -> (integer)

The minimum volume size in GB.

maximumSize -> (integer)

The maximum volume size in GB.

minimumNumber -> (integer)

The minimum number of volumes.

maximumNumber -> (integer)

The maximum number of volumes.

properties -> (map)

Additional properties of the VM type.

key -> (string)

value -> (string)

Form Factors¶

public, private