The images data source can be used to search for and return an existing image which can then be used to provision a server.

Example Usage

Argument Reference

• name - (Required) Name of an existing image that you want to search for.

• version - (Optional) Version of the image (see details below).

• location - (Optional) Id of the existing image's location.

• type - (Optional) The image type, HDD or CD-ROM.

• cloud_init - (Optional) Cloud init compatibility ("NONE" or "V1")

If both "name" and "version" are provided the plugin will concatenate the two strings in this format [name]-[version].

Attributes Reference

• id - UUID of the image

• name - name of the image

• description - description of the image

• size - The size of the image in GB

• cpu_hot_plug - Is capable of CPU hot plug (no reboot required)

• cpu_hot_unplug - Is capable of CPU hot unplug (no reboot required)

• ram_hot_plug - Is capable of memory hot plug (no reboot required)

• ram_hot_unplug - Is capable of memory hot unplug (no reboot required)

• nic_hot_plug - Is capable of nic hot plug (no reboot required)

• nic_hot_unplug - Is capable of nic hot unplug (no reboot required)

• disc_virtio_hot_plug - Is capable of Virt-IO drive hot plug (no reboot required)

• disc_virtio_hot_unplug - Is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines

• disc_scsi_hot_plug - Is capable of SCSI drive hot plug (no reboot required)

• disc_scsi_hot_unplug - Is capable of SCSI drive hot unplug (no reboot required). This works only for non-Windows virtual Machines

• license_type - OS type of this Image

• public - Indicates if the image is part of the public repository or not

• image_aliases - List of image aliases mapped for this Image

• cloud_init - Cloud init compatibility

• type - This indicates the type of image

• location - Location of that image/snapshot.

The firewall data source can be used to search for and return an existing FirewallRules. You can provide a string for either id or name parameters which will be compared with provisioned Firewall Rules. If a single match is found, it will be returned. If your search results in multiple matches, an error will be generated. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

Argument Reference

The following arguments are supported:

• name - (Optional) Name of an existing firewall rule that you want to search for.

• id - (Optional) ID of the firewall rule you want to search for.

• datacenter_id - (Required) The Virtual Data Center ID.

• server_id - (Required) The Server ID.

• nic_id - (Required) The NIC ID.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the firewall rule.

• name - The name of the firewall rule.

• protocol - The protocol for the rule: TCP, UDP, ICMP, ANY.

• source_mac - Only traffic originating from the respective MAC address is allowed.

• source_ip - Only traffic originating from the respective IPv4 address is allowed.

• target_ip - Only traffic directed to the respective IP address of the NIC is allowed.

• port_range_start - Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen.

• port_range_end - Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen.

• icmp_type - Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen.

• icmp_code - Defines the allowed code (from 0 to 254) if protocol ICMP is chosen.

The lans data source can be used to search for and return existing lans.

Example Usage

Argument Reference

• name - (Optional) Name of an existing lan that you want to search for.

• id - (Optional) ID of the lan you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the LAN.

• name - The name of the LAN.

• datacenter_id - The ID of lan's Virtual Data Center.

• ip_failover - list of

  • nic_uuid

  • ip

• pcc - The unique id of a ionoscloud_private_crossconnect resource, in order.

• public - Indicates if the LAN faces the public Internet (true) or not (false).

The ip block data source can be used to search for and return an existing Ip Block. You can provide a string for the id, the name or the location parameters which will be compared with the provisioned Ip Blocks. If a single match is found, it will be returned. If your search results in multiple matches, the first result found will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

data "ionoscloud_ipblock" "example" {
  id =` <ipblock_id>`
}

Argument reference

• id - (Optional) ID of an existing Ip Block that you want to search for.

• name - (Optional) Name of an existing Ip Block that you want to search for.

• location - (Optional) ID of the existing Ip Block location.

Attributes Reference

• id - The id of Ip Block

• name - The name of Ip Block

• location - The regional location for this IP Block: us/las, us/ewr, de/fra, de/fkb.

• size - The number of IP addresses to reserve for this block.

• ips - The list of IP addresses associated with this block.

• ip_consumers Read-Only attribute. Lists consumption detail of an individual ip

  • ip

  • mac

  • nic_uuid

  • server_id

  • server_name

  • datacenter_id

  • datacenter_name

  • k8s_nodepool_uuid

  • k8s_cluster_uuid

The share data source can be used to search for and return an existing ip failover object. You need to provide the datacenter_id and failover_id to get the ip failover object for the provided datacenter.

Example Usage

data "ionoscloud_ipfailover" "failovertest" {
  datacenter_id = "datacenterId"
  id = "failover_resource_id"
}

Argument Reference

The following arguments are supported:

• datacenter_id - (Required)The ID of the datacenter containing the ip failover datasource

• id - (Required)The id of the ip failover object

Attributes Reference

The following attributes are returned by the datasource:

• datacenter_id - The ID of a Data Center.

• ip - The reserved IP address to be used in the IP failover group.

• lan_id - The ID of a LAN.

• nicuuid - The ID of a NIC.

