ibm.ComputeVmInstance

(String) The unique identifier of the VM instance.

Cores double

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

Datacenter string

The data center in which you want to provision the instance. Note If dedicated_host_name or dedicated_host_id is provided then the datacenter should be same as the dedicated host datacenter. If placement_group_name or placement_group_id is provided then the datacenter should be same as the placement group datacenter. Conflicts with datacenter_choice.

DatacenterChoices List<ImmutableDictionary<string, string>>

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

Specifies whether the instance must only run on hosts with instances from the same account. The default value is false. If VM is provisioned by using flavorKeyName, value should be set to false. Note Conflicts with dedicated_host_name, dedicated_host_id, placement_group_name and placement_group_id.

DedicatedHostId double

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

Disks List<double>

The numeric disk sizes in GBs for the instance's block device and disk image settings. The default value is the smallest available capacity for the primary disk. If you specify an image template, the template provides the disk capacity. If you specify the flavorKeyName, first disk is provided by the flavor.

Domain string

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

Evault double

Allowed Evault in GB per month for monthly based servers.

FileStorageIds List<double>

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

FlavorKeyName string

The flavor key name that you want to use to provision the instance. To see available key name, log in to the IBM Cloud Classic Infrastructure API, that uses your API key as the password. If you set this option, do not specify cores and memory at the same time.

Hostname string

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

ImageId double

The image template ID that you want to use to provision the computing instance. This is not the global identifier (UUID), but the image template group ID that should point to a valid global identifier. To retrieve the image template ID from the IBM Cloud infrastructure customer portal, navigate to Devices > Manage > Images, click the image that you want, and note the ID number in the resulting URL. Note Conflicts with os_reference_code.

Ipv6Enabled bool

The primary public IPv6 address. The default value is false.

The public static IPv6 address block of /64. The default value is false.

LocalDisk bool

The disk type for the instance. When set to true, the disks for the computing instance are provisioned on the host that the instance runs. Otherwise, SAN disks are provisioned. The default value is true.

Memory double

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

NetworkSpeed double

The connection speed (in Mbps) for the instance's network components. The default value is 100.

Notes string

Descriptive text of up to 1000 characters about the VM instance.

OsReferenceCode string

The operating system reference code that is used to provision the computing instance. To see available OS reference codes, log in to the IBM Cloud Classic Infrastructure API, that uses your API key as the password. Note Conflicts with image_id.

PlacementGroupId double

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

The URI of the script to be downloaded and executed after installation is complete.

When set to true, a compute instance has only access to the private network. The default value is false.

PrivateSecurityGroupIds List<double>

The IDs of security groups to apply on the private interface. This attribute can't be updated. You can use this parameter to add a security group to your virtual server instance when you create it. If you want to add or remove security groups later, you must use the ibm.NetworkInterfaceSgAttachment resource. If you use this attribute in addition to ibm.NetworkInterfaceSgAttachment resource you might experience errors. So use one of these consistently for a particular virtual server instance.

PrivateSubnet string

The private subnet for the private network interface of the instance. Accepted values are primary private networks. You can find accepted values in the subnets doc, Note You can see the list of private subnets of your account.

PrivateVlanId double

The private VLAN ID for the private network interface of the instance. You can find accepted values in the VLAN doc. Click the VLAN that you want to use and note the ID number in the browser URL. You can also refer to a VLAN name by using a data source. Note Conflicts with datacenter_choice.

PublicBandwidthLimited double

Allowed public network traffic in GB per month. It can be greater than 0 when the server is a monthly based server. Defaults to the smallest available capacity for the public bandwidth are used. Note Conflicts with private_network_only and public_bandwidth_unlimited.

Allowed unlimited public network traffic in GB per month for a monthly based server. The network_speed should be 100 Mbps. Default value is false. Note Conflicts with private_network_only and public_bandwidth_limited.

PublicSecurityGroupIds List<double>

The IDs of security groups to apply on the public interface. This attribute can't be updated. You can use this parameter to add a security group to your virtual server instance when you create it. If you want to add or remove security groups later, you must use the ibm.NetworkInterfaceSgAttachment resource. If you use this attribute in addition to ibm.NetworkInterfaceSgAttachment resource, you might experience errors. So use one of these consistently for a particular virtual server instance.

PublicSubnet string

The public subnet for the public network interface of the instance. Accepted values are primary public networks. You can find accepted values in the subnets doc, Note You can see the list of public subnets of your account.

PublicVlanId double

The public VLAN ID for the public network interface of the instance. Accepted values are in the VLAN doc. Click the VLAN that you want and notes the ID number in the browser URL. You can also refer to a VLAN name by using a data source. Note Conflicts with datacenter_choice.

QuoteId double

Quote ID for Quote based provisioning

ReservedCapacityId double

The reserved capacity ID to provision the instance.

Timeouts ComputeVmInstanceTimeouts

The reserved capacity name to provision the instance.

ReservedInstancePrimaryDisk double

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

SecondaryIpCount double

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

SshKeyIds List<double>

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

Tags List<string>

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

Transient bool

Specifies whether to provision a transient virtual server. The default value is false. Transient instances cannot be upgraded or downgraded. Transient instances cannot use local storage. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name, cores, memory, public_bandwidth_limited and public_bandwidth_unlimited.

UserMetadata string

Arbitrary data to be made available to the computing instance.

WaitTimeMinutes double

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

BlockStorageIds []float64

BulkVms []ComputeVmInstanceBulkVmArgs

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

(String) The unique identifier of the VM instance.

