github.com/vtorhonen/terraform@v0.9.0-beta2.0.20170307220345-5d894e4ffda7/website/source/docs/providers/softlayer/r/virtual_guest.html.markdown (about)

     1  ---
     2  layout: "softlayer"
     3  page_title: "SoftLayer: virtual_guest"
     4  sidebar_current: "docs-softlayer-resource-virtual-guest"
     5  description: |-
     6    Manages SoftLayer Virtual Guests.
     7  ---
     8  
     9  # softlayer\virtual_guest
    10  
    11  Provides virtual guest resource. This allows virtual guests to be created, updated
    12  and deleted. For additional details please refer to [API documentation](http://sldn.softlayer.com/reference/services/SoftLayer_Virtual_Guest).
    13  
    14  ## Example Usage
    15  
    16  Create a new virtual guest using the "Debian" image.
    17  
    18  ```hcl
    19  resource "softlayer_virtual_guest" "twc_terraform_sample" {
    20    name                     = "twc-terraform-sample-name"
    21    domain                   = "bar.example.com"
    22    image                    = "DEBIAN_7_64"
    23    region                   = "ams01"
    24    public_network_speed     = 10
    25    hourly_billing           = true
    26    private_network_only     = false
    27    cpu                      = 1
    28    ram                      = 1024
    29    disks                    = [25, 10, 20]
    30    user_data                = "{\"value\":\"newvalue\"}"
    31    dedicated_acct_host_only = true
    32    local_disk               = false
    33    frontend_vlan_id         = 1085155
    34    backend_vlan_id          = 1085157
    35  }
    36  ```
    37  
    38  Create a new virtual guest using block device template.
    39  
    40  ```hcl
    41  resource "softlayer_virtual_guest" "terraform-sample-BDTGroup" {
    42    name                            = "terraform-sample-blockDeviceTemplateGroup"
    43    domain                          = "bar.example.com"
    44    region                          = "ams01"
    45    public_network_speed            = 10
    46    hourly_billing                  = false
    47    cpu                             = 1
    48    ram                             = 1024
    49    local_disk                      = false
    50    block_device_template_group_gid = "****-****-****-****-****"
    51  }
    52  ```
    53  
    54  ## Argument Reference
    55  
    56  The following arguments are supported:
    57  
    58  * `name` | *string*
    59  	* Hostname for the computing instance.
    60  	* **Required**
    61  * `domain` | *string*
    62  	* Domain for the computing instance.
    63  	* **Required**
    64  * `cpu` | *int*
    65  	* The number of CPU cores to allocate.
    66  	* **Required**
    67  * `ram` | *int*
    68  	* The amount of memory to allocate in megabytes.
    69  	* **Required**
    70  * `region` | *string*
    71  	* Specifies which datacenter the instance is to be provisioned in.
    72  	* **Required**
    73  * `hourly_billing` | *boolean*
    74  	* Specifies the billing type for the instance. When `true`, the computing instance will be billed on hourly usage, otherwise it will be billed on a monthly basis.
    75  	* **Required**
    76  * `local_disk` | *boolean*
    77  	* Specifies the disk type for the instance. When `true`, the disks for the computing instance will be provisioned on the host which it runs, otherwise SAN disks will be provisioned.
    78  	* **Required**
    79  * `dedicated_acct_host_only` | *boolean*
    80  	* Specifies whether or not the instance must only run on hosts with instances from the same account
    81  	* *Default*: nil
    82  	* *Optional*
    83  * `image` | *string*
    84  	* An identifier for the operating system to provision the computing instance with.
    85  	* **Conditionally required**	- Disallowed when `blockDeviceTemplateGroup.globalIdentifier` is provided, as the template will specify the operating system.
    86  * `block_device_template_group_gid` | *string*
    87  	* A global identifier for the template to be used to provision the computing instance.
    88  	* **Conditionally required**	- Disallowed when `operatingSystemReferenceCode` is provided, as the template will specify the operating system.
    89  * `public_network_speed` | *int*
    90  	* Specifies the connection speed for the instance's network components.
    91  	* *Default*: 10
    92  	* *Optional*
    93  * `private_network_only` | *boolean*
    94  	* Specifies whether or not the instance only has access to the private network. When true this flag specifies that a compute instance is to only have access to the private network.
    95  	* *Default*: False
    96  	* *Optional*
    97  * `frontend_vlan_id` | *int*
    98  	* Specifies the network VLAN which is to be used for the front end interface of the computing instance.
    99  	* *Default*: nil
   100  	* *Optional*
   101  * `backend_vlan_id` | *int*
   102  	* Specifies the network VLAN which is to be used for the back end interface of the computing instance.
   103  	* *Default*: nil
   104  	* *Optional*
   105  * `disks` | *array*
   106  	* Block device and disk image settings for the computing instance
   107  	* *Optional*
   108  	* *Default*: The smallest available capacity for the primary disk will be used. If an image template is specified the disk capacity will be be provided by the template.
   109  * `user_data` | *string*
   110  	* Arbitrary data to be made available to the computing instance.
   111  	* *Default*: nil
   112  	* *Optional*
   113  * `ssh_keys` | *array*
   114  	* SSH keys to install on the computing instance upon provisioning.
   115  	* *Default*: nil
   116  	* *Optional*
   117  * `ipv4_address` | *string*
   118  	* Uses `editObject` call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
   119  	* *Default*: nil
   120  	* *Optional*
   121  * `ipv4_address_private` | *string*
   122  	* Uses `editObject` call, template data [defined here](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest).
   123  	* *Default*: nil
   124  	* *Optional*
   125  * `post_install_script_uri` | *string*
   126  	* As defined in the [SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions](https://sldn.softlayer.com/reference/datatypes/SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions).
   127  	* *Default*: nil
   128  	* *Optional*
   129  
   130  ## Attributes Reference
   131  
   132  The following attributes are exported:
   133  
   134  * `id` - The ID of the virtual guest.
   135