The private crossconnect data source can be used to search for and return existing private crossconnects.

Example Usage

Argument Reference

• name - (Optional) Name of an existing private crossconnect that you want to search for.

• id - (Optional) ID of the private crossconnect you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the private cross-connection.

• name - The name of the private cross-connection.

• description - The description for the private cross-connection.

• peers - Lists LAN's joined to this private cross connect

  • lan_id

  • lan_name

  • datacenter_id

  • datacenter_name

  • location

• connectable_datacenters - Lists datacenters that can be joined to this private cross connect

  • id

  • name

  • location

The locations data source can be used to search for and return an existing location which can then be used elsewhere in the configuration.

Example Usage

Argument Reference

• name - (Required) Name of the location to search for.

• feature - (Optional) A desired feature that the location must be able to provide.

Attributes Reference

The following attributes are returned by the datasource:

• id - UUID of the location

The snapshots data source can be used to search for and return an existing snapshot which can then be used to provision a server.

Example Usage

Argument Reference

• id - (Optional) Uuid of an existing snapshot that you want to search for.

• name - (Optional) Name of an existing snapshot that you want to search for.

• location - (Optional) Id of the existing snapshot's location.

• size - (Optional) The size of the snapshot to look for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error. Additionally, you can add location and size along with the name argument for a more refined search.

Attributes Reference

The following attributes are returned by the datasource:

• id - UUID of the snapshot

• name - The name of the snapshot.

• description - Human readable description

• licence_type - OS type of this Snapshot

• location - Location of that image/snapshot

• size - The size of the image in GB

• sec_auth_protection - Boolean value representing if the snapshot requires extra protection e.g. two factor protection

• cpu_hot_plug - Is capable of CPU hot plug (no reboot required)

• cpu_hot_unplug - Is capable of CPU hot unplug (no reboot required)

• ram_hot_plug - Is capable of memory hot plug (no reboot required)

• ram_hot_unplug - Is capable of memory hot unplug (no reboot required)

• nic_hot_plug - Is capable of nic hot plug (no reboot required)

• nic_hot_unplug - Is capable of nic hot unplug (no reboot required)

• disc_virtio_hot_plug - Is capable of Virt-IO drive hot plug (no reboot required)

• disc_virtio_hot_unplug - Is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.

• disc_scsi_hot_plug - Is capable of SCSI drive hot plug (no reboot required)

• disc_scsi_hot_unplug - Is capable of SCSI drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.

The nic data source can be used to search for and return existing nics.

Example Usage

Argument reference

• datacenter_id - (Required)[string] The ID of a Virtual Data Center.

• server_id - (Required)[string] The ID of a server.

• name - (Optional)[string] The name of the LAN.

• id - (Optional) ID of the nic you want to search for.

datacenter_id and either name or id must be provided. If none, are provided, the datasource will return an error.

Import

Resource Nic can be imported using the resource id, e.g.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the NIC.

• datacenter_id - The ID of a Virtual Data Center.

• server_id - The ID of a server.

• lan - The LAN ID the NIC will sit on.

• name - The name of the LAN.

• dhcp - Indicates if the NIC should get an IP address using DHCP (true) or not (false).

• ips - Collection of IP addresses assigned to a nic. Explicitly assigned public IPs need to come from reserved IP blocks, Passing value null or empty array will assign an IP address automatically.

• firewall_active - If this resource is set to true and is nested under a server resource firewall, with open SSH port, resource must be nested under the NIC.

• mac - The MAC address of the NIC.

• nat - Boolean value indicating if the private IP address has outbound access to the public internet.

The data centers data source can be used to search for and return an existing Virtual Data Center. You can provide a string for the name and location parameters which will be compared with provisioned Virtual Data Centers. If a single match is found, it will be returned. If your search results in multiple matches, the first result found will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

Argument Reference

• id - (Optional) Id of an existing Virtual Data Center that you want to search for.

• name - (Optional) Name of an existing Virtual Data Center that you want to search for.

• location - (Optional) Id of the existing Virtual Data Center's location.

Either name, location or id must be provided. If none, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - UUID of the Virtual Data Center

• name - The name of the Virtual Data Center.

• location - The regional location where the Virtual Data Center will be created.

• description - Description for the Virtual Data Center.

• version - The version of that Data Center. Gets incremented with every change

• features - List of features supported by the location this data center is part of

• sec_auth_protection - Boolean value representing if the data center requires extra protection e.g. two factor protection

The volume data source can be used to search for and return existing volumes.

Example Usage

data "ionoscloud_volume" "volume_example" {
  name			= "my_volume@email.com"
}

Argument Reference

• name - (Optional) Name of an existing volume that you want to search for.

• id - (Optional) ID of the volume you want to search for.

Either volume or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the volume.

• name - The name of the volume.

• disk_type - The volume type: HDD or SSD.

• bus - The bus type of the volume: VIRTIO or IDE.

• size - The size of the volume in GB.

• ssh_key_path - List of paths to files containing a public SSH key that will be injected into IonosCloud provided Linux images.

• sshkey - The associated public SSH key.

