diff --git a/website/docs/d/client_gateway.html.markdown b/website/docs/d/client_gateway.html.markdown
index 9c677695e..dc15c4ef8 100644
--- a/website/docs/d/client_gateway.html.markdown
+++ b/website/docs/d/client_gateway.html.markdown
@@ -16,9 +16,9 @@ For more information on this resource actions, see the [API documentation](https
```hcl
data "outscale_client_gateway" "data_client_gateway01" {
-filter {
- name = "client_gateway_ids"
- values = ["cgw-12345678"]
+ filter {
+ name = "client_gateway_ids"
+ values = ["cgw-12345678"]
}
}
```
diff --git a/website/docs/d/client_gateways.html.markdown b/website/docs/d/client_gateways.html.markdown
index 6799554e9..df04e0d42 100644
--- a/website/docs/d/client_gateways.html.markdown
+++ b/website/docs/d/client_gateways.html.markdown
@@ -16,9 +16,9 @@ For more information on this resource actions, see the [API documentation](https
```hcl
data "outscale_client_gateways" "data_client_gateways01" {
-filter {
- name = "client_gateway_ids"
- values = ["cgw-12345678","cgw-87654321"]
+ filter {
+ name = "client_gateway_ids"
+ values = ["cgw-12345678","cgw-87654321"]
}
}
```
diff --git a/website/docs/r/route_table_link.html.markdown b/website/docs/r/route_table_link.html.markdown
index 45d79398c..3ae40ef44 100644
--- a/website/docs/r/route_table_link.html.markdown
+++ b/website/docs/r/route_table_link.html.markdown
@@ -54,7 +54,7 @@ The following attributes are exported:
* `link_route_table_id` - The ID of the association between the route table and the Subnet.
* `main` - If true, the route table is the main one.
* `route_table_id` - The ID of the route table.
-* `subnet_id` - The ID of the subnet.
+* `subnet_id` - The ID of the Subnet.
## Import
diff --git a/website/docs/r/snapshot.html.markdown b/website/docs/r/snapshot.html.markdown
index fca73f13d..8453d60a3 100644
--- a/website/docs/r/snapshot.html.markdown
+++ b/website/docs/r/snapshot.html.markdown
@@ -1,6 +1,6 @@
---
layout: "outscale"
-page_title: "3DS OUTSCALE: outscale_snapshot"
+page_title: "OUTSCALE: outscale_snapshot"
sidebar_current: "outscale-snapshot"
description: |-
[Manages a snapshot.]
@@ -14,28 +14,31 @@ For more information on this resource actions, see the [API documentation](https
## Example Usage
-```hcl
+### Required resource
-# Create a snapshot
+```hcl
+resource "outscale_volume" "volume01" {
+ subregion_name = "${var.region}a"
+ size = 40
+}
+```
-#resource "outscale_volume" "volume01" {
-# subregion_name = "${var.region}a"
-# size = 40
-#}
+### Create a snapshot
+```hcl
resource "outscale_snapshot" "snapshot01" {
- volume_id = outscale_volume.volume01.volume_id
+ volume_id = outscale_volume.volume01.volume_id
}
+```
-# Copy a snapshot
+### Copy a snapshot
+```hcl
resource "outscale_snapshot" "snapshot02" {
- description = "Terraform snapshot copy"
- source_snapshot_id = "snap-12345678"
- source_region_name = "eu-west-2"
+ description = "Terraform snapshot copy"
+ source_snapshot_id = "snap-12345678"
+ source_region_name = "eu-west-2"
}
-
-
```
## Argument Reference
@@ -47,28 +50,36 @@ The following arguments are supported:
* `snapshot_size` - (Optional) The size of the snapshot you want to create in your account, in bytes. This size must be greater than or equal to the size of the original, uncompressed snapshot.
* `source_region_name` - (Optional) The name of the source Region, which must be the same as the Region of your account.
* `source_snapshot_id` - (Optional) The ID of the snapshot you want to copy.
-* `tags` - One or more tags to add to this resource.
- * `key` - The key of the tag, with a minimum of 1 character.
- * `value` - The value of the tag, between 0 and 255 characters.
+* `tags` - (Optional) A tag to add to this resource. You can specify this argument several times.
+ * `key` - (Required) The key of the tag, with a minimum of 1 character.
+ * `value` - (Required) The value of the tag, between 0 and 255 characters.
* `volume_id` - (Optional) The ID of the volume you want to create a snapshot of.
## Attribute Reference
The following attributes are exported:
-* `snapshot` - Information about the snapshot.
- * `account_alias` - The account alias of the owner of the snapshot.
- * `account_id` - The account ID of the owner of the snapshot.
- * `description` - The description of the snapshot.
- * `permissions_to_create_volume` - Information about the users who have permissions for the resource.
- * `account_ids` - The account ID of one or more users who have permissions for the resource.
- * `global_permission` - If true, the resource is public. If false, the resource is private.
- * `progress` - The progress of the snapshot, as a percentage.
- * `snapshot_id` - The ID of the snapshot.
- * `state` - The state of the snapshot (`in-queue` \| `completed` \| `error`).
- * `tags` - One or more tags associated with the snapshot.
- * `key` - The key of the tag, with a minimum of 1 character.
- * `value` - The value of the tag, between 0 and 255 characters.
- * `volume_id` - The ID of the volume used to create the snapshot.
- * `volume_size` - The size of the volume used to create the snapshot, in gibibytes (GiB).
+* `account_alias` - The account alias of the owner of the snapshot.
+* `account_id` - The account ID of the owner of the snapshot.
+* `description` - The description of the snapshot.
+* `permissions_to_create_volume` - Information about the users who have permissions for the resource.
+ * `account_ids` - The account ID of one or more users who have permissions for the resource.
+ * `global_permission` - If true, the resource is public. If false, the resource is private.
+* `progress` - The progress of the snapshot, as a percentage.
+* `snapshot_id` - The ID of the snapshot.
+* `state` - The state of the snapshot (`in-queue` \| `completed` \| `error`).
+* `tags` - One or more tags associated with the snapshot.
+ * `key` - The key of the tag, with a minimum of 1 character.
+ * `value` - The value of the tag, between 0 and 255 characters.
+* `volume_id` - The ID of the volume used to create the snapshot.
+* `volume_size` - The size of the volume used to create the snapshot, in gibibytes (GiB).
+
+## Import
+
+A snapshot can be imported using its ID. For example:
+
+```console
+
+$ terraform import terraform import outscale_snapshot.ImportedSnapshot snap-12345678
+```
\ No newline at end of file
diff --git a/website/docs/r/vm.html.markdown b/website/docs/r/vm.html.markdown
index 84397ef4a..a287ddcd9 100644
--- a/website/docs/r/vm.html.markdown
+++ b/website/docs/r/vm.html.markdown
@@ -1,6 +1,6 @@
---
layout: "outscale"
-page_title: "3DS OUTSCALE: outscale_vm"
+page_title: "OUTSCALE: outscale_vm"
sidebar_current: "outscale-vm"
description: |-
[Manages a virtual machine (VM).]
@@ -14,140 +14,158 @@ For more information on this resource actions, see the [API documentation](https
## Example Usage
+### Optional resource
+
```hcl
+resource "outscale_keypair" "keypair01" {
+ keypair_name = "terraform-keypair-for-vm"
+}
+```
-# Create a VM in the Public Cloud
+### Create a VM in the public Cloud
+```hcl
resource "outscale_vm" "vm01" {
- image_id = var.image_id
- vm_type = var.vm_type
- keypair_name = var.keypair_name
- security_group_ids = [var.security_group_id]
- placement_subregion_name = "eu-west-2a"
- placement_tenancy = "default"
- tags {
- key = "name"
- value = "terraform-public-vm"
- }
- user_data = base64encode(<
-EOF
- )
+ image_id = var.image_id
+ vm_type = var.vm_type
+ keypair_name = var.keypair_name
+ security_group_ids = [var.security_group_id]
+ placement_subregion_name = "eu-west-2a"
+ placement_tenancy = "default"
+ tags {
+ key = "name"
+ value = "terraform-public-vm"
+ }
+ user_data = base64encode(<
+ EOF
+ )
}
+```
-# Create a VM with block device mappings
+### Create a VM with block device mappings
+```hcl
resource "outscale_vm" "vm02" {
- image_id = var.image_id
- vm_type = var.vm_type
- keypair_name = var.keypair_name
- block_device_mappings {
- device_name = "/dev/sdb"
- bsu {
- volume_size = 15
- volume_type = "gp2"
- snapshot_id = var.snapshot_id
- }
- }
- block_device_mappings {
- device_name = "/dev/sdc"
- bsu {
- volume_size = 22
- volume_type = "io1"
- iops = 150
- delete_on_vm_deletion = true
- }
- }
+ image_id = var.image_id
+ vm_type = var.vm_type
+ keypair_name = var.keypair_name
+ block_device_mappings {
+ device_name = "/dev/sda" # /dev/sda corresponds to the root device of the VM
+ bsu {
+ volume_size = 15
+ volume_type = "gp2"
+ snapshot_id = var.snapshot_id
+ }
+ }
+ block_device_mappings {
+ device_name = "/dev/sdb"
+ bsu {
+ volume_size = 22
+ volume_type = "io1"
+ iops = 150
+ delete_on_vm_deletion = true
+ }
+ }
}
+```
-# Create a VM in the Private Cloud
+### Create a VM in a Net with a network
+```hcl
resource "outscale_net" "net01" {
- ip_range = "10.0.0.0/16"
- tags {
- key = "name"
- value = "terraform-net-for-vm"
- }
+ ip_range = "10.0.0.0/16"
+ tags {
+ key = "name"
+ value = "terraform-net-for-vm"
+ }
}
resource "outscale_subnet" "subnet01" {
- net_id = outscale_net.net01.net_id
- ip_range = "10.0.0.0/24"
- subregion_name = "eu-west-2b"
- tags {
- key = "name"
- value = "terraform-subnet-for-vm"
- }
+ net_id = outscale_net.net01.net_id
+ ip_range = "10.0.0.0/24"
+ subregion_name = "eu-west-2b"
+ tags {
+ key = "name"
+ value = "terraform-subnet-for-vm"
+ }
}
resource "outscale_security_group" "security_01" {
- description = "Terraform security group for VM"
- security_group_name = "terraform-security-group-for-vm"
- net_id = outscale_net.net01.net_id
+ description = "Terraform security group for VM"
+ security_group_name = "terraform-security-group-for-vm"
+ net_id = outscale_net.net01.net_id
}
resource "outscale_internet_service" "internet_service01" {
}
resource "outscale_route_table" "route_table01" {
- net_id = outscale_net.net01.net_id
- tags {
- key = "name"
- value = "terraform-route-table-for-vm"
- }
+ net_id = outscale_net.net01.net_id
+ tags {
+ key = "name"
+ value = "terraform-route-table-for-vm"
+ }
}
resource "outscale_route_table_link" "route_table_link01" {
- route_table_id = outscale_route_table.route_table01.route_table_id
- subnet_id = outscale_subnet.subnet01.subnet_id
+ route_table_id = outscale_route_table.route_table01.route_table_id
+ subnet_id = outscale_subnet.subnet01.subnet_id
}
resource "outscale_internet_service_link" "internet_service_link01" {
- internet_service_id = outscale_internet_service.internet_service01.internet_service_id
- net_id = outscale_net.net01.net_id
+ internet_service_id = outscale_internet_service.internet_service01.internet_service_id
+ net_id = outscale_net.net01.net_id
}
resource "outscale_route" "route01" {
- gateway_id = outscale_internet_service.internet_service01.internet_service_id
- destination_ip_range = "0.0.0.0/0"
- route_table_id = outscale_route_table.route_table01.route_table_id
+ gateway_id = outscale_internet_service.internet_service01.internet_service_id
+ destination_ip_range = "0.0.0.0/0"
+ route_table_id = outscale_route_table.route_table01.route_table_id
}
resource "outscale_vm" "vm03" {
- image_id = var.image_id
- vm_type = var.vm_type
- keypair_name = var.keypair_name
- security_group_ids = [outscale_security_group.security_group01.security_group_id]
- subnet_id = outscale_subnet.subnet01.subnet_id
+ image_id = var.image_id
+ vm_type = var.vm_type
+ keypair_name = var.keypair_name
+ security_group_ids = [outscale_security_group.security_group01.security_group_id]
+ subnet_id = outscale_subnet.subnet01.subnet_id
}
+```
-# Create a VM with a NIC
+### Create a VM with a NIC
+```hcl
resource "outscale_net" "net02" {
- ip_range = "10.0.0.0/16"
+ ip_range = "10.0.0.0/16"
+ tags {
+ key = "name"
+ value = "terraform-net-for-vm-with-nic"
+ }
}
resource "outscale_subnet" "subnet02" {
- net_id = outscale_net.net02.net_id
- ip_range = "10.0.0.0/24"
- subregion_name = "eu-west-2a"
+ net_id = outscale_net.net02.net_id
+ ip_range = "10.0.0.0/24"
+ subregion_name = "eu-west-2a"
+ tags {
+ key = "name"
+ value = "terraform-subnet-for-vm-with-nic"
+ }
}
-
resource "outscale_nic" "nic01" {
- subnet_id = outscale_subnet.subnet02.subnet_id
+ subnet_id = outscale_subnet.subnet02.subnet_id
}
resource "outscale_vm" "vm04" {
- image_id = var.image_id
- vm_type = "c4.large"
- keypair_name = var.keypair_name
- nics {
- nic_id = outscale_nic.nic01.nic_id
- device_number = "0"
- }
+ image_id = var.image_id
+ vm_type = "c4.large"
+ keypair_name = var.keypair_name
+ nics {
+ nic_id = outscale_nic.nic01.nic_id
+ device_number = "0"
+ }
}
-
-
```
## Argument Reference
@@ -155,138 +173,133 @@ resource "outscale_vm" "vm04" {
The following arguments are supported:
* `block_device_mappings` - (Optional) One or more block device mappings.
- * `bsu` - Information about the BSU volume to create.
- * `delete_on_vm_deletion` - (Optional) By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
- * `iops` - (Optional) The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000`.
- * `snapshot_id` - (Optional) The ID of the snapshot used to create the volume.
- * `volume_size` - (Optional) The size of the volume, in gibibytes (GiB).
+ * `bsu` - Information about the BSU volume to create.
+ * `delete_on_vm_deletion` - (Optional) By default or if set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
+ * `iops` - (Optional) The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000`.
+ * `snapshot_id` - (Optional) The ID of the snapshot used to create the volume.
+ * `volume_size` - (Optional) The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
- * `volume_type` - (Optional) The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created.
+ * `volume_type` - (Optional) The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created.
For more information about volume types, see [Volume Types and IOPS](https://wiki.outscale.net/display/EN/About+Volumes#AboutVolumes-VolumeTypesVolumeTypesandIOPS).
- * `device_name` - (Optional) The name of the device.
- * `no_device` - (Optional) Removes the device which is included in the block device mapping of the OMI.
- * `virtual_device_name` - (Optional) The name of the virtual device (ephemeralN).
-* `bsu_optimized` - (Optional) If true, the VM is created with optimized BSU I/O. Updating this parameter will trigger a stop/start of the VM.
+ * `device_name` - (Optional) The name of the device.
+ * `no_device` - (Optional) Removes the device which is included in the block device mapping of the OMI.
+ * `virtual_device_name` - (Optional) The name of the virtual device (ephemeralN).
+* `bsu_optimized` - (Optional) If true, the VM is created with optimized BSU I/O. Updating this parameter will trigger a stop/start of the VM.
* `client_token` - (Optional) A unique identifier which enables you to manage the idempotency.
* `deletion_protection` - (Optional) If true, you cannot terminate the VM using Cockpit, the CLI or the API. If false, you can.
-* `get_admin_password`- (Optional) (Windows VM only) If true, waits for the administrator password of the VM to become available in order to retrieve the VM. The password is exported to the `admin_password` attribute.
+* `get_admin_password` - (Optional) (Windows VM only) If true, waits for the administrator password of the VM to become available in order to retrieve the VM. The password is exported to the `admin_password` attribute.
* `image_id` - (Required) The ID of the OMI used to create the VM. You can find the list of OMIs by calling the [ReadImages](https://docs.outscale.com/api#readimages) method.
* `keypair_name` - (Optional) The name of the keypair.
* `nics` - (Optional) One or more NICs. If you specify this parameter, you must define one NIC as the primary network interface of the VM with `0` as its device number.
- * `delete_on_vm_deletion` - (Optional) By default or if set to true, the NIC is deleted when the VM is terminated. You can specify this parameter only for a new NIC. To modify this value for an existing NIC, see [UpdateNic](https://docs.outscale.com/api#updatenic).
- * `description` - (Optional) The description of the NIC, if you are creating a NIC when creating the VM.
- * `device_number` - (Optional) The index of the VM device for the NIC attachment (between 0 and 7, both included). This parameter is required if you create a NIC when creating the VM.
- * `nic_id` - (Optional) The ID of the NIC, if you are attaching an existing NIC when creating a VM.
- * `private_ips` - (Optional) One or more private IP addresses to assign to the NIC, if you create a NIC when creating a VM. Only one private IP address can be the primary private IP address.
- * `is_primary` - (Optional) If true, the IP address is the primary private IP address of the NIC.
- * `private_ip` - (Optional) The private IP address of the NIC.
- * `secondary_private_ip_count` - (Optional) The number of secondary private IP addresses, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP address in the `private_ips` parameter.
- * `security_group_ids` - (Optional) One or more IDs of security groups for the NIC, if you acreate a NIC when creating a VM.
- * `subnet_id` - (Optional) The ID of the Subnet for the NIC, if you create a NIC when creating a VM.
-* `performance` - (Optional) The performance of the VM (`medium` \| `high` \| `highest`). Updating this parameter will trigger a stop/start of the VM.
+ * `delete_on_vm_deletion` - (Optional) By default or if set to true, the NIC is deleted when the VM is terminated. You can specify this parameter only for a new NIC. To modify this value for an existing NIC, see [UpdateNic](https://docs.outscale.com/api#updatenic).
+ * `description` - (Optional) The description of the NIC, if you are creating a NIC when creating the VM.
+ * `device_number` - (Optional) The index of the VM device for the NIC attachment (between 0 and 7, both included). This parameter is required if you create a NIC when creating the VM.
+ * `nic_id` - (Optional) The ID of the NIC, if you are attaching an existing NIC when creating a VM.
+ * `private_ips` - (Optional) One or more private IP addresses to assign to the NIC, if you create a NIC when creating a VM. Only one private IP address can be the primary private IP address.
+ * `is_primary` - (Optional) If true, the IP address is the primary private IP address of the NIC.
+ * `private_ip` - (Optional) The private IP address of the NIC.
+ * `secondary_private_ip_count` - (Optional) The number of secondary private IP addresses, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP address in the `private_ips` parameter.
+ * `security_group_ids` - (Optional) One or more IDs of security groups for the NIC, if you acreate a NIC when creating a VM.
+ * `subnet_id` - (Optional) The ID of the Subnet for the NIC, if you create a NIC when creating a VM.
+* `performance` - (Optional) The performance of the VM (`medium` | `high` | `highest`). Updating this parameter will trigger a stop/start of the VM.
* `placement_subregion_name` - (Optional) The name of the Subregion where the VM is placed.
-* `placement_tenancy` - (Optional) The tenancy of the VM (`default` | `dedicated`).
+* `placement_tenancy` - (Optional) The tenancy of the VM (`default` | `dedicated`).
* `private_ips` - (Optional) One or more private IP addresses of the VM.
* `security_group_ids` - (Optional) One or more IDs of security group for the VMs.
* `security_group_names` - (Optional) One or more names of security groups for the VMs.
+* `state` - The state of the VM (`running` | `stopped`). If set to `stopped`, the VM is stopped regardless of the value of the `vm_initiated_shutdown_behavior` argument.
* `subnet_id` - (Optional) The ID of the Subnet in which you want to create the VM.
-* `tags` - A tag to add to this resource. You can specify this argument several times.
- * `key` - The key of the tag, with a minimum of 1 character.
- * `value` - The value of the tag, between 0 and 255 characters.
-* `user_data` - (Optional) Data or script used to add a specific configuration to the VM. It must be base64-encoded, either directly or using the [base64encode](https://www.terraform.io/docs/configuration/functions/base64encode.html) Terraform function. For multiline strings, use a [heredoc syntax](https://www.terraform.io/docs/configuration/expressions.html#string-literals). Updating this parameter will trigger a stop/start of the VM.
+* `tags` - (Optional) A tag to add to this resource. You can specify this argument several times.
+ * `key` - (Required) The key of the tag, with a minimum of 1 character.
+ * `value` - (Required) The value of the tag, between 0 and 255 characters.
+* `user_data` - (Optional) Data or script used to add a specific configuration to the VM. It must be Base64-encoded, either directly or using the [base64encode](https://www.terraform.io/docs/configuration/functions/base64encode.html) Terraform function. For multiline strings, use a [heredoc syntax](https://www.terraform.io/docs/configuration/expressions.html#string-literals). Updating this parameter will trigger a stop/start of the VM.
* `vm_initiated_shutdown_behavior` - (Optional) The VM behavior when you stop it. By default or if set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is terminated.
-* `vm_type` - (Optional) The type of VM (`t2.small` by default). Updating this parameter will trigger a stop/start of the VM.
-For more information, see [Instance Types](https://wiki.outscale.net/display/EN/Instance+Types).
+* `vm_type` - (Optional) The type of VM (`t2.small` by default). Updating this parameter will trigger a stop/start of the VM.
For more information, see [Instance Types](https://wiki.outscale.net/display/EN/Instance+Types).
## Attribute Reference
The following attributes are exported:
-* `vms` - Information about one or more created VMs.
- * `admin_password` - (Windows VM only) The administrator password of the VM. This password is encrypted with the keypair you specified when launching the VM and encoded in Base64. You need to wait about 10 minutes after launching the VM to be able to retrieve this password.
- If `get_admin_password` is false or not specified, the VM resource is created without the `admin_password` attribute. Once `admin_password` is available, it will appear in the Terraform state after the next **refresh** or **apply** command.
- If `get_admin_password` is true, the VM resource itself is not considered created until the `admin_password` attribute is available.
- Note also that after the first reboot of the VM, this attribute can no longer be retrieved. For more information on how to use this password to connect to the VM, see [Accessing a Windows Instance](https://wiki.outscale.net/display/EN/Accessing+a+Windows+Instance).
- * `architecture` - The architecture of the VM (`i386` \| `x86_64`).
- * `block_device_mappings_created` - The block device mapping of the VM.
- * `bsu` - Information about the created BSU volume.
- * `delete_on_vm_deletion` - If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
- * `link_date` - The time and date of attachment of the volume to the VM.
- * `state` - The state of the volume.
- * `volume_id` - The ID of the volume.
- * `device_name` - The name of the device.
- * `bsu_optimized` - If true, the VM is optimized for BSU I/O.
- * `client_token` - The idempotency token provided when launching the VM.
- * `deletion_protection` - If true, you cannot terminate the VM using Cockpit, the CLI or the API. If false, you can.
- * `hypervisor` - The hypervisor type of the VMs (`ovm` \| `xen`).
- * `image_id` - The ID of the OMI used to create the VM.
- * `is_source_dest_checked` - (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net.
- * `keypair_name` - The name of the keypair used when launching the VM.
- * `launch_number` - The number for the VM when launching a group of several VMs (for example, 0, 1, 2, and so on).
- * `net_id` - The ID of the Net in which the VM is running.
- * `nics` - (Net only) The network interface cards (NICs) the VMs are attached to.
- * `account_id` - The account ID of the owner of the NIC.
- * `description` - The description of the NIC.
- * `is_source_dest_checked` - (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net.
- * `link_nic` - Information about the network interface card (NIC).
- * `delete_on_vm_deletion` - If true, the NIC is deleted when the VM is terminated.
- * `device_number` - The device index for the NIC attachment (between 1 and 7, both included).
- * `link_nic_id` - The ID of the NIC to attach.
- * `state` - The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
- * `link_public_ip` - Information about the EIP associated with the NIC.
- * `public_dns_name` - The name of the public DNS.
- * `public_ip` - The External IP address (EIP) associated with the NIC.
- * `public_ip_account_id` - The account ID of the owner of the EIP.
- * `mac_address` - The Media Access Control (MAC) address of the NIC.
- * `net_id` - The ID of the Net for the NIC.
- * `nic_id` - The ID of the NIC.
- * `private_dns_name` - The name of the private DNS.
- * `private_ips` - The private IP address or addresses of the NIC.
- * `is_primary` - If true, the IP address is the primary private IP address of the NIC.
- * `link_public_ip` - Information about the EIP associated with the NIC.
- * `public_dns_name` - The name of the public DNS.
- * `public_ip` - The External IP address (EIP) associated with the NIC.
- * `public_ip_account_id` - The account ID of the owner of the EIP.
- * `private_dns_name` - The name of the private DNS.
- * `private_ip` - The private IP address.
- * `security_groups` - One or more IDs of security groups for the NIC.
- * `security_group_id` - The ID of the security group.
- * `security_group_name` - The name of the security group.
- * `state` - The state of the NIC (`available` \| `attaching` \| `in-use` \| `detaching`).
- * `subnet_id` - The ID of the Subnet for the NIC.
- * `os_family` - Indicates the operating system (OS) of the VM.
- * `performance` - The performance of the VM (`medium` \| `high` \| `highest`).
- * `placement` - Information about the placement of the VM.
- * `subregion_name` - The name of the Subregion.
- * `tenancy` - The tenancy of the VM (`default` \| `dedicated`).
- * `private_dns_name` - The name of the private DNS.
- * `private_ip` - The primary private IP address of the VM.
- * `product_codes` - The product code associated with the OMI used to create the VM (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10).
- * `public_dns_name` - The name of the public DNS.
- * `public_ip` - The public IP address of the VM.
- * `reservation_id` - The reservation ID of the VM.
- * `root_device_name` - The name of the root device for the VM (for example, /dev/vda1).
- * `root_device_type` - The type of root device used by the VM (always `bsu`).
- * `security_groups` - One or more security groups associated with the VM.
- * `security_group_id` - The ID of the security group.
- * `security_group_name` - The name of the security group.
- * `state` - The state of the VM (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
- * `state_reason` - The reason explaining the current state of the VM.
- * `subnet_id` - The ID of the Subnet for the VM.
- * `tags` - One or more tags associated with the VM.
- * `key` - The key of the tag, with a minimum of 1 character.
- * `value` - The value of the tag, between 0 and 255 characters.
- * `user_data` - The Base64-encoded MIME user data.
- * `vm_id` - The ID of the VM.
- * `vm_initiated_shutdown_behavior` - The VM behavior when you stop it. By default or if set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is deleted.
- * `vm_type` - The type of VM. For more information, see [Instance Types](https://wiki.outscale.net/display/EN/Instance+Types).
+* `admin_password` - (Windows VM only) The administrator password of the VM. This password is encrypted with the keypair you specified when launching the VM and encoded in Base64. You need to wait about 10 minutes after launching the VM to be able to retrieve this password.
If `get_admin_password` is false or not specified, the VM resource is created without the `admin_password` attribute. Once `admin_password` is available, it will appear in the Terraform state after the next **refresh** or **apply** command.
If `get_admin_password` is true, the VM resource itself is not considered created until the `admin_password` attribute is available.
Note also that after the first reboot of the VM, this attribute can no longer be retrieved. For more information on how to use this password to connect to the VM, see [Accessing a Windows Instance](https://wiki.outscale.net/display/EN/Accessing+a+Windows+Instance).
+* `architecture` - The architecture of the VM (`i386` \| `x86_64`).
+* `block_device_mappings_created` - The block device mapping of the VM.
+ * `bsu` - Information about the created BSU volume.
+ * `delete_on_vm_deletion` - If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
+ * `link_date` - The time and date of attachment of the volume to the VM.
+ * `state` - The state of the volume.
+ * `volume_id` - The ID of the volume.
+ * `device_name` - The name of the device.
+* `bsu_optimized` - If true, the VM is optimized for BSU I/O.
+* `client_token` - The idempotency token provided when launching the VM.
+* `deletion_protection` - If true, you cannot terminate the VM using Cockpit, the CLI or the API. If false, you can.
+* `hypervisor` - The hypervisor type of the VMs (`ovm` \| `xen`).
+* `image_id` - The ID of the OMI used to create the VM.
+* `is_source_dest_checked` - (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net.
+* `keypair_name` - The name of the keypair used when launching the VM.
+* `launch_number` - The number for the VM when launching a group of several VMs (for example, 0, 1, 2, and so on).
+* `net_id` - The ID of the Net in which the VM is running.
+* `nics` - (Net only) The network interface cards (NICs) the VMs are attached to.
+ * `account_id` - The account ID of the owner of the NIC.
+ * `description` - The description of the NIC.
+ * `is_source_dest_checked` - (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net.
+ * `link_nic` - Information about the network interface card (NIC).
+ * `delete_on_vm_deletion` - If true, the NIC is deleted when the VM is terminated.
+ * `device_number` - The device index for the NIC attachment (between 1 and 7, both included).
+ * `link_nic_id` - The ID of the NIC to attach.
+ * `state` - The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
+ * `link_public_ip` - Information about the EIP associated with the NIC.
+ * `public_dns_name` - The name of the public DNS.
+ * `public_ip` - The External IP address (EIP) associated with the NIC.
+ * `public_ip_account_id` - The account ID of the owner of the EIP.
+ * `mac_address` - The Media Access Control (MAC) address of the NIC.
+ * `net_id` - The ID of the Net for the NIC.
+ * `nic_id` - The ID of the NIC.
+ * `private_dns_name` - The name of the private DNS.
+ * `private_ips` - The private IP address or addresses of the NIC.
+ * `is_primary` - If true, the IP address is the primary private IP address of the NIC.
+ * `link_public_ip` - Information about the EIP associated with the NIC.
+ * `public_dns_name` - The name of the public DNS.
+ * `public_ip` - The External IP address (EIP) associated with the NIC.
+ * `public_ip_account_id` - The account ID of the owner of the EIP.
+ * `private_dns_name` - The name of the private DNS.
+ * `private_ip` - The private IP address.
+ * `security_groups` - One or more IDs of security groups for the NIC.
+ * `security_group_id` - The ID of the security group.
+ * `security_group_name` - The name of the security group.
+ * `state` - The state of the NIC (`available` \| `attaching` \| `in-use` \| `detaching`).
+ * `subnet_id` - The ID of the Subnet for the NIC.
+* `os_family` - Indicates the operating system (OS) of the VM.
+* `performance` - The performance of the VM (`medium` \| `high` \| `highest`).
+* `placement_subregion_name` - The name of the Subregion where the VM is placed.
+* `placement_tenancy` - The tenancy of the VM (`default` | `dedicated`).
+* `private_dns_name` - The name of the private DNS.
+* `private_ip` - The primary private IP address of the VM.
+* `product_codes` - The product code associated with the OMI used to create the VM (`0001` Linux/Unix \| `0002` Windows \| `0004` Linux/Oracle \| `0005` Windows 10).
+* `public_dns_name` - The name of the public DNS.
+* `public_ip` - The public IP address of the VM.
+* `reservation_id` - The reservation ID of the VM.
+* `root_device_name` - The name of the root device for the VM (for example, /dev/vda1).
+* `root_device_type` - The type of root device used by the VM (always `bsu`).
+* `security_groups` - One or more security groups associated with the VM.
+ * `security_group_id` - The ID of the security group.
+ * `security_group_name` - The name of the security group.
+* `state_reason` - The reason explaining the current state of the VM.
+* `state` - The state of the VM (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
+* `subnet_id` - The ID of the Subnet for the VM.
+* `tags` - One or more tags associated with the VM.
+ * `key` - The key of the tag, with a minimum of 1 character.
+ * `value` - The value of the tag, between 0 and 255 characters.
+* `user_data` - The Base64-encoded MIME user data.
+* `vm_id` - The ID of the VM.
+* `vm_initiated_shutdown_behavior` - The VM behavior when you stop it. By default or if set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is deleted.
+* `vm_type` - The type of VM. For more information, see [Instance Types](https://wiki.outscale.net/display/EN/Instance+Types).
## Import
A VM can be imported using its ID. For example:
-```
+```console
$ terraform import outscale_vm.ImportedVm i-12345678
diff --git a/website/docs/r/volumes_link.html.markdown b/website/docs/r/volumes_link.html.markdown
index b59f490a8..a5890ee75 100644
--- a/website/docs/r/volumes_link.html.markdown
+++ b/website/docs/r/volumes_link.html.markdown
@@ -1,6 +1,6 @@
---
layout: "outscale"
-page_title: "3DS OUTSCALE: outscale_volumes_link"
+page_title: "OUTSCALE: outscale_volumes_link"
sidebar_current: "outscale-volumes-link"
description: |-
[Manages a volume link.]
@@ -10,31 +10,34 @@ description: |-
Manages a volume link.
For more information on this resource, see the [User Guide](https://wiki.outscale.net/display/EN/About+Volumes).
-For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#linkvolume).
+For more information on this resource actions, see the [API documentation](https://docs.outscale.com/api#3ds-outscale-api-volume).
## Example Usage
+### Required resources
+
```hcl
+resource "outscale_volume" "volume01" {
+ subregion_name = "${var.region}a"
+ size = 40
+}
-#resource "outscale_volume" "volume01" {
-# subregion_name = "${var.region}a"
-# size = 40
-#}
+resource "outscale_vm" "vm01" {
+ image_id = var.image_id
+ vm_type = var.vm_type
+ keypair_name = var.keypair_name
+ security_group_ids = [var.security_group_id]
+}
+```
-#resource "outscale_vm" "vm01" {
-# image_id = var.image_id
-# vm_type = var.vm_type
-# keypair_name = var.keypair_name
-# security_group_ids = [var.security_group_id]
-#}
+### Link a volume to a VM
+```hcl
resource "outscale_volumes_link" "volumes_link01" {
device_name = "/dev/xvdc"
volume_id = outscale_volume.volume01.id
vm_id = outscale_vm.vm01.id
}
-
-
```
## Argument Reference
@@ -49,18 +52,18 @@ The following arguments are supported:
The following attributes are exported:
-* `delete_on_vm_deletion` - Indicates whether the volume is deleted when terminating the instance
+* `delete_on_vm_deletion` - If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
* `device_name` - The name of the device.
-* `vm_id` - The ID of the VM you want to attach the volume to.
-* `state` - The attachment state of the volume (`attaching` | `detaching` | `attached` | `detached`).
-* `volume_id` - The ID of the volume you want to attach.
+* `state` - The state of the attachment of the volume (`attaching` | `detaching` | `attached` | `detached`).
+* `vm_id` - The ID of the VM.
+* `volume_id` - The ID of the volume.
## Import
A volume link can be imported using a volume ID. For example:
-```
+```console
-$ terraform import outscale_volumes_link.ImportedVolumeLink vol-12345678
+$ terraform import outscale_volumes_link.ImportedVolumeLink vol-12345678
```
\ No newline at end of file