Cores float64

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

Datacenter string

DatacenterChoices []map[string]string

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

DedicatedHostId float64

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

Disks []float64

Domain string

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

Evault float64

Allowed Evault in GB per month for monthly based servers.

FileStorageIds []float64

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

FlavorKeyName string

Hostname string

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

ImageId float64

Ipv6Enabled bool

The primary public IPv6 address. The default value is false.

The public static IPv6 address block of /64. The default value is false.

LocalDisk bool

Memory float64

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

NetworkSpeed float64

The connection speed (in Mbps) for the instance's network components. The default value is 100.

Notes string

Descriptive text of up to 1000 characters about the VM instance.

OsReferenceCode string

PlacementGroupId float64

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

The URI of the script to be downloaded and executed after installation is complete.

When set to true, a compute instance has only access to the private network. The default value is false.

PrivateSecurityGroupIds []float64

PrivateSubnet string

PrivateVlanId float64

PublicBandwidthLimited float64

PublicSecurityGroupIds []float64

PublicSubnet string

PublicVlanId float64

QuoteId float64

Quote ID for Quote based provisioning

ReservedCapacityId float64

The reserved capacity ID to provision the instance.

Timeouts ComputeVmInstanceTimeoutsArgs

The reserved capacity name to provision the instance.

ReservedInstancePrimaryDisk float64

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

SecondaryIpCount float64

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

SshKeyIds []float64

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

Tags []string

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

Transient bool

UserMetadata string

Arbitrary data to be made available to the computing instance.

WaitTimeMinutes float64

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

blockStorageIds List<Double>

bulkVms List<ComputeVmInstanceBulkVm>

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

(String) The unique identifier of the VM instance.

cores Double

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

datacenter String

datacenterChoices List<Map<String,String>>

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

dedicatedHostId Double

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

disks List<Double>

domain String

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

evault Double

Allowed Evault in GB per month for monthly based servers.

fileStorageIds List<Double>

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

flavorKeyName String

hostname String

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

hourlyBilling Boolean

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

imageId Double

ipv6Enabled Boolean

The primary public IPv6 address. The default value is false.

ipv6StaticEnabled Boolean

The public static IPv6 address block of /64. The default value is false.

localDisk Boolean

memory Double

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

networkSpeed Double

The connection speed (in Mbps) for the instance's network components. The default value is 100.

notes String

Descriptive text of up to 1000 characters about the VM instance.

osReferenceCode String

placementGroupId Double

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

The URI of the script to be downloaded and executed after installation is complete.

privateNetworkOnly Boolean

When set to true, a compute instance has only access to the private network. The default value is false.

privateSecurityGroupIds List<Double>

privateSubnet String

privateVlanId Double

publicBandwidthLimited Double

publicSecurityGroupIds List<Double>

publicSubnet String

publicVlanId Double

quoteId Double

Quote ID for Quote based provisioning

reservedCapacityId Double

The reserved capacity ID to provision the instance.

The reserved capacity name to provision the instance.

reservedInstancePrimaryDisk Double

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

secondaryIpCount Double

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

sshKeyIds List<Double>

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

tags List<String>

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

bulkVms ComputeVmInstanceBulkVm[]

transient_ Boolean

userMetadata String

Arbitrary data to be made available to the computing instance.

waitTimeMinutes Double

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

blockStorageIds number[]

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

computeVmInstanceId string

(String) The unique identifier of the VM instance.

cores number

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

datacenter string

datacenterChoices {[key: string]: string}[]

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

dedicatedAcctHostOnly boolean

dedicatedHostId number

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

dedicatedHostName string

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

disks number[]

domain string

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

evault number

Allowed Evault in GB per month for monthly based servers.

fileStorageIds number[]

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

flavorKeyName string

hostname string

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

hourlyBilling boolean

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

imageId number

ipv6Enabled boolean

The primary public IPv6 address. The default value is false.

ipv6StaticEnabled boolean

The public static IPv6 address block of /64. The default value is false.

localDisk boolean

memory number

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

networkSpeed number

The connection speed (in Mbps) for the instance's network components. The default value is 100.

notes string

Descriptive text of up to 1000 characters about the VM instance.

osReferenceCode string

placementGroupId number

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

placementGroupName string

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

postInstallScriptUri string

The URI of the script to be downloaded and executed after installation is complete.

privateNetworkOnly boolean

When set to true, a compute instance has only access to the private network. The default value is false.

privateSecurityGroupIds number[]

privateSubnet string

privateVlanId number

publicBandwidthLimited number

publicBandwidthUnlimited boolean

publicSecurityGroupIds number[]

publicSubnet string

publicVlanId number

quoteId number

Quote ID for Quote based provisioning

reservedCapacityId number

The reserved capacity ID to provision the instance.

reservedCapacityName string

The reserved capacity name to provision the instance.

reservedInstancePrimaryDisk number

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

secondaryIpCount number

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

sshKeyIds number[]

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

tags string[]

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

bulk_vms Sequence[ComputeVmInstanceBulkVmArgs]

transient boolean

userMetadata string

Arbitrary data to be made available to the computing instance.

waitTimeMinutes number

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

block_storage_ids Sequence[float]

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

compute_vm_instance_id str

(String) The unique identifier of the VM instance.

cores float

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

datacenter str

datacenter_choices Sequence[Mapping[str, str]]

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

dedicated_acct_host_only bool

dedicated_host_id float

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

dedicated_host_name str

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

disks Sequence[float]

domain str

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

evault float

Allowed Evault in GB per month for monthly based servers.

file_storage_ids Sequence[float]

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

flavor_key_name str

hostname str

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

hourly_billing bool

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

image_id float

ipv6_enabled bool

The primary public IPv6 address. The default value is false.

ipv6_static_enabled bool

The public static IPv6 address block of /64. The default value is false.

local_disk bool

memory float

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

network_speed float

The connection speed (in Mbps) for the instance's network components. The default value is 100.

notes str

Descriptive text of up to 1000 characters about the VM instance.

os_reference_code str

placement_group_id float

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

placement_group_name str

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

post_install_script_uri str

The URI of the script to be downloaded and executed after installation is complete.

private_network_only bool

When set to true, a compute instance has only access to the private network. The default value is false.

private_security_group_ids Sequence[float]

private_subnet str

private_vlan_id float

public_bandwidth_limited float

public_bandwidth_unlimited bool

public_security_group_ids Sequence[float]

public_subnet str

public_vlan_id float

quote_id float

Quote ID for Quote based provisioning

reserved_capacity_id float

The reserved capacity ID to provision the instance.

reserved_capacity_name str

The reserved capacity name to provision the instance.

reserved_instance_primary_disk float

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

secondary_ip_count float

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

ssh_key_ids Sequence[float]

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

tags Sequence[str]

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

timeouts ComputeVmInstanceTimeoutsArgs

transient bool

user_metadata str

Arbitrary data to be made available to the computing instance.

wait_time_minutes float

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

blockStorageIds List<Number>

bulkVms List<Property Map>

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

(String) The unique identifier of the VM instance.

cores Number

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

datacenter String

datacenterChoices List<Map<String>>

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

dedicatedHostId Number

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

disks List<Number>

domain String

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

evault Number

Allowed Evault in GB per month for monthly based servers.

fileStorageIds List<Number>

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

flavorKeyName String

hostname String

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

hourlyBilling Boolean

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

imageId Number

ipv6Enabled Boolean

The primary public IPv6 address. The default value is false.

ipv6StaticEnabled Boolean

The public static IPv6 address block of /64. The default value is false.

localDisk Boolean

memory Number

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

networkSpeed Number

The connection speed (in Mbps) for the instance's network components. The default value is 100.

notes String

Descriptive text of up to 1000 characters about the VM instance.

osReferenceCode String

placementGroupId Number

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

The URI of the script to be downloaded and executed after installation is complete.

privateNetworkOnly Boolean

When set to true, a compute instance has only access to the private network. The default value is false.

privateSecurityGroupIds List<Number>

privateSubnet String

privateVlanId Number

publicBandwidthLimited Number

publicSecurityGroupIds List<Number>

publicSubnet String

publicVlanId Number

quoteId Number

Quote ID for Quote based provisioning

reservedCapacityId Number

The reserved capacity ID to provision the instance.

timeouts Property Map

The reserved capacity name to provision the instance.

reservedInstancePrimaryDisk Number

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

secondaryIpCount Number

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

sshKeyIds List<Number>

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

tags List<String>

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

transient Boolean

userMetadata String

Arbitrary data to be made available to the computing instance.

waitTimeMinutes Number

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

Outputs

All input properties are implicitly available as output properties. Additionally, the ComputeVmInstance resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
IpAddressId double: (String) The unique identifier for the public IPv4 address that is assigned to the VM instance.
IpAddressIdPrivate double: (String) The unique identifier for the private IPv4 address that is assigned to the VM instance.
Ipv4Address string: (String) The public IPv4 address of the VM instance.
Ipv4AddressPrivate string: (String) The private IPv4 address of the VM instance.
Ipv6Address string: (String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.
Ipv6AddressId double: (String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.
PrivateInterfaceId double: (String) The ID of the primary private interface.
PrivateSubnetId double: (String) The unique identifier of the subnet ipv4_address_private belongs to.
PublicInterfaceId double: (String) The ID of the primary public interface.
PublicIpv6Subnet string: (String) The public IPv6 subnet provided when ipv6_enabled is set to true.
PublicIpv6SubnetId double: (String) The unique identifier of the subnet ipv6_address belongs to.
PublicSubnetId double: (String) The unique identifier of the subnet ipv4_address belongs to.
ResourceControllerUrl string: The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceName string: The name of the resource
ResourceStatus string: The status of the resource
SecondaryIpAddresses List<string>: (String) The public secondary IPv4 addresses of the VM instance.

Id string: The provider-assigned unique ID for this managed resource.
IpAddressId float64: (String) The unique identifier for the public IPv4 address that is assigned to the VM instance.
IpAddressIdPrivate float64: (String) The unique identifier for the private IPv4 address that is assigned to the VM instance.
Ipv4Address string: (String) The public IPv4 address of the VM instance.
Ipv4AddressPrivate string: (String) The private IPv4 address of the VM instance.
Ipv6Address string: (String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.
Ipv6AddressId float64: (String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.
PrivateInterfaceId float64: (String) The ID of the primary private interface.
PrivateSubnetId float64: (String) The unique identifier of the subnet ipv4_address_private belongs to.
PublicInterfaceId float64: (String) The ID of the primary public interface.
PublicIpv6Subnet string: (String) The public IPv6 subnet provided when ipv6_enabled is set to true.
PublicIpv6SubnetId float64: (String) The unique identifier of the subnet ipv6_address belongs to.
PublicSubnetId float64: (String) The unique identifier of the subnet ipv4_address belongs to.
ResourceControllerUrl string: The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceName string: The name of the resource
ResourceStatus string: The status of the resource
SecondaryIpAddresses []string: (String) The public secondary IPv4 addresses of the VM instance.

id String: The provider-assigned unique ID for this managed resource.
ipAddressId Double: (String) The unique identifier for the public IPv4 address that is assigned to the VM instance.
ipAddressIdPrivate Double: (String) The unique identifier for the private IPv4 address that is assigned to the VM instance.
ipv4Address String: (String) The public IPv4 address of the VM instance.
ipv4AddressPrivate String: (String) The private IPv4 address of the VM instance.
ipv6Address String: (String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.
ipv6AddressId Double: (String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.
privateInterfaceId Double: (String) The ID of the primary private interface.
privateSubnetId Double: (String) The unique identifier of the subnet ipv4_address_private belongs to.
publicInterfaceId Double: (String) The ID of the primary public interface.
publicIpv6Subnet String: (String) The public IPv6 subnet provided when ipv6_enabled is set to true.
publicIpv6SubnetId Double: (String) The unique identifier of the subnet ipv6_address belongs to.
publicSubnetId Double: (String) The unique identifier of the subnet ipv4_address belongs to.
resourceControllerUrl String: The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceName String: The name of the resource
resourceStatus String: The status of the resource
secondaryIpAddresses List<String>: (String) The public secondary IPv4 addresses of the VM instance.

id string: The provider-assigned unique ID for this managed resource.
ipAddressId number: (String) The unique identifier for the public IPv4 address that is assigned to the VM instance.
ipAddressIdPrivate number: (String) The unique identifier for the private IPv4 address that is assigned to the VM instance.
ipv4Address string: (String) The public IPv4 address of the VM instance.
ipv4AddressPrivate string: (String) The private IPv4 address of the VM instance.
ipv6Address string: (String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.
ipv6AddressId number: (String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.
privateInterfaceId number: (String) The ID of the primary private interface.
privateSubnetId number: (String) The unique identifier of the subnet ipv4_address_private belongs to.
publicInterfaceId number: (String) The ID of the primary public interface.
publicIpv6Subnet string: (String) The public IPv6 subnet provided when ipv6_enabled is set to true.
publicIpv6SubnetId number: (String) The unique identifier of the subnet ipv6_address belongs to.
publicSubnetId number: (String) The unique identifier of the subnet ipv4_address belongs to.
resourceControllerUrl string: The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceName string: The name of the resource
resourceStatus string: The status of the resource
secondaryIpAddresses string[]: (String) The public secondary IPv4 addresses of the VM instance.

id str: The provider-assigned unique ID for this managed resource.
ip_address_id float: (String) The unique identifier for the public IPv4 address that is assigned to the VM instance.
ip_address_id_private float: (String) The unique identifier for the private IPv4 address that is assigned to the VM instance.
ipv4_address str: (String) The public IPv4 address of the VM instance.
ipv4_address_private str: (String) The private IPv4 address of the VM instance.
ipv6_address str: (String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.
ipv6_address_id float: (String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.
private_interface_id float: (String) The ID of the primary private interface.
private_subnet_id float: (String) The unique identifier of the subnet ipv4_address_private belongs to.
public_interface_id float: (String) The ID of the primary public interface.
public_ipv6_subnet str: (String) The public IPv6 subnet provided when ipv6_enabled is set to true.
public_ipv6_subnet_id float: (String) The unique identifier of the subnet ipv6_address belongs to.
public_subnet_id float: (String) The unique identifier of the subnet ipv4_address belongs to.
resource_controller_url str: The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_name str: The name of the resource
resource_status str: The status of the resource
secondary_ip_addresses Sequence[str]: (String) The public secondary IPv4 addresses of the VM instance.

id String: The provider-assigned unique ID for this managed resource.
ipAddressId Number: (String) The unique identifier for the public IPv4 address that is assigned to the VM instance.
ipAddressIdPrivate Number: (String) The unique identifier for the private IPv4 address that is assigned to the VM instance.
ipv4Address String: (String) The public IPv4 address of the VM instance.
ipv4AddressPrivate String: (String) The private IPv4 address of the VM instance.
ipv6Address String: (String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.
ipv6AddressId Number: (String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.
privateInterfaceId Number: (String) The ID of the primary private interface.
privateSubnetId Number: (String) The unique identifier of the subnet ipv4_address_private belongs to.
publicInterfaceId Number: (String) The ID of the primary public interface.
publicIpv6Subnet String: (String) The public IPv6 subnet provided when ipv6_enabled is set to true.
publicIpv6SubnetId Number: (String) The unique identifier of the subnet ipv6_address belongs to.
publicSubnetId Number: (String) The unique identifier of the subnet ipv4_address belongs to.
resourceControllerUrl String: The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceName String: The name of the resource
resourceStatus String: The status of the resource
secondaryIpAddresses List<String>: (String) The public secondary IPv4 addresses of the VM instance.

Look up Existing ComputeVmInstance Resource

Get an existing ComputeVmInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ComputeVmInstanceState, opts?: CustomResourceOptions): ComputeVmInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        block_storage_ids: Optional[Sequence[float]] = None,
        bulk_vms: Optional[Sequence[ComputeVmInstanceBulkVmArgs]] = None,
        compute_vm_instance_id: Optional[str] = None,
        cores: Optional[float] = None,
        datacenter: Optional[str] = None,
        datacenter_choices: Optional[Sequence[Mapping[str, str]]] = None,
        dedicated_acct_host_only: Optional[bool] = None,
        dedicated_host_id: Optional[float] = None,
        dedicated_host_name: Optional[str] = None,
        disks: Optional[Sequence[float]] = None,
        domain: Optional[str] = None,
        evault: Optional[float] = None,
        file_storage_ids: Optional[Sequence[float]] = None,
        flavor_key_name: Optional[str] = None,
        hostname: Optional[str] = None,
        hourly_billing: Optional[bool] = None,
        image_id: Optional[float] = None,
        ip_address_id: Optional[float] = None,
        ip_address_id_private: Optional[float] = None,
        ipv4_address: Optional[str] = None,
        ipv4_address_private: Optional[str] = None,
        ipv6_address: Optional[str] = None,
        ipv6_address_id: Optional[float] = None,
        ipv6_enabled: Optional[bool] = None,
        ipv6_static_enabled: Optional[bool] = None,
        local_disk: Optional[bool] = None,
        memory: Optional[float] = None,
        network_speed: Optional[float] = None,
        notes: Optional[str] = None,
        os_reference_code: Optional[str] = None,
        placement_group_id: Optional[float] = None,
        placement_group_name: Optional[str] = None,
        post_install_script_uri: Optional[str] = None,
        private_interface_id: Optional[float] = None,
        private_network_only: Optional[bool] = None,
        private_security_group_ids: Optional[Sequence[float]] = None,
        private_subnet: Optional[str] = None,
        private_subnet_id: Optional[float] = None,
        private_vlan_id: Optional[float] = None,
        public_bandwidth_limited: Optional[float] = None,
        public_bandwidth_unlimited: Optional[bool] = None,
        public_interface_id: Optional[float] = None,
        public_ipv6_subnet: Optional[str] = None,
        public_ipv6_subnet_id: Optional[float] = None,
        public_security_group_ids: Optional[Sequence[float]] = None,
        public_subnet: Optional[str] = None,
        public_subnet_id: Optional[float] = None,
        public_vlan_id: Optional[float] = None,
        quote_id: Optional[float] = None,
        reserved_capacity_id: Optional[float] = None,
        reserved_capacity_name: Optional[str] = None,
        reserved_instance_primary_disk: Optional[float] = None,
        resource_controller_url: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        secondary_ip_addresses: Optional[Sequence[str]] = None,
        secondary_ip_count: Optional[float] = None,
        ssh_key_ids: Optional[Sequence[float]] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[ComputeVmInstanceTimeoutsArgs] = None,
        transient: Optional[bool] = None,
        user_metadata: Optional[str] = None,
        wait_time_minutes: Optional[float] = None) -> ComputeVmInstance

func GetComputeVmInstance(ctx *Context, name string, id IDInput, state *ComputeVmInstanceState, opts ...ResourceOption) (*ComputeVmInstance, error)

public static ComputeVmInstance Get(string name, Input<string> id, ComputeVmInstanceState? state, CustomResourceOptions? opts = null)

public static ComputeVmInstance get(String name, Output<String> id, ComputeVmInstanceState state, CustomResourceOptions options)

resources:  _:    type: ibm:ComputeVmInstance    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BlockStorageIds List<double>

BulkVms List<ComputeVmInstanceBulkVm>

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

(String) The unique identifier of the VM instance.

Cores double

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

Datacenter string

DatacenterChoices List<ImmutableDictionary<string, string>>

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

DedicatedHostId double

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

Disks List<double>

Domain string

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

Evault double

Allowed Evault in GB per month for monthly based servers.

FileStorageIds List<double>

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

FlavorKeyName string

Hostname string

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

ImageId double

IpAddressId double

(String) The unique identifier for the public IPv4 address that is assigned to the VM instance.

IpAddressIdPrivate double

(String) The unique identifier for the private IPv4 address that is assigned to the VM instance.

Ipv4Address string

(String) The public IPv4 address of the VM instance.

Ipv4AddressPrivate string

(String) The private IPv4 address of the VM instance.

Ipv6Address string

(String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.

Ipv6AddressId double

(String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.

Ipv6Enabled bool

The primary public IPv6 address. The default value is false.

The public static IPv6 address block of /64. The default value is false.

LocalDisk bool

Memory double

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

NetworkSpeed double

The connection speed (in Mbps) for the instance's network components. The default value is 100.

Notes string

Descriptive text of up to 1000 characters about the VM instance.

OsReferenceCode string

PlacementGroupId double

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

The URI of the script to be downloaded and executed after installation is complete.

PrivateInterfaceId double

(String) The ID of the primary private interface.

When set to true, a compute instance has only access to the private network. The default value is false.

PrivateSecurityGroupIds List<double>

PrivateSubnet string

PrivateSubnetId double

(String) The unique identifier of the subnet ipv4_address_private belongs to.

PrivateVlanId double

PublicBandwidthLimited double

PublicInterfaceId double

(String) The ID of the primary public interface.

PublicIpv6Subnet string

(String) The public IPv6 subnet provided when ipv6_enabled is set to true.

PublicIpv6SubnetId double

(String) The unique identifier of the subnet ipv6_address belongs to.

PublicSecurityGroupIds List<double>

PublicSubnet string

PublicSubnetId double

(String) The unique identifier of the subnet ipv4_address belongs to.

PublicVlanId double

QuoteId double

Quote ID for Quote based provisioning

ReservedCapacityId double

The reserved capacity ID to provision the instance.

Timeouts ComputeVmInstanceTimeouts

The reserved capacity name to provision the instance.

ReservedInstancePrimaryDisk double

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

ResourceControllerUrl string

The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance

ResourceName string

The name of the resource

ResourceStatus string

The status of the resource

SecondaryIpAddresses List<string>

(String) The public secondary IPv4 addresses of the VM instance.

SecondaryIpCount double

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

SshKeyIds List<double>

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

Tags List<string>

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

Transient bool

UserMetadata string

Arbitrary data to be made available to the computing instance.

WaitTimeMinutes double

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

BlockStorageIds []float64

BulkVms []ComputeVmInstanceBulkVmArgs

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

(String) The unique identifier of the VM instance.

Cores float64

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

Datacenter string

DatacenterChoices []map[string]string

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

DedicatedHostId float64

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

Disks []float64

Domain string

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

Evault float64

Allowed Evault in GB per month for monthly based servers.

FileStorageIds []float64

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

FlavorKeyName string

Hostname string

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

ImageId float64

IpAddressId float64

(String) The unique identifier for the public IPv4 address that is assigned to the VM instance.

IpAddressIdPrivate float64

(String) The unique identifier for the private IPv4 address that is assigned to the VM instance.

Ipv4Address string

(String) The public IPv4 address of the VM instance.

Ipv4AddressPrivate string

(String) The private IPv4 address of the VM instance.

Ipv6Address string

(String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.

Ipv6AddressId float64

(String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.

Ipv6Enabled bool

The primary public IPv6 address. The default value is false.

The public static IPv6 address block of /64. The default value is false.

LocalDisk bool

Memory float64

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

NetworkSpeed float64

The connection speed (in Mbps) for the instance's network components. The default value is 100.

Notes string

Descriptive text of up to 1000 characters about the VM instance.

OsReferenceCode string

PlacementGroupId float64

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

The URI of the script to be downloaded and executed after installation is complete.

PrivateInterfaceId float64

(String) The ID of the primary private interface.

When set to true, a compute instance has only access to the private network. The default value is false.

PrivateSecurityGroupIds []float64

PrivateSubnet string

PrivateSubnetId float64

(String) The unique identifier of the subnet ipv4_address_private belongs to.

PrivateVlanId float64

PublicBandwidthLimited float64

PublicInterfaceId float64

(String) The ID of the primary public interface.

PublicIpv6Subnet string

(String) The public IPv6 subnet provided when ipv6_enabled is set to true.

PublicIpv6SubnetId float64

(String) The unique identifier of the subnet ipv6_address belongs to.

PublicSecurityGroupIds []float64

PublicSubnet string

PublicSubnetId float64

(String) The unique identifier of the subnet ipv4_address belongs to.

PublicVlanId float64

QuoteId float64

Quote ID for Quote based provisioning

ReservedCapacityId float64

The reserved capacity ID to provision the instance.

Timeouts ComputeVmInstanceTimeoutsArgs

The reserved capacity name to provision the instance.

ReservedInstancePrimaryDisk float64

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

ResourceControllerUrl string

The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance

ResourceName string

The name of the resource

ResourceStatus string

The status of the resource

SecondaryIpAddresses []string

(String) The public secondary IPv4 addresses of the VM instance.

SecondaryIpCount float64

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

SshKeyIds []float64

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

Tags []string

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

Transient bool

UserMetadata string

Arbitrary data to be made available to the computing instance.

WaitTimeMinutes float64

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

blockStorageIds List<Double>

bulkVms List<ComputeVmInstanceBulkVm>

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

(String) The unique identifier of the VM instance.

cores Double

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

datacenter String

datacenterChoices List<Map<String,String>>

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

dedicatedHostId Double

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

disks List<Double>

domain String

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

evault Double

Allowed Evault in GB per month for monthly based servers.

fileStorageIds List<Double>

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

flavorKeyName String

hostname String

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

hourlyBilling Boolean

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

imageId Double

ipAddressId Double

(String) The unique identifier for the public IPv4 address that is assigned to the VM instance.

ipAddressIdPrivate Double

(String) The unique identifier for the private IPv4 address that is assigned to the VM instance.

ipv4Address String

(String) The public IPv4 address of the VM instance.

ipv4AddressPrivate String

(String) The private IPv4 address of the VM instance.

ipv6Address String

(String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.

ipv6AddressId Double

(String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.

ipv6Enabled Boolean

The primary public IPv6 address. The default value is false.

ipv6StaticEnabled Boolean

The public static IPv6 address block of /64. The default value is false.

localDisk Boolean

memory Double

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

networkSpeed Double

The connection speed (in Mbps) for the instance's network components. The default value is 100.

notes String

Descriptive text of up to 1000 characters about the VM instance.

osReferenceCode String

placementGroupId Double

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

The URI of the script to be downloaded and executed after installation is complete.

privateInterfaceId Double

(String) The ID of the primary private interface.

privateNetworkOnly Boolean

When set to true, a compute instance has only access to the private network. The default value is false.

privateSecurityGroupIds List<Double>

privateSubnet String

privateSubnetId Double

(String) The unique identifier of the subnet ipv4_address_private belongs to.

privateVlanId Double

publicBandwidthLimited Double

publicInterfaceId Double

(String) The ID of the primary public interface.

publicIpv6Subnet String

(String) The public IPv6 subnet provided when ipv6_enabled is set to true.

publicIpv6SubnetId Double

(String) The unique identifier of the subnet ipv6_address belongs to.

publicSecurityGroupIds List<Double>

publicSubnet String

publicSubnetId Double

(String) The unique identifier of the subnet ipv4_address belongs to.

publicVlanId Double

quoteId Double

Quote ID for Quote based provisioning

reservedCapacityId Double

The reserved capacity ID to provision the instance.

The reserved capacity name to provision the instance.

reservedInstancePrimaryDisk Double

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

resourceControllerUrl String

The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance

resourceName String

The name of the resource

resourceStatus String

The status of the resource

secondaryIpAddresses List<String>

(String) The public secondary IPv4 addresses of the VM instance.

secondaryIpCount Double

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

sshKeyIds List<Double>

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

tags List<String>

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

bulkVms ComputeVmInstanceBulkVm[]

transient_ Boolean

userMetadata String

Arbitrary data to be made available to the computing instance.

waitTimeMinutes Double

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

blockStorageIds number[]

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

computeVmInstanceId string

(String) The unique identifier of the VM instance.

cores number

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

datacenter string

datacenterChoices {[key: string]: string}[]

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

dedicatedAcctHostOnly boolean

dedicatedHostId number

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

dedicatedHostName string

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

disks number[]

domain string

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

evault number

Allowed Evault in GB per month for monthly based servers.

fileStorageIds number[]

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

flavorKeyName string

hostname string

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

hourlyBilling boolean

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

imageId number

ipAddressId number

(String) The unique identifier for the public IPv4 address that is assigned to the VM instance.

ipAddressIdPrivate number

(String) The unique identifier for the private IPv4 address that is assigned to the VM instance.

ipv4Address string

(String) The public IPv4 address of the VM instance.

ipv4AddressPrivate string

(String) The private IPv4 address of the VM instance.

ipv6Address string

(String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.

ipv6AddressId number

(String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.

ipv6Enabled boolean

The primary public IPv6 address. The default value is false.

ipv6StaticEnabled boolean

The public static IPv6 address block of /64. The default value is false.

localDisk boolean

memory number

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

networkSpeed number

The connection speed (in Mbps) for the instance's network components. The default value is 100.

notes string

Descriptive text of up to 1000 characters about the VM instance.

osReferenceCode string

placementGroupId number

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

placementGroupName string

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

postInstallScriptUri string

The URI of the script to be downloaded and executed after installation is complete.

privateInterfaceId number

(String) The ID of the primary private interface.

privateNetworkOnly boolean

When set to true, a compute instance has only access to the private network. The default value is false.

privateSecurityGroupIds number[]

privateSubnet string

privateSubnetId number

(String) The unique identifier of the subnet ipv4_address_private belongs to.

privateVlanId number

publicBandwidthLimited number

publicBandwidthUnlimited boolean

publicInterfaceId number

(String) The ID of the primary public interface.

publicIpv6Subnet string

(String) The public IPv6 subnet provided when ipv6_enabled is set to true.

publicIpv6SubnetId number

(String) The unique identifier of the subnet ipv6_address belongs to.

publicSecurityGroupIds number[]

publicSubnet string

publicSubnetId number

(String) The unique identifier of the subnet ipv4_address belongs to.

publicVlanId number

quoteId number

Quote ID for Quote based provisioning

reservedCapacityId number

The reserved capacity ID to provision the instance.

reservedCapacityName string

The reserved capacity name to provision the instance.

reservedInstancePrimaryDisk number

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

resourceControllerUrl string

The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance

resourceName string

The name of the resource

resourceStatus string

The status of the resource

secondaryIpAddresses string[]

(String) The public secondary IPv4 addresses of the VM instance.

secondaryIpCount number

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

sshKeyIds number[]

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

tags string[]

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

bulk_vms Sequence[ComputeVmInstanceBulkVmArgs]

transient boolean

userMetadata string

Arbitrary data to be made available to the computing instance.

waitTimeMinutes number

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

block_storage_ids Sequence[float]

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

compute_vm_instance_id str

(String) The unique identifier of the VM instance.

cores float

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

datacenter str

datacenter_choices Sequence[Mapping[str, str]]

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

dedicated_acct_host_only bool

dedicated_host_id float

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

dedicated_host_name str

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

disks Sequence[float]

domain str

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

evault float

Allowed Evault in GB per month for monthly based servers.

file_storage_ids Sequence[float]

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

flavor_key_name str

hostname str

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

hourly_billing bool

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

image_id float

ip_address_id float

(String) The unique identifier for the public IPv4 address that is assigned to the VM instance.

ip_address_id_private float

(String) The unique identifier for the private IPv4 address that is assigned to the VM instance.

ipv4_address str

(String) The public IPv4 address of the VM instance.

ipv4_address_private str

(String) The private IPv4 address of the VM instance.

ipv6_address str

(String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.

ipv6_address_id float

(String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.

ipv6_enabled bool

The primary public IPv6 address. The default value is false.

ipv6_static_enabled bool

The public static IPv6 address block of /64. The default value is false.

local_disk bool

memory float

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

network_speed float

The connection speed (in Mbps) for the instance's network components. The default value is 100.

notes str

Descriptive text of up to 1000 characters about the VM instance.

os_reference_code str

placement_group_id float

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

placement_group_name str

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

post_install_script_uri str

The URI of the script to be downloaded and executed after installation is complete.

private_interface_id float

(String) The ID of the primary private interface.

private_network_only bool

When set to true, a compute instance has only access to the private network. The default value is false.

private_security_group_ids Sequence[float]

private_subnet str

private_subnet_id float

(String) The unique identifier of the subnet ipv4_address_private belongs to.

private_vlan_id float

public_bandwidth_limited float

public_bandwidth_unlimited bool

public_interface_id float

(String) The ID of the primary public interface.

public_ipv6_subnet str

(String) The public IPv6 subnet provided when ipv6_enabled is set to true.

public_ipv6_subnet_id float

(String) The unique identifier of the subnet ipv6_address belongs to.

public_security_group_ids Sequence[float]

public_subnet str

public_subnet_id float

(String) The unique identifier of the subnet ipv4_address belongs to.

public_vlan_id float

quote_id float

Quote ID for Quote based provisioning

reserved_capacity_id float

The reserved capacity ID to provision the instance.

reserved_capacity_name str

The reserved capacity name to provision the instance.

reserved_instance_primary_disk float

Size of the main drive. Note We can provision only monthly based servers in a reserved capacity.

resource_controller_url str

The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance

resource_name str

The name of the resource

resource_status str

The status of the resource

secondary_ip_addresses Sequence[str]

(String) The public secondary IPv4 addresses of the VM instance.

secondary_ip_count float

Specifies secondary public IPv4 addresses. Accepted values are 4 and 8.

ssh_key_ids Sequence[float]

The SSH key IDs to install on the computing instance when the instance provisions. Note If you don't know the ID(s) for your SSH keys, you can reference your SSH keys by their labels.

tags Sequence[str]

Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

timeouts ComputeVmInstanceTimeoutsArgs

transient bool

user_metadata str

Arbitrary data to be made available to the computing instance.

wait_time_minutes float

Use Timeouts block to wait for the VM instance to become available, or while waiting for non active transactions before proceeding with an update or deletion. The default value is 90.

Deprecated: Deprecated

blockStorageIds List<Number>

bulkVms List<Property Map>

Hostname and domain of the computing instance. The minimum number of VM's to be defined is 2.

Nested scheme for bulk_vms:

(String) The unique identifier of the VM instance.

cores Number

The number of CPU cores that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

datacenter String

datacenterChoices List<Map<String>>

A nested block to describe datacenter choice options to retry on different data centers and VLANs. Nested datacenter_choice blocks must have the following structure:

Nested scheme for datacenter_choice:

dedicatedHostId Number

Specifies dedicated host for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, placement_group_name and placement_group_id.

Specifies dedicated host for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, placement_group_name and placement_group_id.

disks List<Number>

domain String

The domain for the computing instance. If you set this option, do not specify bulk_vms at the same time.

evault Number

Allowed Evault in GB per month for monthly based servers.

fileStorageIds List<Number>

File storage to which this computing instance has access. File storage must be in the same data center as the Bare Metal server. If you use this argument to authorize, access to file storage, then do not use the allowed_virtual_guest_ids argument in the ibm.StorageFile resource in order to prevent the same storage be added twice.

flavorKeyName String

hostname String

The hostname for the computing instance. If you set this option, do not specify bulk_vms at the same time.

hourlyBilling Boolean

The billing type for the instance. When set to true, the computing instance is billed on hourly usage. Otherwise, the instance is billed monthly. The default value is true.

imageId Number

ipAddressId Number

(String) The unique identifier for the public IPv4 address that is assigned to the VM instance.

ipAddressIdPrivate Number

(String) The unique identifier for the private IPv4 address that is assigned to the VM instance.

ipv4Address String

(String) The public IPv4 address of the VM instance.

ipv4AddressPrivate String

(String) The private IPv4 address of the VM instance.

ipv6Address String

(String) The public IPv6 address of the VM instance provided when ipv6_enabled is set to true.

ipv6AddressId Number

(String) The unique identifier for the public IPv6 address assigned to the VM instance provided when ipv6_enabled is set to true.

ipv6Enabled Boolean

The primary public IPv6 address. The default value is false.

ipv6StaticEnabled Boolean

The public static IPv6 address block of /64. The default value is false.

localDisk Boolean

memory Number

The amount of memory, expressed in megabytes, that you want to allocate. If you set this option, do not specify flavor_key_name at the same time.

networkSpeed Number

The connection speed (in Mbps) for the instance's network components. The default value is 100.

notes String

Descriptive text of up to 1000 characters about the VM instance.

osReferenceCode String

placementGroupId Number

Specifies placement group for the instance by its ID. Note Conflicts with dedicated_acct_host_only, dedicated_host_name, dedicated_host_id and placement_group_name.

Specifies placement group for the instance by its name. Note Conflicts with dedicated_acct_host_only, dedicated_host_id, dedicated_host_name and placement_group_id-

The URI of the script to be downloaded and executed after installation is complete.

privateInterfaceId Number

(String) The ID of the primary private interface.

privateNetworkOnly Boolean

When set to true, a compute instance has only access to the private network. The default value is false.

privateSecurityGroupIds List<Number>

privateSubnet String

privateSubnetId Number

(String) The unique identifier of the subnet ipv4_address_private belongs to.

privateVlanId Number

publicBandwidthLimited Number

publicInterfaceId Number

(String) The ID of the primary public interface.

publicIpv6Subnet String

(String) The public IPv6 subnet provided when ipv6_enabled is set to true.

publicIpv6SubnetId Number

(String) The unique identifier of the subnet ipv6_address belongs to.

publicSecurityGroupIds List<Number>

publicSubnet String

publicSubnetId Number

(String) The unique identifier of the subnet ipv4_address belongs to.

publicVlanId Number

quoteId Number

Quote ID for Quote based provisioning

reservedCapacityId Number

The reserved capacity ID to provision the instance.