• image_password - Required if sshkey_path is not provided.

• image - The image or snapshot UUID.

• image_alias - The image alias.

• licence_type

• availability_zone - The storage availability zone assigned to the volume: AUTO, ZONE_1, ZONE_2, or ZONE_3. This property is immutable.

• user_data - The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on a new volume creation. This option will work only with cloud-init compatible images.

• backup_unit_id- The uuid of the Backup Unit that user has access to. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property.

• device_number - The LUN ID of the storage volume. Null for volumes not mounted to any VM

• cpu_hot_plug - Is capable of CPU hot plug (no reboot required)

• ram_hot_plug - Is capable of memory hot plug (no reboot required)

• nic_hot_plug - Is capable of nic hot plug (no reboot required)

• nic_hot_unplug - Is capable of nic hot unplug (no reboot required)

• disc_virtio_hot_plug - Is capable of Virt-IO drive hot plug (no reboot required)

• disc_virtio_hot_unplug - Is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.

The server data source can be used to search for and return existing servers.

Example Usage

data "ionoscloud_server" "server_example" {
  name     = "My Server"
}

Argument Reference

• name - (Optional) Name of an existing server that you want to search for.

• id - (Optional) ID of the server you want to search for.

Either name or id must be provided. If none, or both are provided, the datasource will return an error.

Attributes Reference

The following attributes are returned by the datasource:

• id - The id of the server

• name - The name of the server

• datacenter_id- The ID of the Virtual Data Center

• cores - Number of server CPU cores

• cpu_family- CPU architecture on which server gets provisioned

• ram - The amount of memory for the server in MB

• availability_zone - The availability zone in which the server should exist

• vm_state - Status of the virtual Machine

• boot_cdrom

• boot_volume

• cdroms - list of

  • id - Id of the attached cdrom

  • name - The name of the attached cdrom

  • description - Description of cdrom

  • location - Location of that image/snapshot

  • size - The size of the image in GB

  • cpu_hot_plug - Is capable of CPU hot plug (no reboot required)

  • cpu_hot_unplug - Is capable of CPU hot unplug (no reboot required)

  • ram_hot_plug - Is capable of memory hot plug (no reboot required)

  • ram_hot_unplug - Is capable of memory hot unplug (no reboot required)

  • nic_hot_plug - Is capable of nic hot plug (no reboot required)

  • nic_hot_unplug - Is capable of nic hot unplug (no reboot required)

  • disc_virtio_hot_plug - Is capable of Virt-IO drive hot plug (no reboot required)

  • disc_virtio_hot_unplug - Is capable of Virt-IO drive hot unplug (no reboot required)

  • disc_scsi_hot_plug - Is capable of SCSI drive hot plug (no reboot required)

  • disc_scsi_hot_unplug - Is capable of SCSI drive hot unplug (no reboot required)

  • licence_type - OS type of this Image

  • image_type - Type of image

  • image_aliases - List of image aliases mapped for this Image

  • public - Indicates if the image is part of the public repository or not

• volumes - list of

  • id - Id of the attached volume

  • name - Name of the attached volume

  • type - Hardware type of the volume.

  • size - The size of the volume in GB

  • availability_zone - The availability zone in which the volume should exist

  • image - Image or snapshot ID to be used as template for this volume

  • image_alias - List of image aliases mapped for this Image

  • image_password - Initial password to be set for installed OS

  • ssh_keys - Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key

  • bus - The bus type of the volume

  • licence_type - OS type of this volume

  • cpu_hot_plug - Is capable of CPU hot plug (no reboot required)

  • ram_hot_plug - Is capable of memory hot plug (no reboot required)

  • nic_hot_plug - Is capable of nic hot plug (no reboot required)

  • nic_hot_unplug - Is capable of nic hot unplug (no reboot required)

  • disc_virtio_hot_plug - Is capable of Virt-IO drive hot plug (no reboot required)

  • disc_virtio_hot_unplug - Is capable of Virt-IO drive hot unplug (no reboot required)

  • device_number - The Logical Unit Number of the storage volume

• nics - list of

  • id - Id of the attached nic

  • name - Name of the attached nid

  • mac - The MAC address of the NIC

  • ips - Collection of IP addresses assigned to a nic

  • dhcp - Indicates if the nic will reserve an IP using DHCP

  • lan - The LAN ID the NIC will sit on

  • firewall_active - Activate or deactivate the firewall

  • nat - Indicates if NAT is enabled on this NIC. This is now deprecated.

  • firewall_rules - list of

    • id - Id of the firewall rule

    • name - Name of the firewall rule

    • protocol - he protocol for the rule

    • source_mac - Only traffic originating from the respective MAC address is allowed

    • source_ip - Only traffic originating from the respective IPv4 address is allowed. Value null allows all source IPs

    • target_ip - In case the target NIC has multiple IP addresses, only traffic directed to the respective IP address of the NIC is allowed

    • icmp_code - Defines the allowed code (from 0 to 254) if protocol ICMP is chosen

    • icmp_type - Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen

    • port_range_start - Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen

    • port_range_end - Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen